TRtrackstarhq
wms
Inbound Shipments

Receive Inbound Shipment

Changed on

Receive an inbound shipment for the WMS connection with the associated inbound shipment id.

put/wms/inbound-shipments/{inbound_shipment_id}/receive

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}/receive
  • Auth
    none required

Path parameters

inbound_shipment_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
object required
OR
OR

Example request

{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "line_items": [
    {
      "sku": "sku",
      "quantity": 1
    }
  ]
}

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": "inbound_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "purchase_order_number": "po_number_123",
    "status": "receiving",
    "raw_status": "raw_status",
    "supplier_object": {
      "supplier_id": "supplier_id",
      "supplier_name": "supplier_name"
    },
    "expected_arrival_date": "2022-10-10T01:02:03Z",
    "warehouse_id": "warehouse_id123",
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "expected_quantity": 2,
        "received_quantity": 1,
        "unit_cost": 1,
        "external_id": "external_sku"
      }
    ],
    "receipts": [
      {
        "id": "receipt_id",
        "arrived_date": "2022-10-10T01:02:03Z",
        "line_items": [
          {
            "inventory_item_id": "item_id",
            "sku": "sku",
            "quantity": 1,
            "lot_id": "lot_id",
            "expiration_date": "2022-10-10T01:02:03Z"
          }
        ]
      }
    ],
    "ship_from_address": {
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States"
    },
    "tracking_numbers": [
      "tracking_number_1",
      "tracking_number_2"
    ],
    "notes": [
      "note_1",
      "note_2"
    ],
    "external_system_url": "https://example.com/inboundshipment/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

  • f9f948f2a7b3Revision changes
    • breaking

      removed from the request body oneOf list

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added to the request body oneOf list

    • info

      added id name discriminator mapping keys to the / request property

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status