post https://example.com/programs//order
This API is used to get inventory order information from partners.
Http Status Code
| Name | Comment |
|---|---|
| 200 | success |
| 400 | bad request, like unsupported operation |
| 401 | Unauthorized |
Inventory Management
| Group | Property | Required | Constraint/Scenario | HttpStatus | Code | Sub Code | Description |
|---|---|---|---|---|---|---|---|
| clientReferenceNumber | Y | >= 2 characters and <= 40 characters | 400 | 400 | Required: 6021,Invalid: 6022 | Unique string sent by partner to identify the request | |
| Y | if provided valid email with max 255 char | 400 | 400 | 6003 | |||
| phone | Y | if provided, 10 digits | 400 | 1040 | 6004 | ||
| company | N | If provided, >= 2 characters and <= 40 characters | 400 | 400 | 6030 | ||
| companyId | N | Is Required if company is provided, >= 2 characters and <= 40 characters | 400 | 400 | 6031 | ||
| deliveryType | Y | 400 | 600 | Required: 6001,Invalid: 6002 | Options: Reg, Onn, Pse, Rush | ||
| lines | lineType | Y | Must be "Plastic" | 400 | 600 | Required: 6041,Invalid: 6042 | Options: Plastic, Blank |
| productCode | Y | Must be Ceridian GPR product code | 400 | 1000 | Required: 6051, Invalid: 6052 | Invalid product code for program | |
| inventoryCode | Y | >=2 and <=40 | 400 | 6000 | Required: 6061,Invalid: 6062 | ||
| quantity | Y | >=10 and <=10000 | 400 | 400 | Required: 6081, Invalid: 6082 | ||
| deliveryAddress | contactName | Y | >= 2 characters and <=35 characters | 400 | 400 | Required: 6101,Invalid: 6102 | Contact receiving the shipment |
| addressLine1 | Y | >= 2 characters and <= 30 characters | 400 | 400 | Required: 6111,Invalid: 6112 | ||
| addressLine2 | N | <= 30 characters | 400 | 400 | 6121 | ||
| city | Y | <= 25 characters | 400 | 400 | Required: 6131, Invalid: 6132 | ||
| state | Y | Must be two characters | 400 | 400 | Required: 6141, Invalid: 6142 | ||
| postalCode | Y | Must be 5 digits only | 400 | 400 | Required: 6151, Invalid: 6152 | ||
| country | Y | Must be 3 characters | 400 | 600 | Required: 6161, Invalid: 6162 | must be USA | |
| residential | Y | Must be 1 character | 400 | 600 | Required: 6171, Invalid: 6172 | Must be Y or N |