Get All Orders
Changed onReturns all Orders for the WMS connection associated with the provided access token.
Request
- Base URLhttps://production.trackstarhq.com
- URLhttps://production.trackstarhq.com/wms/orders
- Authnone required
Query parameters
The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
The maximum number of items to return. The default is 1000.
{
"in": [
"_in"
]
}Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of gte/lte than it is to use gt/lt.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status, order_number, reference_id) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"contains": [
"contains"
],
"not_contains": [
"not_contains"
]
}The status of the order. See the order information for more details.
{
"eq": "open",
"neq": "backordered",
"in": [
"backordered"
],
"nin": [
"backordered"
],
"contains": "contains",
"not_contains": "not_contains"
}The ID of the customer associated with the resource This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status, order_number, reference_id) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"eq": "warehouse_cust_id",
"neq": "neq",
"in": [
"_in"
],
"nin": [
"nin"
],
"contains": "contains",
"not_contains": "not_contains"
}The type of order: d2c, b2b, dropship, or transfer. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status, order_number, reference_id) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"eq": "d2c",
"neq": "b2b",
"in": [
"b2b"
],
"nin": [
"b2b"
]
}A user-friendly identifier for the order.
{
"eq": "order_num",
"neq": "neq",
"in": [
"_in"
],
"nin": [
"nin"
],
"contains": "contains",
"not_contains": "not_contains"
}An external unique identifier for the order.
{
"eq": "ref_id",
"neq": "neq",
"in": [
"_in"
],
"nin": [
"nin"
],
"contains": "contains",
"not_contains": "not_contains"
}The date the order must be shipped by. Same syntax as created_date/updated_date. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status, order_number, reference_id) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"eq": "2021-01-01T12:00:00Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Filter orders by their tags This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status, order_number, reference_id) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"contains": [
"contains"
],
"not_contains": [
"not_contains"
]
}Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Response
Successful response
Example response
{
"data": [
{
"id": "order_id",
"warehouse_customer_id": "warehouse_customer_id",
"warehouse_id": "warehouse_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"reference_id": "order_reference_id",
"order_number": "order_number",
"status": "open",
"raw_status": "raw_status",
"channel_object": {
"channel_id": "channel_id",
"channel_name": "channel_name"
},
"type": "d2c",
"trading_partner": "Target",
"service_level": "Standard",
"shipping_method_id": "fedex_ground",
"shipping_method_name": "FedEx Ground",
"carrier_id": "fedex",
"carrier_name": "FedEx",
"scac": "scac",
"third_party_freight_account_number": "123456",
"first_party_freight_account_number": "123456",
"invoice_currency_code": "USD",
"total_price": 13.49,
"total_tax": 1.5,
"total_discount": 2.5,
"total_shipping": 3.5,
"ship_to_address": {
"full_name": "John Doe",
"company": "Company",
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States",
"phone_number": "123-456-7890",
"email_address": "johndoe@example.com"
},
"line_items": [
{
"product_id": "product_id",
"sku": "sku",
"quantity": 1,
"unit_price": 10.99,
"discount_amount": 1.5
}
],
"tags": [
"tag_0"
],
"required_ship_date": "2021-01-01T12:00:00Z",
"international_duty_paid_by": "sender",
"shipments": [
{
"shipment_id": "shipment_id",
"warehouse_id": "wh_id",
"shipped_date": "2022-05-06T01:02:03Z",
"raw_status": "raw_status",
"status": "shipped",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"parent_product_id": null
}
],
"ship_to_address": {
"full_name": "John Doe",
"company": "company",
"address1": "address1",
"address2": "address2",
"address3": "address3",
"city": "city",
"state": "state",
"postal_code": "postal_code",
"country": "country"
},
"ship_from_address": {
"address1": "address1",
"address2": "address2",
"address3": "address3",
"city": "city",
"state": "state",
"postal_code": "postal_code",
"country": "country"
},
"packages": [
{
"package_id": "package_id",
"package_name": "package_name",
"tracking_number": "tracking_number",
"tracking_url": "tracking_url",
"shipping_method_id": "shipping_method_id",
"shipping_method_name": "shipping_method_name",
"carrier_id": "carrier_id",
"carrier_name": "carrier_name",
"scac": "scac",
"bill_of_lading": "bill_of_lading",
"sscc": "sscc",
"pro_number": "pro_number",
"shipping_cost": 1,
"measurements": {
"length": 1,
"width": 1,
"height": 1,
"unit": "in",
"weight": 1,
"weight_unit": "lb"
},
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1,
"lot_id": "lot_id",
"expiration_date": "2022-06-06T01:02:03Z",
"parent_product_id": null
}
]
}
]
}
],
"external_system_url": "https://example.com/order/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"additional_fields": {
"key": "value"
},
"trackstar_created_date": "2023-03-15T13:45:30Z",
"trackstar_updated_date": "2023-03-15T13:45:30Z"
}
],
"next_token": "next_token",
"total_count": 1
}Changes
- info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status - info
added the required property
//////to the response with the status
- info