`GET` /order.shipment.list.json

Summary: —
Operation ID: OrderShipmentList
Auth: unknown

Description

Get list of shipments by orders.

Parameters (12)

count (integer, query, optional, default: 10)

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

created_from (string, query, optional)

Retrieve entities from their creation date

created_to (string, query, optional)

Retrieve entities to their creation date

exclude (string, query, optional)

Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all

modified_from (string, query, optional)

Retrieve entities from their modification date

modified_to (string, query, optional)

Retrieve entities to their modification date

order_id (string, query, required)

Retrieves shipments specified by order id

page_cursor (string, query, optional)

Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)

params (string, query, optional, default: id,order_id,items,tracking_numbers)

Set this parameter in order to choose which entity fields you want to retrieve

response_fields (string, query, optional)

Set this parameter in order to choose which entity fields you want to retrieve

start (integer, query, optional, default: 0)

This parameter sets the number from which you want to get entities

store_id (string, query, optional)

Store Id

No probe data for this endpoint yet.