TRtrackstarhq
erp
Sales Orders

Get All ERP Sales Orders

Changed on

Returns all Sales Orders for the ERP connection associated with the provided access token.

get/erp/sales-orders

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/erp/sales-orders
  • Auth
    none required

Query parameters

page_tokenstring nullable
Example:page_token

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

limitinteger
Example:1000

The maximum number of items to return. The default is 1000.

instring[] required

A comma-separated list of resource IDs. If provided, all other query params are ignored.

{
  "in": [
    "_in"
  ]
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
containsstring[]

Comma-separated.

not_containsstring[]

Comma-separated.

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"
  ]
}
eq'pending_approval' | 'open' | 'partially_fulfilled' | 'fulfilled' | 'on_hold' | 'closed' | 'cancelled' | 'other'
neq'pending_approval' | 'open' | 'partially_fulfilled' | 'fulfilled' | 'on_hold' | 'closed' | 'cancelled' | 'other'
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The status of the sales order. See the sales order information for more details.

{
  "eq": "pending_approval",
  "neq": "cancelled",
  "in": [
    "cancelled"
  ],
  "nin": [
    "cancelled"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

A user-facing identifier for the order.

{
  "eq": "SO1001",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

An external reference on the order, such as the customer's PO number.

{
  "eq": "PO-9921",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

The date the order was placed. 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": "2024-05-01T00: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"
}

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Response

Successful response

next_tokenstring nullable required

See pagination for more details.

total_countinteger required

The number of items returned.

Example response

{
  "data": [
    {
      "id": "so_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "order_number": "SO1001",
      "reference_id": "PO-9921",
      "status": "pending_approval",
      "raw_status": "Pending Fulfillment",
      "order_date": "2024-05-01T00:00:00Z",
      "expected_ship_date": "2024-05-03T00:00:00Z",
      "customer_id": "cust_1",
      "location_id": "loc_1",
      "subtotal": 100,
      "total_tax": 8.5,
      "total_shipping": 12,
      "total_discount": 5,
      "total_price": 115.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"
      },
      "shipping_method_id": "sm_1",
      "shipping_method_name": "UPS Ground",
      "notes": [
        "Ship by Friday"
      ],
      "line_items": [
        {
          "line_item_id": "line_item_id",
          "item_id": "item_id",
          "sku": "sku",
          "quantity": 0,
          "unit_price": 0,
          "is_kit": false,
          "kit_components": [
            {
              "line_item_id": "1002",
              "item_id": "610",
              "sku": "10000",
              "quantity": 4
            }
          ],
          "location_id": "location_id"
        }
      ],
      "custom_fields": {
        "custom_field_example": {
          "value": "example_value",
          "type": "string",
          "title": "Example Field"
        }
      },
      "external_system_url": "https://example.com/salesorder/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