Skip to main content
GET
Inbound shipments

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page
integer
default:1

Page number for pagination

per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
updated_at
string<date-time>

Filter by last update date (YYYY-MM-DD HH:mm:ss)

created_at
string<date-time>

Filter by creation date (YYYY-MM-DD HH:mm:ss)

arrival_date
string<date-time>

Filter by arrival date

external_status
string

Filter by normalized external status

external_shipment_id
string

Filter by external shipment ID

purchase_order_id
integer

Filter by linked purchase order ID

source
string

Filter by integration source

location_id
integer

Filter by destination location ID

reconciled_at
string<date-time>

Filter by when the shipment was reconciled (YYYY-MM-DD HH:mm:ss)

external_expected_arrival_date
string<date-time>

Filter by arrival date from the external system (YYYY-MM-DD HH:mm:ss)

external_date_created
string<date-time>

Filter by creation date from the external system (YYYY-MM-DD HH:mm:ss)

external_date_updated
string<date-time>

Filter by update date from the external system (YYYY-MM-DD HH:mm:ss)

id
integer

Filter by inbound shipment ID

from_warehouse_id
integer

Filter by origin warehouse ID

purchase_order_shipment_id
integer

Filter by linked PO shipment ID

transfer_order_id
integer

Filter by linked transfer order ID

app_integration_account_id
integer

Filter by integration account ID

external_po_number
string

Filter by PO number from the external system

external_po_number_canonical
string

Filter by canonical PO number from the external system

external_warehouse_id
string

Filter by warehouse ID in the external system

external_warehouse_customer_id
string

Filter by customer ID in the external warehouse system

external_supplier_name
string

Filter by supplier name from the external system

external_raw_status
string

Filter by raw status string from the external system

total_expected_quantity
number

Filter by total expected item quantity

total_received_quantity
number

Filter by total received item quantity

total_unit_cost
number

Filter by total unit cost

Response

Successful response

data
object[]
meta
object