v1

latestOpenAPI 3.0.3Apache 2.02026-07-2478177179.1 KB

Get delivery jobs list

This endpoint is used to retrieve detailed information about delivery jobs. You can track delivery performance, filter delivery data and handle large datasets efficiently.

get/{aplicationId}/delivery-jobs

Path parameters

aplicationIdstring required

The unique identifier of the Delivery Manager application that is making the request.

Query parameters

fromDatestring

The start date and time for the search range in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Used to filter delivery jobs created or updated after this date.

toDatestring

The end date and time for the search range in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Used to filter delivery jobs created or updated before this date.

storeIdstring

The unique identifier of the store. Filters delivery jobs associated with a specific store.

statusstring

The status of the delivery jobs to filter. Possible values might include statuses like pending, dispatched, delivered, canceled, etc.

page_nointeger

The page number for pagination. Used to specify which page of the delivery jobs list to retrieve when there are multiple pages of results.

sizeinteger

The number of delivery jobs to include in each page of results. Controls the size of the paginated response. - The maximum size parameter value is 10,000. If the dataset exceeds this limit, use the next page to fetch additional records.

Response

List of delivery jobs