Skip to main content
PUT
/
wms
/
inbound-shipments
/
{inbound_shipment_id}
/
trackstar-tags
Update Inbound Shipment Trackstar Tags
curl --request PUT \
  --url https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}/trackstar-tags \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '"<any>"'
{
  "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",
    "status": "open",
    "raw_status": "raw_status",
    "supplier": "supplier",
    "supplier_object": {},
    "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
          }
        ]
      }
    ],
    "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"
    }
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token
string
required

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

Example:

"<x-trackstar-access-token>"

Path Parameters

inbound_shipment_id
string
required

Body

application/json
  • Base Schema
  • AMS
  • Staci Americas (AMWare)
  • Barbaras Development Inc. (BDI)
  • Bleckmann
  • BlueBox (IDrive Fulfillment)
  • Byrd Fulfillment
  • Camelot
  • Canary7
  • Capacity
  • CartonCloud
  • Cin7 Omni
  • Cirro
  • Crafty
  • CWR
  • DaVinci
  • DCL
  • Cin7 Core (Dear Systems)
  • Deposco
  • Distribution Management
  • DouYin (Chinese TikTok)
  • Elite Ops
  • Excelsior
  • Extensiv (3PL Central)
  • FabFitFun
  • Amazon
  • FFE
  • Finale
  • Flat Fee Shipping
  • Flexport (Deliverr)
  • Flowspace
  • Fulfillment.com
  • The Fulfillment Lab
  • fulfilmentcrowd
  • G Global
  • GoBolt
  • I-Fulfilment
  • iCreate
  • Infoplus
  • Its Here
  • JAS
  • Cart.com (Jazz Central)
  • Landmark
  • Leanafy
  • Leanware
  • Linnworks
  • Quickbox (LogicPod)
  • Logiwa
  • Logiwa IO
  • Mai Fulfillment
  • MasonHub
  • Mayple
  • Mintsoft
  • Next3PL
  • NFI
  • Nimble
  • NLRP
  • OIA Global
  • Ongoing WMS
  • OSA Commerce
  • PackemWMS
  • Packiyo
  • Pattern
  • Peoplevox
  • PostNord
  • Pulpo WMS
  • Quiet Platforms
  • RJW
  • WMS Sandbox
  • ShipBob
  • Shipedge
  • Shipfusion
  • ShipHero
  • ShipMonk
  • ShipNetwork
  • ShipOffers
  • ShipOut
  • Shipping and Handling
  • ShippingTree
  • Shippingbo
  • ShipStation
  • ShipStream
  • Shipwire
  • Skulabs
  • SKUSavvy
  • Linnworks Core (SKUVault)
  • Smart Warehousing
  • Sojo
  • Souko
  • Stock and Trace
  • Stord
  • Teapplix
  • TechShip
  • TikTok
  • Unis
  • Unleashed
  • Veeqo
  • VeraCore
  • Vertical Cold
  • Vox
  • Walmart
  • Warehance
  • Whiplash (Ryder)
  • XB Fulfillment
  • Xorosoft
  • Zenventory
trackstar_tags
any[]

A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.

Example:
["tag1", "tag2", { "tag3": "value3" }]

Response

Successful response

data
object
id
string

The ID of the object that has been created or modified

Example:

"id"

unused_fields
string[]

Unused fields

I