Skip to main content
GET
Delivery

Authorizations

Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

id
string
required
Required string length: 20 - 37
Examples:

"dlv_1C454ZXA61S03Z9T"

"dlv_1FAGG2H2PSBXHGYY"

Response

Successful Response

credit_batch_size_total
CreditQuantity · object
required
delivered_at
string<date-time>
required
from_supplier
Supplier · object
required
id
string
required
Required string length: 20 - 37
Examples:

"dlv_1C454ZXA61S03Z9T"

"dlv_1FAGG2H2PSBXHGYY"

notes
string | null
required

A publicly visible note stored with the credit delivery.

Maximum string length: 256
Example:

"Delivered with care."

order_id
string
required
Required string length: 20 - 37
Examples:

"ord_1FAN3S3WV1S0B842"

"ord_1DBVRQDHBSBXWBWP"

to_organisation
Organisation · object
required
url
string
required