List fulfillments

get

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

Returns your fulfillments, oldest first. Each one shows its type (e.g. Warehouse To Customer) and status (e.g. Closed).

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
Fulfilment & Shipping	List and view fulfilments
Fulfilment & Shipping	Generate picks and ship fulfilments (includes view)
Fulfilment & Shipping	Create, edit, pick, ship and return fulfilments

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.

ids

string

Comma-separated list matched against id.

since_id

integer

Greater than (not including) the id.

sale_ids

string

Comma-separated list matched against sale_id.

reference

string

Partial match on reference.

source_warehouse

string

Exact match on source_warehouse_id.

source_warehouse_ids

string

Comma-separated list matched against source_warehouse_id.

updated_min

date-time

Greater than (not including) the updated.

updated_max

date-time

Less than (not including) the updated.

created_min

date-time

Greater than (not including) the created.

created_max

date-time

Less than (not including) the created.

sale_id

string

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

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

source_warehouse_id

string

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

Matches one source warehouse id or a comma-separated list (up to 200).

destination_warehouse_id

string

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

Matches one destination warehouse id or a comma-separated list (up to 200).

carrier_id

string

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

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

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.

string

Text search: matches records where any of reference contains this text (up to 200 characters).

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, 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.

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