HTTP REQUEST
Note: The endpoint can be called by either a GET or POST request.
The following parameters are passed as a json string as part of the authentication request:
| Field | Description | Example | Required |
|---|---|---|---|
| DOCUMENTNO | Document\Waybill\Delivery Number | 2197127565 | Mandatory |
| PRODUCTCODE | Product code for item | G10691854DJ | Mandatory |
| DESCRIPTION | Product Descritpion for Item | 205/45R17 88W FM800 XL MFS | Mandatory |
| ITEMS | Quantity of product type | 2 | Mandatory |
| LENGTH | Length of item | ||
| WIDTH | Width of item | ||
| HEIGHT | Height of item | ||
| WEIGHT | Weight of item | ||
| TOTALPCS | Total Items for Order | 59 | Mandatory |
| REFNO | Reference | ||
| GROUPNAME | Group name supplies for API | Mandatory |
HTTP RESPONSE
The possible responses from calling this endpoint are as follows:
| Response | Description |
|---|---|
| Success | returns a json ResultSet including the SuccessMessage: OK - Parcels has been created successfully! |
| Failure | this is a data error, it returns a json ResultSet including the appropriate ErrorMessage such as missing parameters, or wrong format |
| Error | this is a server error, an appropriate ErrorMessage is returned from the server |