Versions Compared

Old Version 1

changes.mady.by.user Rahul Mehta

Saved on

compared with

New Version 2

changes.mady.by.user Rahul Mehta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.12.0

The Shipments Query REST API is used to query the list of currently defined shipments in the system.

Note

The result set is filtered based on the authorization level of the user executing the query.

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel4

Related pages:

Resource URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

GET /seiapi/v3/query/Shipments/?filters=${filterOptions}&q={queryOtions}&sort=${sortOptions}&limit=${limit}

Include Page
_URI Ext Default Query Parameters
_URI Ext Default Query Parameters

Filters

The ${filterOptions} parameter supports the following REST Object Definitions Inventory Related Objects Storage Location Inventory Load Object fields:

  • ExpectedDelivery
  • LoadNum
  • Status
  • StorageLocationID

Q

The ${queryOptions} supports the following REST Object Definitions Inventory Related Objects Storage Location Inventory Load Object fields:

  • ExpectedDelivery
  • LoadNum
  • Status
  • StorageLocationID

Sort

The ${sortOptions} supports the following REST Object Definitions Inventory Related Objects Storage Location Inventory Load Object fields:

  • ExpectedDelivery
  • LoadNum
  • Status
  • StorageLocationID

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Response Body

The response body contains a collection of REST Object Definitions Inventory Related Objects Storage Location Inventory Load Object that match the query parameters. 

Include Page
Query Response Object
Query Response Object