Inventory Fetch

This method is used to retrieve inventory levels from the order source.

Request
Request Body schema: application/json
transaction_id
required
string <guid>

A randomly generated transaction ID, used to correlate the request and response

required
object

The authorization information necessary to fulfill this request.

cursor
string

The cursor to use for the next page of inventory (if provided by your previous response).

object

Criteria to filter the inventory items by

Responses
200

OK

400

A response to indicate that there was either a module level client error or an external client error.

401

A response to indicate that the request failed to authenticate with the shipping provider.

429

A response indicates that the shipping service provider has denied a request due to too many requests.

500

A response indicating a server level error with the module.

520

A response indicating a server level error with the external world.

post/inventory_fetch
Request samples
application/json
{
  • "transaction_id": "string",
  • "auth": {
    },
  • "cursor": "string",
  • "criteria": {
    }
}
Response samples
application/json
{
  • "message": "string",
  • "errors": [
    ],
  • "items": [
    ]
}