Get All Cart Orders
Returns all Orders for the Cart connection associated with the provided access token.
Request
- Base URLhttps://production.trackstarhq.com
- URLhttps://production.trackstarhq.com/cart/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) 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"
}A user-friendly identifier for the order This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"eq": "order_num",
"neq": "neq",
"in": [
"_in"
],
"nin": [
"nin"
],
"contains": "contains",
"not_contains": "not_contains"
}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) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"contains": [
"contains"
],
"not_contains": [
"not_contains"
]
}Filter orders by the SKUs in the line items This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"contains": [
"contains"
],
"not_contains": [
"not_contains"
]
}Only available for Shopify. Filter orders by the warehouse IDs of the shipping groups. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status) 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",
"order_number": "order_number",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"status": "open",
"raw_status": "raw_status",
"requested_shipping_method": "Standard",
"shipping_method_id": "shipping_method_id",
"shipping_method_name": "Standard Shipping",
"carrier_id": "carrier_id",
"carrier_name": "Carrier Name",
"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"
},
"bill_to_address": {
"full_name": "John Doe",
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"earliest_ship_date": "2022-10-10T01:02:03Z",
"latest_ship_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"line_item_id": "line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"parent_product_sku": "parent_product_sku",
"quantity": 1,
"unit_price": 10.99,
"discount": 1.5,
"tax": 0.5,
"warehouse_id": "warehouse_id"
}
],
"shipping_groups": [
{
"shipping_group_id": "shipping_group_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"raw_status": "raw_status",
"status": "shipped",
"warehouse_id": "warehouse_id",
"line_items": [
{
"line_item_id": "shipping_group_line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id"
}
]
}
],
"shipments": [
{
"shipment_id": "shipment_id",
"raw_status": "raw_status",
"status": "shipped",
"warehouse_id": "warehouse_id",
"shipping_method_id": "shipment_shipping_method_id",
"shipping_method_name": "shipment_shipping_method_name",
"carrier_id": "carrier_id",
"carrier_name": "carrier_name",
"tracking_number": "tracking_number",
"tracking_url": "https://www.example.com/tracking",
"line_items": [
{
"shipment_line_item_id": "shipment_line_item_id",
"product_id": "product_id",
"product_sku": "product_sku",
"parent_product_id": "parent_product_id",
"parent_product_sku": "parent_product_sku"
}
],
"shipping_groups": [
"sg_id_1",
"sg_id_2"
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z"
}
],
"tags": [
"tag_0"
],
"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
No recorded changes to this operation across all 4 revisions of this API.