TRtrackstarhq
erp
Sales Orders

Update ERP Sales Order

Changed on

Edits header fields, edits or closes existing line items, and/or adds new line items on an existing sales order. Get the required, optional, and integration specific fields by calling the integrations endpoint.

put/erp/sales-orders/{sales_order_id}

Request

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

Path parameters

sales_order_idstring required

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).

Idempotency-Keystring
Example:9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00

Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.

Request body

OR
OR

Example request

{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "reference_id": "PO-9921",
  "order_date": "2024-05-01T00:00:00Z",
  "expected_ship_date": "2024-05-03T00:00:00Z",
  "notes": [
    "Ship by Friday"
  ],
  "line_items": [
    {
      "line_item_id": "line_1",
      "item_id": null,
      "sku": "sku",
      "quantity": 0,
      "unit_price": 0
    }
  ]
}

Response

Successful response

idstring required

The ID of the object that has been created or modified

unused_fieldsstring[] required

Unused fields

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": "open",
    "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"
  },
  "id": "id",
  "unused_fields": [
    "unused_fields"
  ]
}

Changes