TRtrackstarhq
erp
Sales Order Shipments

Create ERP Sales Order Shipment

Changed on

Records a shipment (fulfillment) against an existing sales order. The parent sales order is identified by sales_order_id in the request body. Get the required, optional, and integration specific fields by calling the integrations endpoint.

post/erp/sales-order-shipments

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/erp/sales-order-shipments
  • Auth
    none 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

Example request

{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "sales_order_id": "so_id",
  "packages": [
    {
      "tracking_number": "1Z999AA10123456784",
      "measurements": {
        "weight": 2.5,
        "weight_unit": "lb"
      }
    }
  ],
  "line_items": [
    {
      "line_item_id": "line_item_id",
      "item_id": "item_id",
      "quantity": 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": "ship_1",
    "sales_order_id": "so_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "shipment_number": "IF1001",
    "shipped_date": "2024-05-04T00:00:00Z",
    "location_id": "loc_1",
    "notes": [
      "First wave"
    ],
    "packages": [
      {
        "package_id": "ship_1-1",
        "tracking_number": "1Z999AA10123456784",
        "measurements": {
          "length": 12,
          "width": 9,
          "height": 4,
          "unit": "in",
          "weight": 2.5,
          "weight_unit": "lb"
        }
      }
    ],
    "line_items": [
      {
        "shipment_line_item_id": "shipment_line_item_id",
        "line_item_id": "line_item_id",
        "item_id": "item_id",
        "sku": "sku",
        "quantity": 0,
        "is_kit": false,
        "kit_components": [
          {
            "line_item_id": "1002",
            "item_id": "610",
            "sku": "10000",
            "quantity": 4,
            "lots": [
              {
                "lot_id": "78524",
                "lot_name": "051326",
                "bin_id": null,
                "bin_name": null,
                "quantity": 4
              }
            ]
          }
        ],
        "lot_id": "lot_id",
        "lot_name": "lot_name",
        "expiration_date": "2023-03-15T13:45:30Z",
        "bin_id": "bin_id",
        "bin_name": "bin_name"
      }
    ],
    "custom_fields": {
      "custom_field_example": {
        "value": "example_value",
        "type": "string",
        "title": "Example Field"
      }
    },
    "external_system_url": "https://example.com/salesordershipment/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