TRtrackstarhq
cart
Orders

Create Cart Order Shipment

Changed on

Get the required, optional, and integration specific fields by calling the integrations endpoint.

post/cart/orders/{order_id}/shipments

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/cart/orders/{order_id}/shipments
  • Auth
    none required

Path parameters

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
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "tracking_number": "tracking_number",
  "tracking_url": "https://www.example.com/tracking",
  "carrier_name": "Carrier Name",
  "shipping_method_name": "Standard Shipping",
  "line_items": [
    {
      "product_sku": "product_sku",
      "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": "order_id",
    "order_number": "order_number",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "status": "fulfilled",
    "raw_status": "raw_status",
    "requested_shipping_method": "Standard",
    "shipping_method_id": "shipping_method_id",
    "shipping_method_name": "Standard Shipping",
    "carrier_id": "carrier_id",
    "carrier_name": "Carrier Name",
    "invoice_currency_code": "USD",
    "total_price": 13.49,
    "total_tax": 1.5,
    "total_discount": 2.5,
    "total_shipping": 3.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"
    },
    "earliest_ship_date": "2022-10-10T01:02:03Z",
    "latest_ship_date": "2022-10-10T01:02:03Z",
    "line_items": [
      {
        "line_item_id": "line_item_id",
        "product_id": "product_id",
        "product_sku": "product_sku",
        "parent_product_id": "parent_product_id",
        "parent_product_sku": "parent_product_sku",
        "quantity": 1,
        "unit_price": 10.99,
        "discount": 1.5,
        "tax": 0.5,
        "warehouse_id": "warehouse_id"
      }
    ],
    "shipping_groups": [
      {
        "shipping_group_id": "shipping_group_id",
        "created_date": "2022-01-01T00:00:00Z",
        "updated_date": "2022-01-02T05:05:05Z",
        "raw_status": "raw_status",
        "status": "shipped",
        "warehouse_id": "warehouse_id",
        "line_items": [
          {
            "line_item_id": "shipping_group_line_item_id",
            "product_id": "product_id",
            "product_sku": "product_sku",
            "parent_product_id": "parent_product_id"
          }
        ]
      }
    ],
    "shipments": [
      {
        "shipment_id": "shipment_id",
        "raw_status": "raw_status",
        "status": "shipped",
        "warehouse_id": "warehouse_id",
        "shipping_method_id": "shipment_shipping_method_id",
        "shipping_method_name": "shipment_shipping_method_name",
        "carrier_id": "carrier_id",
        "carrier_name": "carrier_name",
        "tracking_number": "tracking_number",
        "tracking_url": "https://www.example.com/tracking",
        "line_items": [
          {
            "shipment_line_item_id": "shipment_line_item_id",
            "product_id": "product_id",
            "product_sku": "product_sku",
            "parent_product_id": "parent_product_id",
            "parent_product_sku": "parent_product_sku"
          }
        ],
        "shipping_groups": [
          "sg_id_1",
          "sg_id_2"
        ],
        "ship_from_address": {
          "address1": "123 Main St",
          "address2": "Apt 2",
          "address3": "Floor 3",
          "city": "New York",
          "state": "NY",
          "postal_code": "10001",
          "country": "United States"
        },
        "created_date": "2022-01-01T00:00:00Z",
        "updated_date": "2022-01-02T05:05:05Z"
      }
    ],
    "tags": [
      "tag_0"
    ],
    "external_system_url": "https://example.com/order/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

  • 08647f790594Revision changes
    • info

      added the new optional request property /

  • f9f948f2a7b3Revision changes
    • breaking

      removed from the request body oneOf list

    • breaking

      added subschema #1 to the request property allOf list

    • breaking

      added subschema #1 to the request property allOf list

    • breaking

      added subschema #1 subschema #2 to the request property allOf list

    • breaking

      removed the enum value Boğaziçi of the request property /

    • breaking

      removed the enum value Colis Privé of the request property /

    • breaking

      removed the enum value J&amp;T Express of the request property /

    • breaking

      removed the enum value Sürat Kargo of the request property /

    • breaking

      removed the enum value Transaragonés of the request property /

    • breaking

      removed the enum value Yurtiçi Kargo of the request property /

    • breaking

      the / request property's minItems was increased to 1

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added to the request body oneOf list

    • info

      added the new AG Logistica Express enum value to the request property /

    • info

      added the new AJEX enum value to the request property /

    • info

      added the new AL Express enum value to the request property /

    • info

      added the new APC-Overnight enum value to the request property /

    • info

      added the new AT Post enum value to the request property /

    • info

      added the new Acelera Flex enum value to the request property /

    • info

      added the new Ader enum value to the request property /

    • info

      added the new Baral Logistics enum value to the request property /

    • info

      added the new Bharat enum value to the request property /

    • info

      added the new Blitz enum value to the request property /

    • info

      added the new Borzo enum value to the request property /

    • info

      added the new Bounce enum value to the request property /

    • info

      added the new Boğaziçi enum value to the request property /

    • info

      added the new Bringer enum value to the request property /

    • info

      added the new COLIS PRIVE enum value to the request property /

    • info

      added the new CTTExpress enum value to the request property /

    • info

      added the new Canpar Express enum value to the request property /

    • info

      added the new Chama Logistica enum value to the request property /

    • info

      added the new Chega Log Entregas Flex enum value to the request property /

    • info

      added the new Colis Prive enum value to the request property /

    • info

      added the new Colis Privé enum value to the request property /

    • info

      added the new Conexao Envios enum value to the request property /

    • info

      added the new Couriers Please enum value to the request property /

    • info

      added the new DACSHER enum value to the request property /

    • info

      added the new DASCHER enum value to the request property /

    • info

      added the new DPWorld enum value to the request property /

    • info

      added the new Desertcart enum value to the request property /

    • info

      added the new DirectLink enum value to the request property /

    • info

      added the new ECMS Express Inc enum value to the request property /

    • info

      added the new ECMS Express Inc. enum value to the request property /

    • info

      added the new ESI Delivery Service enum value to the request property /

    • info

      added the new Equipe Motoboys enum value to the request property /

    • info

      added the new Evri enum value to the request property /

    • info

      added the new Expresso Flex enum value to the request property /

    • info

      added the new F6 Express enum value to the request property /

    • info

      added the new FEDEX_JP enum value to the request property /

    • info

      added the new FITFRESH enum value to the request property /

    • info

      added the new Fenix express enum value to the request property /

    • info

      added the new Fercam enum value to the request property /

    • info

      added the new Flash enum value to the request property /

    • info

      added the new Flash Express enum value to the request property /

    • info

      added the new FleetOptics enum value to the request property /

    • info

      added the new Flex Boys enum value to the request property /

    • info

      added the new Flex Correria Express enum value to the request property /

    • info

      added the new Flex Velozz enum value to the request property /

    • info

      added the new FlexJa Entregas Rapidas enum value to the request property /

    • info

      added the new Foguete Log enum value to the request property /

    • info

      added the new France Express enum value to the request property /

    • info

      added the new GBL Express enum value to the request property /

    • info

      added the new GEODIS enum value to the request property /

    • info

      added the new GLS US enum value to the request property /

    • info

      added the new GT Flex Entregas enum value to the request property /

    • info

      added the new GlobalPost enum value to the request property /

    • info

      added the new Goncargas Express enum value to the request property /

    • info

      added the new Hepsijet Kargo enum value to the request property /

    • info

      added the new Hong Kong Post enum value to the request property /

    • info

      added the new Intelcom enum value to the request property /

    • info

      added the new J&T Express enum value to the request property /

    • info

      added the new J3 Flex enum value to the request property /

    • info

      added the new JD LOGISTICS enum value to the request property /

    • info

      added the new JD Logistics enum value to the request property /

    • info

      added the new JP_EXPRESS enum value to the request property /

    • info

      added the new JT Flex Logistica enum value to the request property /

    • info

      added the new Jadlog enum value to the request property /

    • info

      added the new Jeebly enum value to the request property /

    • info

      added the new JetSouq Express enum value to the request property /

    • info

      added the new Jiehang enum value to the request property /

    • info

      added the new K10 Flex enum value to the request property /

    • info

      added the new KSE enum value to the request property /

    • info

      added the new Korea Post enum value to the request property /

    • info

      added the new Kuehne Nagel enum value to the request property /

    • info

      added the new Kunzendorf enum value to the request property /

    • info

      added the new LANDMARK enum value to the request property /

    • info

      added the new LN Transportes enum value to the request property /

    • info

      added the new Loadshare enum value to the request property /

    • info

      added the new Log manager enum value to the request property /

    • info

      added the new Logi Connect enum value to the request property /

    • info

      added the new Lovely Express enum value to the request property /

    • info

      added the new MAX Express enum value to the request property /

    • info

      added the new MB Flex Express enum value to the request property /

    • info

      added the new MG Log Express enum value to the request property /

    • info

      added the new MZZ Briefdienst enum value to the request property /

    • info

      added the new Magicfleet enum value to the request property /

    • info

      added the new Metropolitan Warehouse and Delivery enum value to the request property /

    • info

      added the new Meyer Logistics enum value to the request property /

    • info

      added the new Mineiro Express enum value to the request property /

    • info

      added the new Mylerz enum value to the request property /

    • info

      added the new NACEX enum value to the request property /

    • info

      added the new Naplog Logistics enum value to the request property /

    • info

      added the new Nobres Entregas enum value to the request property /

    • info

      added the new Ola enum value to the request property /

    • info

      added the new PARCEL2GO.COM enum value to the request property /

    • info

      added the new PF Logistics enum value to the request property /

    • info

      added the new Pandion enum value to the request property /

    • info

      added the new Pitt Ohio enum value to the request property /

    • info

      added the new Pomo DOuro Express enum value to the request property /

    • info

      added the new Post NL enum value to the request property /

    • info

      added the new Purolator enum value to the request property /

    • info

      added the new QExpress enum value to the request property /

    • info

      added the new Quick enum value to the request property /

    • info

      added the new QuickShift enum value to the request property /

    • info

      added the new Qwqer enum value to the request property /

    • info

      added the new RND Logistica enum value to the request property /

    • info

      added the new ROYAL_MAIL enum value to the request property /

    • info

      added the new RR Express Logistica enum value to the request property /

    • info

      added the new RRleste enum value to the request property /

    • info

      added the new RS Flex enum value to the request property /

    • info

      added the new Raben enum value to the request property /

    • info

      added the new Rapiboy enum value to the request property /

    • info

      added the new Rapido enum value to the request property /

    • info

      added the new Roadie enum value to the request property /

    • info

      added the new SJL Express enum value to the request property /

    • info

      added the new SOS Envios Express enum value to the request property /

    • info

      added the new Sagawa Express enum value to the request property /

    • info

      added the new SagawaExpress enum value to the request property /

    • info

      added the new Saudi Post enum value to the request property /

    • info

      added the new Scooton enum value to the request property /

    • info

      added the new Sendle enum value to the request property /

    • info

      added the new Shadowfax enum value to the request property /

    • info

      added the new Shanghai Shouwu enum value to the request property /

    • info

      added the new SkyNet Worldwide Express enum value to the request property /

    • info

      added the new Sonic Flex enum value to the request property /

    • info

      added the new Speed Guri enum value to the request property /

    • info

      added the new Spreetail enum value to the request property /

    • info

      added the new Spring GDS enum value to the request property /

    • info

      added the new StarTrack enum value to the request property /

    • info

      added the new Super Express enum value to the request property /

    • info

      added the new Swftbox enum value to the request property /

    • info

      added the new Sürat Kargo enum value to the request property /

    • info

      added the new TFM Express enum value to the request property /

    • info

      added the new TForce Freight enum value to the request property /

    • info

      added the new TForce Logistics enum value to the request property /

    • info

      added the new TLG Logistica enum value to the request property /

    • info

      added the new TM Logistica enum value to the request property /

    • info

      added the new Team Global Express enum value to the request property /

    • info

      added the new Top Express enum value to the request property /

    • info

      added the new Tracken enum value to the request property /

    • info

      added the new Transaragonés enum value to the request property /

    • info

      added the new Transoflex enum value to the request property /

    • info

      added the new UK MAIL enum value to the request property /

    • info

      added the new Uber enum value to the request property /

    • info

      added the new Vancotech enum value to the request property /

    • info

      added the new Varoes Express enum value to the request property /

    • info

      added the new Viplog enum value to the request property /

    • info

      added the new WA Transportes enum value to the request property /

    • info

      added the new WDK Express enum value to the request property /

    • info

      added the new Waynik enum value to the request property /

    • info

      added the new XPO HB enum value to the request property /

    • info

      added the new YamatoTransport enum value to the request property /

    • info

      added the new Yanwen enum value to the request property /

    • info

      added the new Yulu enum value to the request property /

    • info

      added the new Yurtiçi Kargo enum value to the request property /

    • info

      added the new ZAJEL Courier Services enum value to the request property /

    • info

      added the new ZID enum value to the request property /