API Shipping Orders | Inventory Pro

Shipping Orders

The Shipping Orders endpoint manages outbound shipments — listing orders, retrieving details, and creating new shipping orders.

The Shipping Order Object

Shipping orders are returned as the raw Order entity. Common fields:

{
  "rec": "SO-2025-0015",
  "created": "2025-05-20T00:00:00Z",
  "modified": "2025-05-21T09:00:00Z",
  "associate": 8,
  "shipTo": 8,
  "billTo": 8,
  "po": "CUST-PO-100",
  "shipVia": 2,
  "canceled": 0,
  "complete": 0,
  "isShipped": 0,
  "isPacked": 0,
  "shipped": null,
  "delivery": "2025-06-05T00:00:00Z",
  "orderLines": [],
  "orderTotals": []
}

Fields

Field	Type	Description
`rec`	string	Shipping order number
`created`	datetime	Date the SO was created
`modified`	datetime	Last modification timestamp
`associate`	integer	Associated customer record ID
`shipTo`	integer	Ship-to customer ID
`billTo`	integer	Bill-to customer ID
`po`	string	Customer PO reference
`shipVia`	integer	Ship-via code
`canceled`	integer	`1` when canceled
`complete`	integer	`1` when complete
`isShipped`	integer	`1` when shipped
`isPacked`	integer	`1` when packed
`shipped`	datetime or null	Date shipped
`delivery`	datetime or null	Delivery date
`orderLines`	array	Line items (detail response only)
`orderTotals`	array	Order totals (detail response only)

List Shipping Orders

GET /ShippingOrder

Returns shipping orders. Maximum page size is 50.

Parameters

Field	Type	Required	Description
`page`	integer	No	Page number (default 1)
`pageSize`	integer	No	Results per page (max 50)
`sort`	string	No	Field to sort by
`direction`	string	No	`asc` or `desc`
`startDate`	datetime	No	Filter by order date on or after
`endDate`	datetime	No	Filter by order date on or before

Response

{
  "value": [
    {
      "rec": "SO-2025-0015",
      "created": "2025-05-20T00:00:00Z",
      "modified": "2025-05-21T09:00:00Z",
      "associate": 8,
      "shipTo": 8,
      "billTo": 8,
      "canceled": 0,
      "complete": 0,
      "isShipped": 0,
      "delivery": "2025-06-05T00:00:00Z"
    }
  ],
  "totalCount": 37,
  "page": 1,
  "pageSize": 25,
  "pageCount": 2,
  "hasMore": true
}

Get a Shipping Order

GET /ShippingOrder/{id}

Returns the full SO with header, line items, and totals. The id is the SO record number (rec).

Response

{
  "rec": "SO-2025-0015",
  "created": "2025-05-20T00:00:00Z",
  "modified": "2025-05-21T09:00:00Z",
  "associate": 8,
  "shipTo": 8,
  "billTo": 8,
  "po": "CUST-PO-100",
  "shipVia": 2,
  "canceled": 0,
  "complete": 0,
  "shipped": null,
  "delivery": "2025-06-05T00:00:00Z",
  "orderLines": [],
  "orderTotals": []
}

Create a Shipping Order

POST /ShippingOrder

Creates a new shipping order via the system import procedure. At least one line is required.

Request Body

{
  "Order": "SO-2025-0016",
  "WarehouseID": 1,
  "BillTo": "ACME-CORP",
  "ShipTo": "ACME-CORP",
  "Lines": [
    {
      "UPC": "BOLT-M8-30",
      "Location": "A1-01",
      "Description": "M8 x 30mm Hex Bolt",
      "Qty": 200
    }
  ]
}

Parameters

Field	Type	Required	Description
`Order`	string	No	SO number (must be unique). If omitted, the system assigns one
`WarehouseID`	integer	Yes	Warehouse ID (must be enabled for ship-from)
`BillTo`	string	No	Bill-to customer shortID
`ShipTo`	string	No	Ship-to customer shortID
`Lines`	array	Yes	One or more line items
`Lines[].UPC`	string	Yes	Part shortID (must be a valid sellable part)
`Lines[].Location`	string	No	Bin/location
`Lines[].Description`	string	No	Line description
`Lines[].Qty`	decimal	Yes	Quantity to ship

Response

{
  "order": "SO-2025-0016",
  "status": "created"
}

Permissions

Action	Required Permission
List / Get SOs	All Shipping Orders (SecurityID 120)
Create	Create/Modify SO (SecurityID 125)