v1.1 List Shipments

get

https://api.cratejoy.com/v1.1/shipments/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Additional Resources

Descriptions for each potential field Read more here on what data can be returned via this endpoint.
Available filters - Read more here on available filters for the v1.1 shipment endpoint.

Query Params

status

string

Optional. The shipment's status, one of unshipped, shipped, or cancelled

billing_type

string

Optional. One of ecom, standard, or adhoc

sub_cycle

int32

Optional. Filter on the shipment's sequence in a subscription. E.g. a customer's first shipment in a subscription is sub_cycle=1, then 2, etc.

cust_cycle

int32

Optional. Filter on the shipment's sequence across all a customer's shipments. E.g. a customer's first shipment ever is cust_cycle=1, then 2, etc.

batch_id

int32

Optional. Filter on what batch a shipment belongs to

adjusted_ordered_at

date

Optional. The order date for the shipment, which can help determine its target ship date.

customer_id

int32

Optional. The id of the customer who purchased the product.

limit

int32

Defaults to 10

Optional. Max of 200. If not specified, default of 10.

page

string

Optional.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

Additional Resources

200200

400400