List shipments

get

https://api.smoothpos.net/shipments.json

Returns your shipments, oldest first, with their type (e.g. sea) and expected and actual arrival dates. actual_arrival_date is 0001-01-01T00:00:00Z until the shipment arrives.

Results are paged (50 per page by default, up to 250 with limit). If there's another page, you'll get an X-Next-Page header. Request that path to continue.

See Filtering, sorting and search for how the filters, ranges and sort work.

Required permission (any one of these):

Group	Permission
Purchasing	List and view inbound stock shipments
Purchasing	Create, edit and delete inbound stock shipments (includes view)

Query Params

limit

integer

1 to 250

Defaults to 50

How many results per page. Defaults to 50, maximum 250.

cursor

string

Paging cursor. Don't build it yourself; take the whole path from the X-Next-Page header.

name

string

Partial match on name.

ids

string

^\d+(,\d+)*$

Matches one ids or a comma-separated list (up to 200).

type

string

Exact match on the shipment type. It's free text; the app offers sea, air and other. Send one value or a comma-separated list.

expected_arrival_from

string

From this expected arrival. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

expected_arrival_to

string

Up to this expected arrival. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

actual_arrival_from

string

From this actual arrival. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

actual_arrival_to

string

Up to this actual arrival. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_from

string

From this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_to

string

Up to this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_from

string

From this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_to

string

Up to this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, name, expected_delivery_date, actual_delivery_date, expected_arrival_date, actual_arrival_date, created, updated. The older sort_field=key&sort=asc|desc style still works.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success.

400A filter value isn't valid. The message names the parameter, for example: expected_arrival_from must be a date (YYYY-MM-DD) or RFC3339 timestamp cannot sort by "<key>" Text filters over 200 characters return <param> value is too long (max 200 characters).

404Not found, or your X-Smoothpos-Auth token is missing or invalid. (Smooth POS uses 404 for auth failures too.) Possible error messages: not authorised