List fulfillments or shipments from vendors

Gets a list of fulfillments or shipments that contain details about the variants included in the shipment along with the tracking number. Generally, the is_acknowledged=0 is passed as a query to return only new shipments not yet processed by the retailer.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retailer_pk

number

required

Retailer ID

Query Parameters

status

string

Shipment status

is_acknowledged

number

1: shipment is picked up <br /> 0: shipment is not picked up

search

string

Search by tracking or purchase order number

order_id

number[]

Order IDs. Multiple values may be separated by commas.

since

number

Past date till current (Unix epoch format)

connection_id

number[]

Connection ID. Multiple values may be separated by commas.

order_by

string

Sorting preference

page

integer

Page number within the paginated result set

limit

integer

Number of records per page

Response

200 - application/json

count

integer

required

Total number of records

results

object[]

required

Show child attributes

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)