Documentation for Shipments API
| Authentication | |
| Data Schema | Shipments |
| Swagger |
Endpoints
GET - /v1/shipments
Retrieve a list of shipments.
Parameters
SalesOrderNumber(string, optional): Sales order number filter.PageNumber(integer, required): Page number for pagination.PageSize(integer, required): Records per page.
GET - /v1/shipments/{id}
Retrieve the details of a specific shipment by ID.
Parameters
id(integer, required): Unique shipment ID.
DELETE - /v1/shipments/{id}
Delete a specific shipment by ID.
Parameters
id(integer, required): Unique shipment ID.
POST - /v1/shipments/upload
Create new shipment(s) via file upload.
Parameters
ContentType(string, required): File content type.ContentDisposition(string, required): File disposition type.Headers(file, required): Header information.Length(integer, required): File length.Name(string, required): File name.UploadedFile(string, required): The uploaded file.
GET - /v1/returntovendor
Retrieve a list of return-to-vendor records.
Parameters
PageNumber(integer, required): Page number for pagination.PageSize(integer, required): Records per page.
GET - /v1/returntovendor/{id}
Retrieve the details of a specific return by ID.
Parameters
id(integer, required): Unique return-to-vendor record ID.
POST - /v1/returntovendor/authorise/{id}
Authorize a specific return-to-vendor by its ID.
Parameters
id(integer, required): Unique return ID.
POST - /v1//returntovendor/ship/{id}
Ship a return-to-vendor by its ID.
Parameters
id(integer, required): Unique return ID.request(object, required): Shipment details.trackingNumber(string, required): Tracking number of the shipment.courierCompanyName(string, required): Courier company of the shipment.returnShipDate(string, required): Date the return shipment was sent.debitNoteNumber(string, optional): Debit note number for the return.
POST - /v1/returntovendor/receive/{id}
Receive a return-to-vendor by its ID.
Parameters
id(integer, required): Unique return ID.