List Delivery

get

https://api.burqup.com/v1/deliveries

Returns a paginated list of all deliveries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

starting_after

string

Cursor (object ID) used to retrieve records created before it.

ending_before

string

Cursor (object ID) used to retrieve records created after it.

limit

integer

Number of records per page.

external_order_ref

string

Merchant-provided delivery identifier. When provided, only deliveries with matching value will be returned

status

string

enum

Query by delivery status.

  * One of the delivery statuses, as listed in the response Delivery resource `status` field.

  * `all_in_progress_statuses` - returns deliveries in non-terminal statuses (neither errored, failed, nor completed).

Headers

x-api-key

string

required

Burq API key for your account.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The request was successful.

400Errors under status code 400. See error examples under the "Response" tab on right. Note examples are for reference only. Field values are neither exhaustive nor api-version-controlled.