API Reference

List shipment lines

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

Returns the lines across your shipments, in line ID order, 50 at a time by default. Page through them with the X-Next-Page header.

Required permission (any one of these):

GroupPermission
PurchasingList and view inbound stock shipments
PurchasingCreate, edit and delete inbound stock shipments (includes view)
Query Params
integer
1 to 250
Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

string

Exact match on shipment_id.

string

Comma-separated list matched against shipment_id.

string

Exact match on purchase_order_id.

string
enum

Only lines on shipments with this status: open, shipped, arrived or canceled.

Allowed:
string

Only lines on shipments with any of these statuses. A comma-separated list of open, shipped, arrived and canceled.

Responses

Updated 8 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago

Did this page help you?