Ship

Returns all Shipment Confirmations that have not yet been sent

Returns all Shipment Confirmations that have not yet been sent if no search queries are present. Marks them as 'sent'

get/request/Ship

Request

  • Base URL: https://api.idsfulfillment.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.idsfulfillment.com/request/Ship
  • Auth: none declared. Required headers: ApiKey

Query parameters

min_ShipDatestring date-time

IDS WMS Local (MT) Date - Truncated to day precision. Default: Last 30 Days.

max_ShipDatestring date-time

IDS WMS Local (MT) Date - Truncated to day precision. Requires min_ShipDate.

OrderStatusesstring[]

This filter is only applied if CustomerOrderReferenceNumbers also has value(s)

A comma separated list of order statuses to filter by. Defaults to ['SH']

Valid Options:

<dl><dt>SH</dt><dd>Shipped</dd><dt>ZS</dt><dd>Zero Shipped</dd><dt>CA</dt><dd>Cancelled</dd></dl>
IncludeOrphansboolean

Flag to include shipments for orders not created by the API. Default: true

CustomerOrderReferenceNumbersstring[]

A comma separated list of reference numbers to search for

DefaultLimitinteger
MaxLimitinteger
Pageinteger
Limitinteger

The number of records to retrieve. Default: 100. Max: 1000.

Offsetinteger

Headers

IDS API Key

Response

Ok

Changes

No recorded changes to this operation across all 1 revision of this API.