Available filters for the v1.1/shipments/ endpoint
| Parameter | Valid Filters | Use Case |
|---|---|---|
page. | = | Used for paginating through results, frequently with limit,e.g. ?limit=100&page=2 |
limit | = | Used for limiting the number of responses. Max of 200. If not included, the default response will be ?limit=10. |
status | = or __in | Returns shipments in a given status (?status=unshipped) or statuses (?status__in=["unshipped","cancelled"]) |
adjusted_ordered_at | = and comparisons (__gt, __ge, __lt, __le) | Return shipments with adjusted_ordered_at date that are equal to, greater than, greater than or equal to, less than, or less than or equal to a given date. Read more about adjusted_ordered_at here. |
sub_cycle | ≈ | Return shipments based on what sequence number it is in a subscription. E.g. sub_cycle=2 indicates it is the second shipment in a subscription. |
customer_id | = or __in | Return all shipments associated with a given customer (?customer_id=123) or list of customers (?customer_id__in=123,456) |
batch_id | = or __in | Returns all shipments in a given shipping batch (?batch_id=123) or batches (?batch_id__in=123,456) |
billing_type | = or __in | Returns all shipments that match a given billing type (?billing_type=ecom) or types (?billing_type__in=["adhoc","standard"]). Read more on billing types (ecom, adhoc, or standard) here. |
cust_cycle | Return shipments based on what sequence number it is in a subscription. E.g. cust_cycle=2 indicates it is the second shipment in a subscription. | Return shipments based on what sequence number it is for the customer across all their orders and subscriptions. E.g. cust_cycle=2 indicates it is their second shipment ever. |