> ## Documentation Index > Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Cart Order Shipment > Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. ## OpenAPI ````yaml post /cart/orders/{order_id}/shipments openapi: 3.1.0 info: description: > Trackstar is a Unified API that provides standard endpoints for Supply Chain Logistics. We currently offer an API for Warehouse Management Systems (WMS). title: Trackstar API version: 0.1.0 servers: - description: Trackstar API url: https://production.trackstarhq.com security: [] tags: [] externalDocs: description: Trackstar API Documentation url: https://docs.trackstarhq.com paths: /cart/orders/{order_id}/shipments: post: tags: - cart - Orders summary: Create Cart Order Shipment description: >- Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. operationId: post_cart_create_order_shipment parameters: - in: path name: order_id schema: type: string required: true - in: header name: x-trackstar-api-key description: Your organization-level Trackstar API key. schema: type: string example: required: true - in: header name: x-trackstar-access-token description: >- Your user's access token for a specific integration (ShipHero, Extensiv, etc). schema: type: string example: required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateShipmentcartOrderInputSchema' responses: '200': content: application/json: schema: $ref: '#/components/schemas/cartCreateShipmentOrderResponse' description: Successful response '404': content: application/json: schema: $ref: '#/components/schemas/HTTPError' description: Not found '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: Validation error components: schemas: CreateShipmentcartOrderInputSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/CreateCartOrderShipmentSchema--Base__Schema--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Amazon--' - $ref: '#/components/schemas/CreateShipmentcartOrder--BigCommerce--' - $ref: '#/components/schemas/CreateShipmentcartOrder--eBay--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Faire--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Groupon--' - $ref: >- #/components/schemas/CreateShipmentcartOrder--Magento__-_Adobe__Commerce_--- - $ref: '#/components/schemas/CreateShipmentcartOrder--Mirakl--' - $ref: '#/components/schemas/CreateShipmentcartOrder--NuOrder--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Overstock--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Cart__Sandbox--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Shopify--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Squarespace--' - $ref: '#/components/schemas/CreateShipmentcartOrder--TikTok--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Walmart--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Wayfair--' - $ref: '#/components/schemas/CreateShipmentcartOrder--Wix--' - $ref: '#/components/schemas/CreateShipmentcartOrder--WooCommerce--' title: CreateShipmentcartOrderInputSchema cartCreateShipmentOrderResponse: type: object properties: data: $ref: '#/components/schemas/CreateCartOrderShipmentResponseDataSchema' id: type: string description: The ID of the object that has been created or modified example: id unused_fields: type: array description: Unused fields items: type: string description: '' required: - id - unused_fields additionalProperties: false title: cartCreateShipmentOrderResponse HTTPError: properties: error: type: string id: type: string description: The ID of the item that wasn't found. required: - error type: object title: HTTPError ValidationError: properties: error: type: string detail: type: object properties: : type: object properties: : type: array items: type: string required: - error type: object title: ValidationError CreateCartOrderShipmentSchema--Base__Schema--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. tracking_url: type: string description: The URL for the tracking number. example: https://www.example.com/tracking carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name shipping_method_name: type: string description: The name of the actual shipping method. example: Standard Shipping required: - carrier_name - shipping_method_name - tracking_number - tracking_url additionalProperties: true title: Base Schema CreateShipmentcartOrder--Amazon--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. carrier_name: type: string enum: - 17FEIA - 360lion - 4PX - A-1 - AAA Cooper - ABF - AFL/Fedex - Airtel - ALLJOY - AMAUK - AMAZON HORIZON - Amazon Shipping - AMZL - AMZL_UK - Andere - Anjun - AO - AO Deutschland - APC - APC Overnight - APC POSTAL LOGISTICS - APG eCommerce - Aramex - ARAS - Aras Kargo - Arco Spedizioni - Arkas - Arrow XL - Asendia - Asgard - Assett - AT POST - ATPOST - ATS - AUSSIE_POST - Australia Post - Australia Post-ArticleID - Australia Post-Consignment - B2C - B2C Europe - B2CShip - Balnak - Bartolini - Beijing Quanfeng Express - Best Buy - Best Express - Better Trucks - BJS - Blowhorn - Blue Package - BlueDart - BoÄŸaziçi - Bombax - Bombino Express - BPOST - BR1 Express - BRT - Buylogic - Cainiao - Canada Post - Canpar - CargoLine - Caribou - Cart2India - CBHub - CBL - CDC - CELERITAS - Centex - CEVA - Ceva Lojistik - China Post - Chrono Express - Chronopost - Chukou1 - Cititrans - City Link - CityPost - CNE - Coliposte - Colis Privé - Colissimo - Consegna Mezzi Propri - Conway - Correios - Correos - Correos Express - COSCO - CouriersPlease - CTT EXPRESS - Cubyn - CyberSavings - DACHSER - DAIPOST - DB Schenker - DEL Deliveries - Delhivery - Delivengo - Delivery Group - Der Kurier - DESERTCART - Deutsche Post - DFL - DHL - DHL eCommerce - DHL Express - DHL Freight - DHL Global Mail - DHL Home Delivery - DHL Kargo - DHL-Paket - DHL Parcel UK - DHLPL - Digital Delivery - DirectLog - Dotzot - DPB - DPD - DPD Local - DSV - DTDC - DX - DX Express - DX Freight - DX Secure - DYNAMIC EXPRESS - ECMS - ECMS express - Ecom Express - Ecom Shipping solutions PVT ltd - EINSA SOURCING - EKI Trans - Emirates Post - Emons - Endopack - Energo - Envialia - ePost Global - Equick - ESNAD - Estafeta - Estes - EUB - Europaczka - Exapaq - FAST EST - Fastway - FedEx - Fedex Freight - FEDEX JP - FedEx SmartPost - FERCAM - Fillo Kargo - First Flight - First Flight China - First Mile - Fleetan - Flyt - FRACHTPOST - FRANCE EXPRESS - Gati - GEL - GEL Express - geodis - Geodis Calberson - Geopost Kargo - GFS - GLS - GLS Canada - GO! - Gojavas - GRUPO LOGISTIC - Hellmann - Heppner - Hermes - Hermes (Corporate) - Hermes Einrichtungsservice - Hermes Logistik Gruppe - Hermes UK - Hlog - HNC - Home Logistics - honesteye - Hongkong Post - Horoz Lojistik - Hotpoint Logistics - HRP - HS code - HUAHAN Logistics - HubEurope - Hunter Express - Hunter Logistics - Huxloe - Huxloe Logistics - ICC Worldwide - IDS - IDS Netzwerk - iMile - India Post - InPost - Interlink - Interno - Intersoft - iParcel - ITD Global - J&T Express - Japan Post - JCEX - Jersey Post - Jiufang - JP EXPRESS - JPL UPU - JS Express - JT - JT Express - JY Express - Kargokar - KEAVO - Kerry - Kuehne+Nagel - Kybotech - La Poste - Landmark - Landmark Global - Lasership - Lemonmode - Letian - LF Logistic - Liccardi - Liccardi Trasporti - Logistik Gruppe - Loomis - Mail Alliance - Mail Americas - Mainpost - MBE - Metro Kargo - Mezzi propri - MHI - Milkman - MNG Kargo - Mondial Relay - MRW - MZZ-Briefdienst - Nacex - NAQEL EXPRESS - Narpost Kargo - New Zealand Post - Newgistics - Nexive - Ninjavan - NipponExpress - NITTSU - NOVEO - NowBikes - NTL - OCS Worldwide - Old Dominion - OneWorldExpress - ONTIME - OnTrac - OSM - OSM Worldwide - Other - Otro - Overnite Express - Palletline - Palletways - Panther - Parcel Hub - Parcel Monkey - Parcel Station - Parcel2go - ParcelDenOnline - Parcelforce - Parcelhub - Parcelink Logistics - Parcelnet - ParcelOne - Paquetexpress - PDC Logistics - Pidge - Pilot - Pilot Freight - PIN - Polish Post - Pos Laju - Post Modern - Poste Italiane - PostNL - PostNord - Professional - PTT Kargo - PUROLATOR - Quantium - Qxpress - R+L - Raben Group - RBNA - REDUR - Redpack - Rhenus - Rieck - Rivigo - RMLGB - ROADIE - Roadrunner - Royal Mail - RR Donnelley - Safexpress - SAGAWA - SAGAWA EXPRESS - Saia - Sailpost - Schweizer Post - SDA - Seino - SEINO TRANSPORTATION - Seko Logistics - Selem Kargo - Self Delivery - Sendcloud - Sending - SENDLE - Seur - Seven Senders - SF Express - SFC - Ship Delight - Ship Global US - SHIPA - ShipEconomy - ShipEntegra - ShipGlobal - Shipmate - Shippit - Shopini World - Shree Maruti Courier - Shree Tirupati Courier - Shunfeng Express - Sinerlog - Singapore Post - Sinotrans - Skypostal - Smartmail - Smartrlogistics - SMSA - SMSA Express - Soarmall - Sonstige - South Eastern Freight Lines - Speedaf - Speedex - Spoton - SPRING - spring GDS - Sprint - Stahlmann and Sachs - Stampit - Staples - StarTrack-ArticleID - StarTrack-Consignment - STG - STO Express - Streamlite - Sunyou - Sürat Kargo - Susa - Swiss post - Szendex - Target - TATA Express - TDN - Team Express - Tezel Lojistik - The Delivery Group - The Professional Couriers - TIPSA - TNT - TNT Kargo - TNTIT - Toll - Toll Global Express - Tongda Global - Topyou - Total Express - Tourline - Trackon - Trakpak - Transaher - Transaragonés - TransFolha - Translink - Trans-o-Flex - Truline - TSB - Tuffnells - TWS - TXT - TyD - UBI - UKMail - UniUni - UPakWeShip - UPS - UPS Freight - UPS Mail Innovations - Upsilon - UPSMI - Urban Express - Uship - USPS - Verage Shipping - Via Xpress - VIR - VNLIN - WanbExpress - Watkins and Shepard - Wefast - WeWorldExpress - Whistl - Whizzard - WINIT - WPX - XDP - XPO - XPO Freight - Xpressbees - YAMATO - YAMATO TRANSPORT - YANWEN - YDH - Yellow Freight - YF Logistics - YFHEX - YHT - Yodel - YTO Express - Yun Express - Yunda Express - Yurtiçi Kargo - ZAD Express - Zeleris - Zippee - ZTO Express - Zust Ambrosetti description: The name of the carrier used to ship the order. example: Carrier Name shipping_method_name: type: string description: The name of the actual shipping method. example: Standard Shipping requested_shipping_method: type: string description: The type of shipping method requested by the customer. example: Standard shipped_date: type: string format: date-time description: When the order was shipped example: '2025-01-01T00:00:00Z' skip_retrieval: type: boolean default: false description: Skip resource retrieval after successful create operation example: false package_reference_id: type: string description: >- Reuse the packageReferenceId from a prior shipment on this order to edit it instead of creating a new package (e.g. to replace tracking after a voided label). line_items: type: array description: List of the products included in the order. example: - product_sku: null sku: null quantity: 0 transparency_codes: null items: $ref: '#/components/schemas/CartOrderWriteLineItemamazon' required: - carrier_name - shipped_date - tracking_number additionalProperties: false title: Amazon CreateShipmentcartOrder--BigCommerce--: type: object properties: carrier_id: type: string enum: - auspost - canadapost - endicia - usps - fedex - ups - upsready - upsonline - shipperhq - royalmail description: The ID of the carrier example: carrier_id tracking_number: type: string description: The tracking number for the shipment. required: - carrier_id - tracking_number additionalProperties: false title: BigCommerce CreateShipmentcartOrder--eBay--: type: object properties: line_items: type: array description: List of the products included in the order. example: - product_sku: null line_item_id: null quantity: 0 items: $ref: '#/components/schemas/CartOrderCreateLineItemebay' shipped_date: type: string format: date-time description: >- When the order was shipped. If not provided, will default to current date. example: '2025-01-01T00:00:00Z' carrier_name: type: string enum: - UPS - USPS - FedEx - FourPX - FourPXCHINA - FourPXLTD - SevenLSP - A1CourierServices - ABF - AMWST - ARAMEX - ARVATO - AustraliaPost - AVRT - BELGIANPOST - BKNS - BluePackage - CanPar - CENF - CEVA - ChinaPost - Chronopost - CHUKOU1 - ChunghwaPost - CitiPost - CNWY - ColiposteDomestic - ColiposteInternational - Correos - CPC - DayandRoss - DBSchenker - DeutschePost - DHL - DHLGlobalMail - DHLEKB - DHLG - DPXThailand - EMF - FedExSmartPost - FLYT - FlytExpressUSDirectline - FTFT - FulfilExpressAccStation - FulfilExpresseForCity - FulfilExpressEverydaySource - FulfilExpressiTrimming - HDUSA - Hermes - HomeDeliveryNetwork - HongKongPost - iLoxx - IndiaPost - IndonesiaPost - InterPost - Iparcel - IsraelPost - JapanPost - KIALA - KoreaPost - LAPOSTE - Landmark - LDSO - LTL - MALAYSIAPOST - MannaFreight - MNGTurkey - MSI - Nacex - NEMF - ODFL - OFFD - ONTRACK - Other - OVNT - ParcelPool - Parcelforce - Philpost - Pilot - PITD - POSTITALIANO - Prestige - Quantium - RETL - RoyalMail - RRUN - SAIA - Seur - SFC - SINGAPOREPOST - SioliandFontana - SkynetMalaysia - SpeeDee - SuntekExpressLTD - SwissPost - TELE - THAILANDPOST - TNT - TPG - TWW - UBI - UPSMailInnovations - UPSC - USFG - USPSCeP - USPSPMI - VietnamPost - VITR - WATKINS - Winit - Wise - WNdirect - WPX - YANWEN - YRC - FLYTExpress - SFCExpress - FourPXExpress - FASTWAYCOURIERS - ALLIEDEXPRESS - HUNTEREXPRESS description: The name of the carrier used to ship the order. example: Carrier Name tracking_number: type: string description: The tracking number for the shipment. required: - line_items additionalProperties: false title: eBay CreateShipmentcartOrder--Faire--: type: object properties: carrier_name: type: string enum: - CANADA_POST - DHL_ECOMMERCE - DHL_EXPRESS - FEDEX - PUROLATOR - UPS - USPS - POSTNL - CANPAR - INTERLINK_EXPRESS - GSO - ROYAL_MAIL - DPD - DPDUK - PARCELFORCE - AUSTRALIA_POST - EVRI - LA_POSTE description: The name of the carrier used to ship the order. example: Carrier Name tracking_number: type: string description: The tracking number for the shipment. shipping_cost: type: number description: Cost for this shipment example: 1.99 required: - carrier_name - shipping_cost - tracking_number additionalProperties: false title: Faire CreateShipmentcartOrder--Groupon--: type: object properties: carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name tracking_number: type: string description: The tracking number for the shipment. required: - carrier_name - tracking_number additionalProperties: false title: Groupon CreateShipmentcartOrder--Magento__-_Adobe__Commerce_---: type: object properties: tracking_number: type: string description: The tracking number for the shipment. carrier_id: type: string enum: - fedex - ups - usps - dhl description: The carrier code. Required if tracking_number is provided. example: fedex line_items: type: array description: List of the products included in the order. example: - product_sku: null sku: null quantity: 0 items: $ref: '#/components/schemas/CartOrderCreateLineItemmagento' additionalProperties: false title: Magento (Adobe Commerce) CreateShipmentcartOrder--Mirakl--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. tracking_url: type: string description: The URL for the tracking number. example: https://www.example.com/tracking carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name line_items: type: array description: List of the products included in the order. example: - line_item_id: null quantity: 0 items: $ref: '#/components/schemas/CartOrderWriteLineItemmirakl' required: - carrier_name - line_items additionalProperties: false title: Mirakl CreateShipmentcartOrder--NuOrder--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. line_items: type: array description: List of the products included in the order. example: - product_sku: null quantity: 0 items: $ref: '#/components/schemas/CartOrderCreateLineItemnuorder' carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name required: - carrier_name - line_items - tracking_number additionalProperties: false title: NuOrder CreateShipmentcartOrder--Overstock--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name shipping_method_name: type: string description: The name of the actual shipping method. example: Standard Shipping warehouse_id: type: string description: >- The warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/cart-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_date: type: string format: date-time description: The date the order was shipped. example: '2030-01-01T00:00:00Z' required: - carrier_name - ship_date - shipping_method_name - tracking_number - warehouse_id additionalProperties: false title: Overstock CreateShipmentcartOrder--Cart__Sandbox--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. tracking_url: type: string description: The URL for the tracking number. example: https://www.example.com/tracking carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name shipping_method_name: type: string description: The name of the actual shipping method. example: Standard Shipping required: - carrier_name - shipping_method_name - tracking_number - tracking_url additionalProperties: false title: Cart Sandbox CreateShipmentcartOrder--Shopify--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. tracking_url: type: string description: The URL for the tracking number. example: https://www.example.com/tracking notify_customer: type: boolean description: Whether the customer should be notified via email. example: true shipping_groups: type: array description: >- Sets of line items that will be fulfilled together from the same locations. items: $ref: '#/components/schemas/ShopifyCartOrderShippingGroup' required: - shipping_groups - tracking_number - tracking_url additionalProperties: false title: Shopify CreateShipmentcartOrder--Squarespace--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. tracking_url: type: string description: The URL for the tracking number. example: https://www.example.com/tracking carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name shipping_method_name: type: string description: The name of the actual shipping method. example: Standard Shipping ship_date: type: string format: date-time description: The date the shipment was shipped. example: '2026-05-14T22:00:00Z' required: - carrier_name - ship_date - shipping_method_name - tracking_number additionalProperties: false title: Squarespace CreateShipmentcartOrder--TikTok--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. shop_id: type: string description: >- The TikTok shop ID of the product to create this shipment for. If you only have one shop, we will default to it. example: shop_id carrier_name: type: string description: The name of the carrier used to ship the order to the customer. example: carrier carrier: type: string description: >- The name of the carrier used to ship the order to the customer. Use carrier_name instead. line_items: type: array description: List of the products included in the order. example: - line_item_id: null quantity: 1 items: $ref: '#/components/schemas/CartOrderWriteLineItemtiktok' skip_retrieval: type: boolean default: false description: Skip resource retrieval after successful create operation example: false required: - shop_id - tracking_number additionalProperties: false title: TikTok CreateShipmentcartOrder--Walmart--: type: object properties: line_items: type: array description: List of the products included in the order. example: - product_sku: null sku: null quantity: 0 items: $ref: '#/components/schemas/CartOrderWriteLineItemwalmart' carrier_name: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: The name of the carrier used to ship the order. example: Carrier Name requested_shipping_method: type: string enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value description: The type of shipping method requested by the customer. example: Standard tracking_number: type: string description: The tracking number for the shipment. skip_retrieval: type: boolean default: false description: Skip resource retrieval after successful create operation example: false required: - carrier_name - line_items - requested_shipping_method - tracking_number additionalProperties: false title: Walmart CreateShipmentcartOrder--Wayfair--: type: object properties: shipping_method_name: type: string enum: - 2nd Day Air Delivery - 2-Day Delivery -- Free! - Global 5-Day Direct Delivery - 3 Day Delivery - Container - Zustellung per Email - FedEx Home Delivery - Small Parcel Courier - Ground - Delivery Signature Required - Small Parcel Courier - Imperial Pool Freight - Next Day Air - Next Day Air (AK,HI,PR) - UK - SP - Next day before noon - UK - SP - Next day before 9am - Will Call - UK - SP - Saturday delivery - Casket Delivery - 1 Day - Casket Delivery - 2 Day - Curbside with unload service - Truck Load - Curbside without unload service - Spedition - frei Bordsteinkante - Room of Choice & Packaging Removal - Premium 2-Man Delivery - Room of Choice Delivery with Installation - Room of Choice - Truck Freight - Threshold - Standard-Versand Sperrgut - ALMO - Room of Choice + Removal of Old Appliance - Large Parcel Courier - European Line Haul - Economy - White Glove Delivery - Room of Choice - Small Parcel - GROUND (AK,HI,PR) - Low Cost Carrier - Backyard Drop-Off - Curbside Delivery - Inside Delivery - Packaging Removal & Removal of Old Appliance - One Man Premium - Inside Delivery - Packaging Removal - Threshold Delivery - Large Parcel Courier - Allied Road Express - Hunter Road Express - White Glove - Capital Cities - Spedition - frei Bordsteinkante - Large Parcel Courier - In Home Mattress Set Up & Removal - Room of Choice Delivery w/ Installation - Room of Choice Delivery w/ Installation & Haul Away - Room of Choice Delivery w/ Haul Away - Room of Choice Delivery w/ Move to Another Room - Room of Choice Delivery w/ Install & Move to Another Room - Room of Choice Delivery - Samsung Delivery Service - Wayfair Large Appliances Delivery - Off The Shelf Item - Backyard Drop Off - Big and Bulky Outdoor Drop Off - Big and Bulky Backyard Delivery - Big and Bulky Threshold - Big and Bulky Room of Choice - Big and Bulky WG - Fulfilled by Amazon description: The name of the actual shipping method. example: Standard Shipping carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name tracking_number: type: string description: The tracking number for the shipment. ship_date: type: string format: date-time description: The date the shipment was shipped. ship_from_address: $ref: '#/components/schemas/ShipFromAddressWayfair' required: - carrier_name - ship_from_address - shipping_method_name - tracking_number additionalProperties: false title: Wayfair CreateShipmentcartOrder--Wix--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. tracking_url: type: string description: The URL for the tracking number. example: https://www.example.com/tracking carrier_name: type: string description: The name of the carrier used to ship the order. example: Carrier Name line_items: type: array description: List of the products included in the order. example: - line_item_id: line_item_id quantity: 1 items: $ref: '#/components/schemas/CartOrderWriteLineItemwix' required: - carrier_name - tracking_number additionalProperties: false title: Wix CreateShipmentcartOrder--WooCommerce--: type: object properties: tracking_number: type: string description: The tracking number for the shipment. carrier_name: type: string description: The name of the carrier used to ship the order. enum: - An Post - Australia Post - BRT (Bartolini) - Bring.se - Canada Post - Colissimo - Correios - Courier Post - DB Schenker - DHL - DHL Express - DHL Intraship (DE) - DHL.cz - DHL.se - DPD.NL - DPD.at - DPD.co.uk - DPD.cz - DPD.de - DPD.ie - DTDC - Deutsche Post DHL - Fastway Couriers - Fastways - FedEx Sameday - Fedex - Hermes - InterLink - Itella - NZ Post - OnTrac - PBT Couriers - PPL.cz - ParcelForce - PostNL - Posten AB - Royal Mail - SAPO - TNT Express (consignment) - TNT Express (reference) - UK Mail - UPS - UPS Germany - UPS.se - USPS - dhl.at - post.at - Česká pošta example: Carrier Name tracking_url: type: string description: The URL for the tracking number. example: https://www.example.com/tracking mark_order_as_shipped: type: boolean default: true description: >- The order will be marked as shipped after the shipment is created. Defaults to true. example: true additionalProperties: false title: WooCommerce CreateCartOrderShipmentResponseDataSchema: type: object properties: id: type: string description: The unique ID of the order. example: order_id order_number: type: string description: The order number assigned by the platform. Defaults to order ID. example: order_number created_date: type: string format: date-time description: The date the order was created. example: '2022-01-01T00:00:00Z' updated_date: type: string format: date-time description: The date the order was last updated. example: '2022-01-02T05:05:05Z' status: type: string enum: - open - confirmed - processing - partially_fulfilled - fulfilled - exception - cancelled - backordered - other description: >- The status of the order. See the [order information](info) for more details. example: fulfilled raw_status: type: - string - 'null' description: The raw status (if available) returned directly from the platform. example: raw_status requested_shipping_method: type: - string - 'null' description: The type of shipping method requested by the customer. example: Standard shipping_method_id: type: - string - 'null' description: The ID of the actual shipping method. example: shipping_method_id shipping_method_name: type: - string - 'null' description: The name of the actual shipping method. example: Standard Shipping carrier_id: type: - string - 'null' description: The ID of the carrier used to ship the order. example: carrier_id carrier_name: type: - string - 'null' description: The name of the carrier used to ship the order. example: Carrier Name invoice_currency_code: type: string description: >- The currency used for this order. If not provided explicitly, defaults to USD. example: USD total_price: type: - number - 'null' description: The total price a customer paid for the order. example: 13.49 total_tax: type: - number - 'null' description: The total tax on the order. example: 1.5 total_discount: type: - number - 'null' description: The total amount discounted from the order. example: 2.5 total_shipping: type: - number - 'null' description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/ShipToAddress' bill_to_address: $ref: '#/components/schemas/BillToAddress' earliest_ship_date: type: - string - 'null' format: date-time description: The earliest date the order can be shipped. example: '2022-10-10T01:02:03Z' latest_ship_date: type: - string - 'null' format: date-time description: The latest date the order can be shipped. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of the products included in the order. example: - line_item_id: line_item_id product_id: null product_sku: null parent_product_id: null parent_product_sku: null quantity: 1 unit_price: 10.99 discount: 1.5 tax: 0.5 warehouse_id: warehouse_id items: $ref: '#/components/schemas/CartOrderLineItem' shipping_groups: type: array description: >- Sets of line items that will be fulfilled together from the same locations. Only applies in Shopify, as fulfillmentOrders. items: $ref: '#/components/schemas/CartOrderShippingGroup' shipments: type: array description: List of the shipments sent out to the customer. items: $ref: '#/components/schemas/CartOrderShipment' tags: type: array description: A list of tags associated with the order. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 external_system_url: type: - string - 'null' description: URL link to the order in the external system (WMS/Freight etc). example: https://example.com/order/123 trackstar_tags: type: - array - 'null' description: >- 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 items: {} additional_fields: type: object description: Integration-specific fields example: key: value additionalProperties: {} trackstar_created_date: type: string format: date-time description: '' trackstar_updated_date: type: string format: date-time description: '' required: - additional_fields - bill_to_address - carrier_id - carrier_name - created_date - earliest_ship_date - external_system_url - id - invoice_currency_code - latest_ship_date - line_items - order_number - raw_status - requested_shipping_method - ship_to_address - shipments - shipping_groups - shipping_method_id - shipping_method_name - status - tags - total_discount - total_price - total_shipping - total_tax - trackstar_created_date - trackstar_tags - trackstar_updated_date - updated_date additionalProperties: false title: CreateCartOrderShipmentResponseDataSchema CartOrderWriteLineItemamazon: type: object properties: product_sku: type: string description: '' sku: type: string description: Use product_sku instead. quantity: type: integer description: Quantity to ship example: 0 transparency_codes: type: array description: Amazon Transparency codes for serialized items items: type: string description: Transparency code for the item additionalProperties: false title: CartOrderWriteLineItemamazon CartOrderCreateLineItemebay: type: object properties: product_sku: type: string description: '' line_item_id: type: string description: '' quantity: type: integer description: '' example: 0 required: - product_sku additionalProperties: false title: CartOrderCreateLineItemebay CartOrderCreateLineItemmagento: type: object properties: product_sku: type: string description: '' sku: type: string description: Use product_sku instead. quantity: type: integer description: '' example: 0 required: - quantity additionalProperties: false title: CartOrderCreateLineItemmagento CartOrderWriteLineItemmirakl: type: object properties: line_item_id: type: string description: The ID of the line item in the order quantity: type: integer description: '' example: 0 required: - line_item_id - quantity additionalProperties: false title: CartOrderWriteLineItemmirakl CartOrderCreateLineItemnuorder: type: object properties: product_sku: type: string description: '' quantity: type: integer description: '' example: 0 required: - product_sku - quantity additionalProperties: false title: CartOrderCreateLineItemnuorder ShopifyCartOrderShippingGroup: type: object properties: shipping_group_id: type: string description: The ID of the shipping_group. example: shipping_group_id line_items: type: array description: >- List of the products in the shipping group. Defaults to all if not specified. items: $ref: '#/components/schemas/ShopifyCartOrderShipmentLineItem' required: - shipping_group_id additionalProperties: false title: ShopifyCartOrderShippingGroup CartOrderWriteLineItemtiktok: type: object properties: line_item_id: type: string description: The ID of the order line item to ship. quantity: type: integer enum: - 1 description: >- The quantity to ship. TikTok tracks each unit of a product as its own order line item, so this must be 1. To ship multiple units, pass each unit's line item ID. example: 1 required: - line_item_id additionalProperties: false title: CartOrderWriteLineItemtiktok CartOrderWriteLineItemwalmart: type: object properties: product_sku: type: string description: '' sku: type: string description: Use product_sku instead. quantity: type: integer description: '' example: 0 required: - quantity additionalProperties: false title: CartOrderWriteLineItemwalmart ShipFromAddressWayfair: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name additionalProperties: false title: ShipFromAddressWayfair CartOrderWriteLineItemwix: type: object properties: line_item_id: type: string description: The ID of the order line item. example: line_item_id quantity: type: integer description: Quantity to fulfill. example: 1 required: - line_item_id additionalProperties: false title: CartOrderWriteLineItemwix ShipToAddress: type: object properties: full_name: type: - string - 'null' description: '' example: John Doe company: type: - string - 'null' description: '' example: Company address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States phone_number: type: - string - 'null' description: '' example: 123-456-7890 email_address: type: - string - 'null' description: '' example: johndoe@example.com required: - address1 - address2 - address3 - city - company - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddress BillToAddress: type: object properties: full_name: type: - string - 'null' description: '' example: John Doe address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States required: - address1 - address2 - address3 - city - country - full_name - postal_code - state additionalProperties: false title: BillToAddress CartOrderLineItem: type: object properties: line_item_id: type: string description: The ID of the line item. example: line_item_id product_id: type: string description: >- The ID of the product. Can be passed into the [Cart Product](/api-reference/cart-api/products/get-item) endpoint for more details. product_sku: type: - string - 'null' description: '' parent_product_id: type: - string - 'null' description: The ID of the product's parent. parent_product_sku: type: - string - 'null' description: '' quantity: type: integer description: '' example: 1 unit_price: type: - number - 'null' description: >- The price of the product in the currency specified by `invoice_currency_code`. example: 10.99 discount: type: - number - 'null' description: >- The unit amount discounted from the product for this order. This is the amount of discount per unit of the product. example: 1.5 tax: type: - number - 'null' description: >- The unit amount of tax on the product for this order. This is the amount of tax per unit of the product example: 0.5 warehouse_id: type: - string - 'null' description: >- The warehouse this line item should ship from. Can be passed into the [Warehouse](/api-reference/cart-api/warehouses/get-item) endpoint for more details. example: warehouse_id required: - discount - line_item_id - parent_product_id - parent_product_sku - product_id - product_sku - quantity - tax - unit_price - warehouse_id additionalProperties: false title: CartOrderLineItem CartOrderShippingGroup: type: object properties: shipping_group_id: type: string description: The ID of the shipping_group. example: shipping_group_id created_date: type: string format: date-time description: The date the shipping_group was created. example: '2022-01-01T00:00:00Z' updated_date: type: string format: date-time description: The date the shipping_group was last updated. example: '2022-01-02T05:05:05Z' raw_status: type: - string - 'null' description: >- The raw status (if available) of the shipping group returned directly from the integration. example: raw_status status: type: - string - 'null' enum: - open - shipped - delivered - cancelled - exception - on_hold - other description: The status of the shipping group. example: shipped warehouse_id: type: string description: >- The ID of the warehouse that the shipping group will send from. Subject to change. example: warehouse_id line_items: type: array description: List of the products in the shipping group. items: $ref: '#/components/schemas/CartOrderShipmentGroupLineItem' required: - created_date - line_items - raw_status - shipping_group_id - status - updated_date - warehouse_id additionalProperties: false title: CartOrderShippingGroup CartOrderShipment: type: object properties: shipment_id: type: string description: The ID of the shipment. example: shipment_id raw_status: type: - string - 'null' description: >- The raw status (if available) of the shipment returned directly from the integration. example: raw_status status: type: - string - 'null' enum: - open - shipped - delivered - cancelled - exception - on_hold - other description: The status of the shipment. example: shipped warehouse_id: type: - string - 'null' description: >- The warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/cart-api/warehouses/get-item) endpoint for more details. example: warehouse_id shipping_method_id: type: - string - 'null' description: The ID of the shipping method used for the shipment. example: shipment_shipping_method_id shipping_method_name: type: - string - 'null' description: The name of the shipping method used for the shipment. example: shipment_shipping_method_name carrier_id: type: - string - 'null' description: The ID of the carrier used to ship the shipment. example: carrier_id carrier_name: type: - string - 'null' description: The name of the carrier used to ship the shipment. example: carrier_name tracking_number: type: - string - 'null' description: The tracking number for the shipment. tracking_url: type: - string - 'null' description: The URL for the tracking number. example: https://www.example.com/tracking line_items: type: array description: List of the products listed in the shipment. items: $ref: '#/components/schemas/CartOrderShipmentLineItem' shipping_groups: type: array description: >- List of the shipping groups included in the shipment. Only applies in Shopify, as fulfillmentOrders. example: - sg_id_1 - sg_id_2 items: type: string description: The ID of the shipping group included in the shipment. ship_from_address: $ref: '#/components/schemas/ShipFromAddress' created_date: type: - string - 'null' format: date-time description: The date the shipment was created. example: '2022-01-01T00:00:00Z' updated_date: type: - string - 'null' format: date-time description: The date the shipment was last updated. example: '2022-01-02T05:05:05Z' required: - carrier_id - carrier_name - created_date - line_items - raw_status - ship_from_address - shipment_id - shipping_groups - shipping_method_id - shipping_method_name - status - tracking_number - tracking_url - updated_date - warehouse_id additionalProperties: false title: CartOrderShipment ShopifyCartOrderShipmentLineItem: type: object properties: line_item_id: type: string description: The ID of the line item in the shipping group. example: shipping_group_line_item_id quantity: type: integer description: '' example: 0 required: - line_item_id - quantity additionalProperties: false title: ShopifyCartOrderShipmentLineItem CartOrderShipmentGroupLineItem: type: object properties: line_item_id: type: string description: The ID of the line item in the shipping group. example: shipping_group_line_item_id product_id: type: string description: The ID of the product. product_sku: type: - string - 'null' description: '' parent_product_id: type: - string - 'null' description: The ID of the product's parent. quantity: type: integer description: '' example: 0 required: - line_item_id - parent_product_id - product_id - product_sku - quantity additionalProperties: false title: CartOrderShipmentGroupLineItem CartOrderShipmentLineItem: type: object properties: shipment_line_item_id: type: string description: The ID of the line item in the shipment. product_id: type: string description: The ID of the product. product_sku: type: - string - 'null' description: '' parent_product_id: type: - string - 'null' description: The ID of the product's parent. parent_product_sku: type: - string - 'null' description: '' quantity: type: integer description: '' example: 0 required: - parent_product_id - parent_product_sku - product_id - product_sku - quantity - shipment_line_item_id additionalProperties: false title: CartOrderShipmentLineItem ShipFromAddress: type: object properties: address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States required: - address1 - address2 - address3 - city - country - postal_code - state additionalProperties: false title: ShipFromAddress ````