Skip to main content

Delivery

This operation searches for deliveries by various query parameters and fetches a list of deliveries. The current version only supports delivery creation date, so you can limit the delivery set to a certain period. For example, you can limit the response to the last two days (/Delivery? CreationDateFrom = 2018-01-09 and CreationDateTo = 2018-01-11). In addition, this method supports pagination controls (limit and offset fields) that allow you to control the page size of returned orders. Note that if you don't define a pagination control, a default value will be assumed.

endpoint:

GET /delivery

Retrieving delivery by ID​

This operation retrieves the details of a single delivery. The unique identifier (delivery.id) is passed at the end of the call URI. For example, if you want details about your PLXYZ00000001 delivery, you need to call the request as /delivery/PLXYZ00000001. In response, you will receive a delivery collection containing all product lines in the delivery.

endpoint:

GET /delivery/ID

Delivery Metadata - search for a delivery without details​

This operation searches for deliveries by various query parameters and retrieves a list of deliveries in a time window of up to 7 days in any period in the past. For example, you can limit the response to a selected two days (/delivery/metadata?creationDateFrom=2021-02-01&creationDateTo=2021-02-02). Additionally, this method supports pagination controls (limits and offsets fields) that allow you to control the page size of returned orders. Note that if you do not define a pagination control, the default value will be assumed.

The operation differs from /delivery in that the response does not include details about the delivery item.

Endpoint:

GET /delivery/metadata