get https://api.wuxus.com/public/orders/batch/status/
This is the recommended version of the Batch Upload API.
Automate your order upload validation
It is highly recommended to create automated validation on your order upload flow. This API can help you with that.
Based on our experiences, we recommend you set up validation on at least these two 'layers':
- Internal validation that the orders your system expects to be sent, have actually been sent to Dropboy.
- Use our API to validate that the orders were successfully uploaded into Dropboy and handle any potential errors.
| Key | Description |
|---|---|
| status | The status of the upload |
| progress | Progress of the upload in percent |
| done | How many of the orders that's done processing. Only orders without errors will count |
| failed | How many of the orders that have failed the processing |
| createdOrderIds | The list of order ids that have been created |
| errors | An array that contains information of why the failed orders failed. Can be used to correct the errors. |
status
This is a list of all the different statuses the batch upload can have
| status | Description |
|---|---|
| completed | The file processing is done. Check createdOrderIds to get the list of created order ids |
| processing | The file is being processed |
| failed | The file cannot be used. This is either due to the file being empty or that it does not follow the format |
Both
completedandprocessingcan contain errors. These errors can be corrected and be uploaded with a new file.
errors
errors is an array containing object of information on what went wrong. An object in errors could look like this:
{
"index" : 0,
"path" : [
"",
"origin",
"phone",
"number"
],
"message" : "should be number,null"
}
A more detailed description of the keys in the object:
| Key | Description |
|---|---|
| index | Describes the index of the failed order within the orders array. It starts from 0 |
| path | The path in the order object where the error is detected. In the example it's the origins phone number. |
| message | Describes what was wrong. In the example the message is that the origins phone number should be a number |