{"info":{"description":"\nTrackstar is a Unified API that provides standard endpoints for Supply Chain Logistics. We currently offer an API for Warehouse Management Systems (WMS).\n","title":"Trackstar API","version":"0.1.0"},"tags":[],"servers":[{"description":"Trackstar API","url":"https://production.trackstarhq.com"}],"externalDocs":{"description":"Trackstar API Documentation","url":"https://docs.trackstarhq.com"},"security":[],"x-webhooks":{"inventory.created":{"post":{"operationId":"webhook_inventory.created","summary":"Inventory created","description":"When an Inventory Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inventory.updated":{"post":{"operationId":"webhook_inventory.updated","summary":"Inventory updated","description":"When an Inventory Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"product.created":{"post":{"operationId":"webhook_product.created","summary":"Product created","description":"When a Kit is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsKitsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"product.updated":{"post":{"operationId":"webhook_product.updated","summary":"Product updated","description":"When a Kit is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsKitsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inbound-shipment.created":{"post":{"operationId":"webhook_inbound-shipment.created","summary":"Inbound shipment created","description":"When an Inbound Shipment is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inbound-shipment.updated":{"post":{"operationId":"webhook_inbound-shipment.updated","summary":"Inbound shipment updated","description":"When an Inbound Shipment is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inbound-shipment.receipt.created":{"post":{"operationId":"webhook_inbound-shipment.receipt.created","summary":"Inbound shipment receipt created","description":"When a receipt is created for the inbound shipment.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsReceipt.CreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"order.created":{"post":{"operationId":"webhook_order.created","summary":"Order created","description":"When an Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"order.updated":{"post":{"operationId":"webhook_order.updated","summary":"Order updated","description":"When an Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"order.shipment.created":{"post":{"operationId":"webhook_order.shipment.created","summary":"Order shipment created","description":"When a shipment is created for an order","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersShipment.CreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse.created":{"post":{"operationId":"webhook_warehouse.created","summary":"Warehouse created","description":"When a Warehouse is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehousesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse.updated":{"post":{"operationId":"webhook_warehouse.updated","summary":"Warehouse updated","description":"When a Warehouse is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehousesUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"shipping-method.created":{"post":{"operationId":"webhook_shipping-method.created","summary":"Shipping method created","description":"When a Shipping Method is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsShippingMethodsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"shipping-method.updated":{"post":{"operationId":"webhook_shipping-method.updated","summary":"Shipping method updated","description":"When a Shipping Method is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsShippingMethodsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"return.created":{"post":{"operationId":"webhook_return.created","summary":"Return created","description":"When a Return is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsReturnsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"return.updated":{"post":{"operationId":"webhook_return.updated","summary":"Return updated","description":"When a Return is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsReturnsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"bill.created":{"post":{"operationId":"webhook_bill.created","summary":"Bill created","description":"When a Bill is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsBillsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"bill.updated":{"post":{"operationId":"webhook_bill.updated","summary":"Bill updated","description":"When a Bill is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsBillsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-customer.created":{"post":{"operationId":"webhook_warehouse-customer.created","summary":"Warehouse customer created","description":"When a Warehouse Customer is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseCustomersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-customer.updated":{"post":{"operationId":"webhook_warehouse-customer.updated","summary":"Warehouse customer updated","description":"When a Warehouse Customer is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseCustomersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-location.created":{"post":{"operationId":"webhook_warehouse-location.created","summary":"Warehouse location created","description":"When a Warehouse Location is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseLocationsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-location.updated":{"post":{"operationId":"webhook_warehouse-location.updated","summary":"Warehouse location updated","description":"When a Warehouse Location is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseLocationsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inventory_ledger.created":{"post":{"operationId":"webhook_inventory_ledger.created","summary":"Inventory_ledger created","description":"When an Inventory Ledger is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryLedgerCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inventory_ledger.updated":{"post":{"operationId":"webhook_inventory_ledger.updated","summary":"Inventory_ledger updated","description":"When an Inventory Ledger is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryLedgerUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"freight-shipment.created":{"post":{"operationId":"webhook_freight-shipment.created","summary":"Freight shipment created","description":"When a Shipment is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightShipmentsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"freight-shipment.updated":{"post":{"operationId":"webhook_freight-shipment.updated","summary":"Freight shipment updated","description":"When a Shipment is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightShipmentsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-warehouse.created":{"post":{"operationId":"webhook_cart-warehouse.created","summary":"Cart warehouse created","description":"When a Warehouse is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartWarehousesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-warehouse.updated":{"post":{"operationId":"webhook_cart-warehouse.updated","summary":"Cart warehouse updated","description":"When a Warehouse is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartWarehousesUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-product.created":{"post":{"operationId":"webhook_cart-product.created","summary":"Cart product created","description":"When a Product is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProductsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-product.updated":{"post":{"operationId":"webhook_cart-product.updated","summary":"Cart product updated","description":"When a Product is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProductsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-order.created":{"post":{"operationId":"webhook_cart-order.created","summary":"Cart order created","description":"When an Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-order.updated":{"post":{"operationId":"webhook_cart-order.updated","summary":"Cart order updated","description":"When an Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-order.cart-shipment.created":{"post":{"operationId":"webhook_cart-order.cart-shipment.created","summary":"Cart order cart shipment created","description":"When a shipment is created for an order","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersCart-Shipment.CreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"carrier-invoice-line-item.created":{"post":{"operationId":"webhook_carrier-invoice-line-item.created","summary":"Carrier invoice line item created","description":"When an Invoice Line Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"carrier-invoice-line-item.updated":{"post":{"operationId":"webhook_carrier-invoice-line-item.updated","summary":"Carrier invoice line item updated","description":"When an Invoice Line Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"carrier-file.created":{"post":{"operationId":"webhook_carrier-file.created","summary":"Carrier file created","description":"When a new raw file (CSV, PDF, etc.) from the carrier is available to download.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierFilesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-inventory.created":{"post":{"operationId":"webhook_erp-inventory.created","summary":"Erp inventory created","description":"When an Inventory Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpInventoryCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-inventory.updated":{"post":{"operationId":"webhook_erp-inventory.updated","summary":"Erp inventory updated","description":"When an Inventory Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpInventoryUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order.created":{"post":{"operationId":"webhook_erp-sales-order.created","summary":"Erp sales order created","description":"When a Sales Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order.updated":{"post":{"operationId":"webhook_erp-sales-order.updated","summary":"Erp sales order updated","description":"When a Sales Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order-shipment.created":{"post":{"operationId":"webhook_erp-sales-order-shipment.created","summary":"Erp sales order shipment created","description":"When a Sales Order Shipment is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order-shipment.updated":{"post":{"operationId":"webhook_erp-sales-order-shipment.updated","summary":"Erp sales order shipment updated","description":"When a Sales Order Shipment is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-location.created":{"post":{"operationId":"webhook_erp-location.created","summary":"Erp location created","description":"When a Location is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpLocationsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-location.updated":{"post":{"operationId":"webhook_erp-location.updated","summary":"Erp location updated","description":"When a Location is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpLocationsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-item.created":{"post":{"operationId":"webhook_erp-item.created","summary":"Erp item created","description":"When an Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpItemsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-item.updated":{"post":{"operationId":"webhook_erp-item.updated","summary":"Erp item updated","description":"When an Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpItemsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-customer.created":{"post":{"operationId":"webhook_erp-customer.created","summary":"Erp customer created","description":"When a Customer is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpCustomersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-customer.updated":{"post":{"operationId":"webhook_erp-customer.updated","summary":"Erp customer updated","description":"When a Customer is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpCustomersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-vendor.created":{"post":{"operationId":"webhook_erp-vendor.created","summary":"Erp vendor created","description":"When a Vendor is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpVendorsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-vendor.updated":{"post":{"operationId":"webhook_erp-vendor.updated","summary":"Erp vendor updated","description":"When a Vendor is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpVendorsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-employee.created":{"post":{"operationId":"webhook_erp-employee.created","summary":"Erp employee created","description":"When an Employee is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpEmployeesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-employee.updated":{"post":{"operationId":"webhook_erp-employee.updated","summary":"Erp employee updated","description":"When an Employee is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpEmployeesUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order.created":{"post":{"operationId":"webhook_erp-purchase-order.created","summary":"Erp purchase order created","description":"When a Purchase Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order.updated":{"post":{"operationId":"webhook_erp-purchase-order.updated","summary":"Erp purchase order updated","description":"When a Purchase Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order-receipt.created":{"post":{"operationId":"webhook_erp-purchase-order-receipt.created","summary":"Erp purchase order receipt created","description":"When a Purchase Order Receipt is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order-receipt.updated":{"post":{"operationId":"webhook_erp-purchase-order-receipt.updated","summary":"Erp purchase order receipt updated","description":"When a Purchase Order Receipt is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection-error.created":{"post":{"operationId":"webhook_connection-error.created","summary":"Connection error created","description":"When a Connection Error is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionErrorsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection-error.updated":{"post":{"operationId":"webhook_connection-error.updated","summary":"Connection error updated","description":"When a Connection Error is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionErrorsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection-error.deleted":{"post":{"operationId":"webhook_connection-error.deleted","summary":"Connection error deleted","description":"When a Connection Error is resolved.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionErrorsDeletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.created":{"post":{"operationId":"webhook_connection.created","summary":"Connection created","description":"When a Connection is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.deleted":{"post":{"operationId":"webhook_connection.deleted","summary":"Connection deleted","description":"When a Connection is deleted.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsDeletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.historical-sync-completed":{"post":{"operationId":"webhook_connection.historical-sync-completed","summary":"Connection historical sync completed","description":"Triggered when historical sync for a resource (orders, inventory, etc.) completes.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsHistorical-Sync-CompletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.sync-job-completed":{"post":{"operationId":"webhook_connection.sync-job-completed","summary":"Connection sync job completed","description":"Triggered when a sync job completes for a connection.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-CompletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.force-sync-completed":{"post":{"operationId":"webhook_connection.force-sync-completed","summary":"Connection force sync completed","description":"Triggered when a force sync (manually triggered via the sync endpoint) completes for a resource (orders, inventory, etc.).","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsForce-Sync-CompletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.sync-job-stuck":{"post":{"operationId":"webhook_connection.sync-job-stuck","summary":"Connection sync job stuck","description":"Triggered when Trackstar has determined that a sync job is stuck and will not progress.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-StuckWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.schedule-stuck":{"post":{"operationId":"webhook_connection.schedule-stuck","summary":"Connection schedule stuck","description":"Triggered when Trackstar has determined that a resource's regular sync is stuck and has stopped making progress.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsSchedule-StuckWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"install.failed":{"post":{"operationId":"webhook_install.failed","summary":"Install failed","description":"When a customer's attempt to connect an integration fails before a connection is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralFailedInstallsFailedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}}},"webhooks":{"inventory.created":{"post":{"operationId":"webhook_inventory.created","summary":"Inventory created","description":"When an Inventory Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inventory.updated":{"post":{"operationId":"webhook_inventory.updated","summary":"Inventory updated","description":"When an Inventory Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"product.created":{"post":{"operationId":"webhook_product.created","summary":"Product created","description":"When a Kit is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsKitsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"product.updated":{"post":{"operationId":"webhook_product.updated","summary":"Product updated","description":"When a Kit is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsKitsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inbound-shipment.created":{"post":{"operationId":"webhook_inbound-shipment.created","summary":"Inbound shipment created","description":"When an Inbound Shipment is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inbound-shipment.updated":{"post":{"operationId":"webhook_inbound-shipment.updated","summary":"Inbound shipment updated","description":"When an Inbound Shipment is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inbound-shipment.receipt.created":{"post":{"operationId":"webhook_inbound-shipment.receipt.created","summary":"Inbound shipment receipt created","description":"When a receipt is created for the inbound shipment.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsReceipt.CreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"order.created":{"post":{"operationId":"webhook_order.created","summary":"Order created","description":"When an Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"order.updated":{"post":{"operationId":"webhook_order.updated","summary":"Order updated","description":"When an Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"order.shipment.created":{"post":{"operationId":"webhook_order.shipment.created","summary":"Order shipment created","description":"When a shipment is created for an order","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersShipment.CreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse.created":{"post":{"operationId":"webhook_warehouse.created","summary":"Warehouse created","description":"When a Warehouse is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehousesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse.updated":{"post":{"operationId":"webhook_warehouse.updated","summary":"Warehouse updated","description":"When a Warehouse is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehousesUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"shipping-method.created":{"post":{"operationId":"webhook_shipping-method.created","summary":"Shipping method created","description":"When a Shipping Method is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsShippingMethodsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"shipping-method.updated":{"post":{"operationId":"webhook_shipping-method.updated","summary":"Shipping method updated","description":"When a Shipping Method is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsShippingMethodsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"return.created":{"post":{"operationId":"webhook_return.created","summary":"Return created","description":"When a Return is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsReturnsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"return.updated":{"post":{"operationId":"webhook_return.updated","summary":"Return updated","description":"When a Return is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsReturnsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"bill.created":{"post":{"operationId":"webhook_bill.created","summary":"Bill created","description":"When a Bill is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsBillsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"bill.updated":{"post":{"operationId":"webhook_bill.updated","summary":"Bill updated","description":"When a Bill is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsBillsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-customer.created":{"post":{"operationId":"webhook_warehouse-customer.created","summary":"Warehouse customer created","description":"When a Warehouse Customer is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseCustomersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-customer.updated":{"post":{"operationId":"webhook_warehouse-customer.updated","summary":"Warehouse customer updated","description":"When a Warehouse Customer is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseCustomersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-location.created":{"post":{"operationId":"webhook_warehouse-location.created","summary":"Warehouse location created","description":"When a Warehouse Location is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseLocationsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"warehouse-location.updated":{"post":{"operationId":"webhook_warehouse-location.updated","summary":"Warehouse location updated","description":"When a Warehouse Location is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseLocationsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inventory_ledger.created":{"post":{"operationId":"webhook_inventory_ledger.created","summary":"Inventory_ledger created","description":"When an Inventory Ledger is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryLedgerCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"inventory_ledger.updated":{"post":{"operationId":"webhook_inventory_ledger.updated","summary":"Inventory_ledger updated","description":"When an Inventory Ledger is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryLedgerUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"freight-shipment.created":{"post":{"operationId":"webhook_freight-shipment.created","summary":"Freight shipment created","description":"When a Shipment is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightShipmentsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"freight-shipment.updated":{"post":{"operationId":"webhook_freight-shipment.updated","summary":"Freight shipment updated","description":"When a Shipment is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightShipmentsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-warehouse.created":{"post":{"operationId":"webhook_cart-warehouse.created","summary":"Cart warehouse created","description":"When a Warehouse is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartWarehousesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-warehouse.updated":{"post":{"operationId":"webhook_cart-warehouse.updated","summary":"Cart warehouse updated","description":"When a Warehouse is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartWarehousesUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-product.created":{"post":{"operationId":"webhook_cart-product.created","summary":"Cart product created","description":"When a Product is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProductsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-product.updated":{"post":{"operationId":"webhook_cart-product.updated","summary":"Cart product updated","description":"When a Product is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProductsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-order.created":{"post":{"operationId":"webhook_cart-order.created","summary":"Cart order created","description":"When an Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-order.updated":{"post":{"operationId":"webhook_cart-order.updated","summary":"Cart order updated","description":"When an Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"cart-order.cart-shipment.created":{"post":{"operationId":"webhook_cart-order.cart-shipment.created","summary":"Cart order cart shipment created","description":"When a shipment is created for an order","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersCart-Shipment.CreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"carrier-invoice-line-item.created":{"post":{"operationId":"webhook_carrier-invoice-line-item.created","summary":"Carrier invoice line item created","description":"When an Invoice Line Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"carrier-invoice-line-item.updated":{"post":{"operationId":"webhook_carrier-invoice-line-item.updated","summary":"Carrier invoice line item updated","description":"When an Invoice Line Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"carrier-file.created":{"post":{"operationId":"webhook_carrier-file.created","summary":"Carrier file created","description":"When a new raw file (CSV, PDF, etc.) from the carrier is available to download.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierFilesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-inventory.created":{"post":{"operationId":"webhook_erp-inventory.created","summary":"Erp inventory created","description":"When an Inventory Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpInventoryCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-inventory.updated":{"post":{"operationId":"webhook_erp-inventory.updated","summary":"Erp inventory updated","description":"When an Inventory Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpInventoryUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order.created":{"post":{"operationId":"webhook_erp-sales-order.created","summary":"Erp sales order created","description":"When a Sales Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order.updated":{"post":{"operationId":"webhook_erp-sales-order.updated","summary":"Erp sales order updated","description":"When a Sales Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order-shipment.created":{"post":{"operationId":"webhook_erp-sales-order-shipment.created","summary":"Erp sales order shipment created","description":"When a Sales Order Shipment is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-sales-order-shipment.updated":{"post":{"operationId":"webhook_erp-sales-order-shipment.updated","summary":"Erp sales order shipment updated","description":"When a Sales Order Shipment is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-location.created":{"post":{"operationId":"webhook_erp-location.created","summary":"Erp location created","description":"When a Location is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpLocationsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-location.updated":{"post":{"operationId":"webhook_erp-location.updated","summary":"Erp location updated","description":"When a Location is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpLocationsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-item.created":{"post":{"operationId":"webhook_erp-item.created","summary":"Erp item created","description":"When an Item is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpItemsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-item.updated":{"post":{"operationId":"webhook_erp-item.updated","summary":"Erp item updated","description":"When an Item is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpItemsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-customer.created":{"post":{"operationId":"webhook_erp-customer.created","summary":"Erp customer created","description":"When a Customer is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpCustomersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-customer.updated":{"post":{"operationId":"webhook_erp-customer.updated","summary":"Erp customer updated","description":"When a Customer is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpCustomersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-vendor.created":{"post":{"operationId":"webhook_erp-vendor.created","summary":"Erp vendor created","description":"When a Vendor is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpVendorsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-vendor.updated":{"post":{"operationId":"webhook_erp-vendor.updated","summary":"Erp vendor updated","description":"When a Vendor is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpVendorsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-employee.created":{"post":{"operationId":"webhook_erp-employee.created","summary":"Erp employee created","description":"When an Employee is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpEmployeesCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-employee.updated":{"post":{"operationId":"webhook_erp-employee.updated","summary":"Erp employee updated","description":"When an Employee is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpEmployeesUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order.created":{"post":{"operationId":"webhook_erp-purchase-order.created","summary":"Erp purchase order created","description":"When a Purchase Order is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrdersCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order.updated":{"post":{"operationId":"webhook_erp-purchase-order.updated","summary":"Erp purchase order updated","description":"When a Purchase Order is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrdersUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order-receipt.created":{"post":{"operationId":"webhook_erp-purchase-order-receipt.created","summary":"Erp purchase order receipt created","description":"When a Purchase Order Receipt is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"erp-purchase-order-receipt.updated":{"post":{"operationId":"webhook_erp-purchase-order-receipt.updated","summary":"Erp purchase order receipt updated","description":"When a Purchase Order Receipt is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection-error.created":{"post":{"operationId":"webhook_connection-error.created","summary":"Connection error created","description":"When a Connection Error is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionErrorsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection-error.updated":{"post":{"operationId":"webhook_connection-error.updated","summary":"Connection error updated","description":"When a Connection Error is updated.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionErrorsUpdatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection-error.deleted":{"post":{"operationId":"webhook_connection-error.deleted","summary":"Connection error deleted","description":"When a Connection Error is resolved.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionErrorsDeletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.created":{"post":{"operationId":"webhook_connection.created","summary":"Connection created","description":"When a Connection is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsCreatedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.deleted":{"post":{"operationId":"webhook_connection.deleted","summary":"Connection deleted","description":"When a Connection is deleted.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsDeletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.historical-sync-completed":{"post":{"operationId":"webhook_connection.historical-sync-completed","summary":"Connection historical sync completed","description":"Triggered when historical sync for a resource (orders, inventory, etc.) completes.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsHistorical-Sync-CompletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.sync-job-completed":{"post":{"operationId":"webhook_connection.sync-job-completed","summary":"Connection sync job completed","description":"Triggered when a sync job completes for a connection.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-CompletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.force-sync-completed":{"post":{"operationId":"webhook_connection.force-sync-completed","summary":"Connection force sync completed","description":"Triggered when a force sync (manually triggered via the sync endpoint) completes for a resource (orders, inventory, etc.).","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsForce-Sync-CompletedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.sync-job-stuck":{"post":{"operationId":"webhook_connection.sync-job-stuck","summary":"Connection sync job stuck","description":"Triggered when Trackstar has determined that a sync job is stuck and will not progress.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-StuckWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"connection.schedule-stuck":{"post":{"operationId":"webhook_connection.schedule-stuck","summary":"Connection schedule stuck","description":"Triggered when Trackstar has determined that a resource's regular sync is stuck and has stopped making progress.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralConnectionsSchedule-StuckWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}},"install.failed":{"post":{"operationId":"webhook_install.failed","summary":"Install failed","description":"When a customer's attempt to connect an integration fails before a connection is created.","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralFailedInstallsFailedWebhookSchema"}}}},"responses":{"200":{"description":"Success"}}}}},"paths":{"/events":{"get":{"parameters":[{"in":"query","name":"integration_name","description":"Filter events by integration name.","schema":{"type":["string","null"],"example":"shipbob"},"required":false},{"in":"query","name":"integration_type","description":"Filter events by integration type.","schema":{"type":["string","null"],"example":"wms"},"required":false},{"in":"query","name":"connection_id","description":"Filter events by connection id.","schema":{"type":["string","null"],"example":"07b344db-0304-4866-9ae1-ac8af5292a28"},"required":false},{"in":"query","name":"customer_id","description":"An identifier for your end customer.","schema":{"type":["string","null"],"example":"customer_id"},"required":false},{"in":"query","name":"type","description":"Filter events by type.","schema":{"type":["string","null"],"enum":["install_failed","connection_error","schedule_stuck","schedule_unstuck","on_demand_sync_stuck","connection_created","connection_reinstalled","connection_deleted","connection_disabled","connection_enabled","schedule_paused","schedule_unpaused","on_demand_sync_started","on_demand_sync_completed","on_demand_sync_cancelled","historical_sync_completed"],"example":"install_failed"},"required":false},{"in":"query","name":"start_date","description":"Only return events at or after this time (ISO 8601).","schema":{"type":"string","format":"date-time","example":"2024-01-01T00:00:00Z"},"required":true},{"in":"query","name":"end_date","description":"Only return events at or before this time (ISO 8601).","schema":{"type":["string","null"],"format":"date-time","example":"2024-01-31T23:59:59Z"},"required":false},{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Events"],"summary":"Get Events","description":"Returns a feed of events for your organization, newest first: failed\ninstalls, connection lifecycle changes, sync activity, and schedule state\nchanges. Narrow the feed with the integration, connection, customer, event\ntype, and time filters. A start_date is required.","operationId":"get_GET__events"}},"/api-logs":{"get":{"parameters":[{"in":"query","name":"start_date","description":"Only return requests received at or after this time. Cannot be more than 180 days ago, which is how long we retain logs.","schema":{"type":"string","format":"date-time","example":"2024-01-15T00:00:00Z"},"required":true},{"in":"query","name":"end_date","description":"Only return requests received at or before this time. Defaults to now.","schema":{"type":"string","format":"date-time","example":"2024-01-16T00:00:00Z"},"required":false},{"in":"query","name":"connection_id","description":"Only return requests made against this connection.","schema":{"type":"string","example":"abc123def456abc123def456abc123de"},"required":false},{"in":"query","name":"integration_name","description":"Only return requests made against connections to this integration. The same name can exist across types, so pair it with `integration_type` to disambiguate.","schema":{"type":"string","enum":["active-ants","adp","amazon","amphora","amplifier","ams","amware","atomix","bdi","bergen","best-inc","bigblue","bigcommerce","bleckmann","bluebox","boxzooka","byrd","camelot","canary7","capacity","carton-cloud","cin7-omni","cirro","clarus","controlport","crafty","cwr","cybership","dart","darwynn-fulfillment","davinci","dcl","dear-systems","delmarcargo","deposco","dhl-ecom","dhl-express","distribution-alternatives","distribution-management","dotcom-distribution","douyin","dpd","ebay","elite-ops","emerson","eshipping","etsy","evolve","excelsior","extensiv-3pl-central","fabfitfun","faire","fba","fedex","fedex-fulfillment","ffe","finale","flat-fee-shipping","flexport","florisoft","flowspace","forceget","fulfil","fulfillment","fulfillment-lab","fulfillor","fulfilmentcrowd","fullgood-fulfillment","g-global","geodis","gobolt","greenmark","groupon","helm-wms","hive","i-fulfilment","icreate","ilg","infoplus","itshere","jas","jaygroup","jazz-central","joor","landmark","leanafy","leanware","lineage","linnall","linnworks","logicpod","logiwa","logiwa-io","longtail","luminous","luxroutage","mabang","magento","mai","mainfreight","masonhub","mayple","mintsoft","mirakl","mochila-fulfillment","moda-express","monta","netsuite","next3pl","nextsmartship","nfi","nimble","nlrp","npfulfilment","nri","nuorder","oia-global","omnitrans","ongoing","orderdesk","orderflow","orderwise","osa-commerce","overstock","packem","packiyo","pattern","peoplevox","picqer","pimento","podfoods","portless","postnord","pulpo","qls","quiet","return-helper","rithum-home-depot","rjw","royal-mail","rs-logistics","rush-order","salesupply","sandbox","sg-spedition","shipbob","shipedge","shipfusion","shiphero","shipmonk","shipnetwork","shipoffers","shipout","shipping-and-handling","shipping-tree","shippingbo","shipsidekick","shipstation","shipstream","shipwire","shopify","skladon","skulabs","skusavvy","skuvault","smart-warehousing","smartpack","snapfulfil","sojo","souko","squarespace","star","states-logistics","stock-and-trace","stockhub","stord","stylux","teamship","teapplix","techship","thg-ingenuity-fulfil","tiktok","tlogistics","tps","tradepeg","unis","unleashed","ups","usps","veeqo","veracore","vertical-cold","vox","walmart","warehance","warehouseos","wayfair","whiplash","wineshipping","wix","woocommerce","xorosoft","zenventory","zoho"],"example":"shipbob"},"required":false},{"in":"query","name":"integration_type","description":"Only return requests made against connections of this integration type.","schema":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"example":"wms"},"required":false},{"in":"query","name":"request_method","description":"Only return requests made with this HTTP method.","schema":{"type":"string","enum":["GET","POST","PUT","DELETE","PATCH","HEAD","OPTIONS"],"example":"GET"},"required":false},{"in":"query","name":"request_path","description":"Only return requests made to this endpoint. Path parameters are replaced with ``, so a request to `/wms/orders/123` is stored as `/wms/orders/`.","schema":{"type":"string","example":"/wms/orders"},"required":false},{"in":"query","name":"status_code","description":"Only return requests that returned this HTTP status code.","schema":{"type":"integer","example":200},"required":false},{"in":"query","name":"limit","description":"The maximum number of requests to return per page. The default is 100. Minimum 1 and maximum 5000. Fewer may be returned if the page would be too large, in which case a `next_token` is included.","schema":{"type":"integer","default":100,"minimum":1,"maximum":5000,"example":100},"required":false},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":"string","example":"page_token"},"required":false},{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APILogsResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Get API Logs","description":"Returns the API requests your organization made to Trackstar, most recent first. Filter by connection, integration, date range, request path, method, or status.","operationId":"get_search_api_logs"}},"/wms/kits":{"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateKitResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Kits"],"summary":"Create a Kit Product","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_kit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsKitInputSchema"}}}}}},"/erp/items":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpItemIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpItemCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpItemUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpItemTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpItemTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpItemTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"sku","description":"The SKU of the item.","schema":{"$ref":"#/components/schemas/ErpItemSkuQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpItemsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Items"],"summary":"Get All ERP Items","description":"Returns all Items for the ERP connection associated with the provided access token.\nItems is the parent table over Inventory; check `item_type` to know whether the same id resolves at /erp/inventory.","operationId":"get_erp_get_items"}},"/link/token":{"post":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkTokenResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Create Link Token","description":"Creates a temporary link token that is required to initiate the `react-trackstar-link` component.\nSee the [Getting Started guide](/how-to-guides/getting-started) for more details.","operationId":"post_POST__link_token","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkTokenInputSchema"}}}}}},"/wms/orders":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsOrderIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsOrderCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsOrderUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsOrderTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsOrderTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/WmsOrderTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"status","description":"The status of the order. See the [order information](info) for more details.","schema":{"$ref":"#/components/schemas/WmsOrderStatusQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsOrderWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"type","description":"The type of order: d2c, b2b, dropship, or transfer.","schema":{"$ref":"#/components/schemas/WmsOrderTypeQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"order_number","description":"A user-friendly identifier for the order.","schema":{"$ref":"#/components/schemas/WmsOrderOrder_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"reference_id","description":"An external unique identifier for the order.","schema":{"$ref":"#/components/schemas/WmsOrderReference_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"required_ship_date","description":"The date the order must be shipped by. Same syntax as created_date/updated_date.","schema":{"$ref":"#/components/schemas/WmsOrderRequired_Ship_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"tags","description":"Filter orders by their tags","schema":{"$ref":"#/components/schemas/WmsOrderTagsQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Orders"],"summary":"Get All Orders","description":"Returns all Orders for the WMS connection associated with the provided access token.","operationId":"get_wms_get_orders"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Orders"],"summary":"Create Order","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsOrderInputSchema"}}}}}},"/magic-links":{"get":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MagicLinksResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Get Magic Links","description":"Get a list of all Magic Links for your organization.","operationId":"get_get_magic_links_external"},"post":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MagicLinkResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Create Magic Link","description":"Create a Magic Link to allow users to connect their integrations via a temporary link.","operationId":"post_create_magic_link_external","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MagicLinkInputSchema"}}}}}},"/connections":{"get":{"parameters":[{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConnectionsResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Get Connections","description":"Returns connected integrations for your organization.","operationId":"get_GET__connections"},"patch":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Update Connection","description":"Manually update properties of the connection associated with your access token.","operationId":"patch_update_connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionSchema"}}}}},"delete":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConnectionResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Delete Connection","description":"Deletes the connection associated with your access token.","operationId":"delete_delete_connection"}},"/wms/returns":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsReturnIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsReturnCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsReturnUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsReturnTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsReturnTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/WmsReturnTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"status","description":"The status of the return. See the [return information](info) for more details.","schema":{"$ref":"#/components/schemas/WmsReturnStatusQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsReturnWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"order_id","description":"The ID of the order that the return is associated with.","schema":{"$ref":"#/components/schemas/WmsReturnOrder_IdQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsReturnsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Returns"],"summary":"Get All Returns","description":"Returns all Returns for the WMS connection associated with the provided access token.","operationId":"get_wms_get_returns"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateReturnResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Returns"],"summary":"Create Return","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_return","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsReturnInputSchema"}}}}}},"/wms/billing":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsBillIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsBillCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsBillUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsBillTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsBillTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsBillWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsBillsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Bills"],"summary":"Get All Bills","description":"Returns all Bills for the WMS connection associated with the provided access token.","operationId":"get_wms_get_bills"}},"/cart/orders":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/CartOrderIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/CartOrderCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartOrderUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartOrderTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartOrderTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/CartOrderTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"status","description":"The status of the order. See the [order information](info) for more details.","schema":{"$ref":"#/components/schemas/CartOrderStatusQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"order_number","description":"A user-friendly identifier for the order","schema":{"$ref":"#/components/schemas/CartOrderOrder_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"tags","description":"Filter orders by their tags","schema":{"$ref":"#/components/schemas/CartOrderTagsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"skus","description":"Filter orders by the SKUs in the line items","schema":{"$ref":"#/components/schemas/CartOrderSkusQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_ids","description":"Only available for Shopify. Filter orders by the warehouse IDs of the shipping groups.","schema":{"$ref":"#/components/schemas/CartOrderWarehouse_IdsQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["cart","Orders"],"summary":"Get All Cart Orders","description":"Returns all Orders for the Cart connection associated with the provided access token.","operationId":"get_cart_get_orders"}},"/erp/vendors":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpVendorIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpVendorCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpVendorUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpVendorTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpVendorTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpVendorTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"vendor_number","description":"The user-facing identifier of the vendor.","schema":{"$ref":"#/components/schemas/ErpVendorVendor_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"name","description":"Display name of the vendor.","schema":{"$ref":"#/components/schemas/ErpVendorNameQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"email","description":"Primary email address on the vendor.","schema":{"$ref":"#/components/schemas/ErpVendorEmailQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpVendorsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Vendors"],"summary":"Get All ERP Vendors","description":"Returns all Vendors for the ERP connection associated with the provided access token.","operationId":"get_erp_get_vendors"}},"/wms/products":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsProductIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsProductCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsProductUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsProductTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsProductTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/WmsProductTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsProductWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"sku","description":"The SKU of the product.","schema":{"$ref":"#/components/schemas/WmsProductSkuQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsProductsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Products"],"summary":"Get All Products","description":"Returns all Products for the WMS connection associated with the provided access token.","operationId":"get_wms_get_products"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateProductResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Products"],"summary":"Create Product","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_product","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsProductInputSchema"}}}}}},"/link/exchange":{"post":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeResponseShipbob"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Exchange Auth Code","description":"Exchanges a temporary authorization code for a permanent access token.\nSee the [Getting Started guide](/how-to-guides/getting-started) for more details.","operationId":"post_POST__link_exchange","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeInputSchema"}}}}}},"/wms/inventory":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsInventoryItemIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsInventoryItemCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInventoryItemUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInventoryItemTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInventoryItemTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/WmsInventoryItemTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsInventoryItemWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"sku","description":"The SKU of the inventory item.","schema":{"$ref":"#/components/schemas/WmsInventoryItemSkuQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"active","description":"Whether or not the inventory item is active.","schema":{"type":"boolean","example":true},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Inventory"],"summary":"Get All Inventory Items","description":"Returns all Inventory for the WMS connection associated with the provided access token.","operationId":"get_wms_get_inventory"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateInventoryItemResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Inventory"],"summary":"Create Inventory Item","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_inventory_item","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsInventoryItemInputSchema"}}}}}},"/carrier/files":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/CarrierFileIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/CarrierFileCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CarrierFileUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CarrierFileTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CarrierFileTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"file_name","description":"Filter by file name (matches names containing the value).","schema":{"$ref":"#/components/schemas/CarrierFileFile_NameQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"file_type","description":"Filter by the file extension.","schema":{"$ref":"#/components/schemas/CarrierFileFile_TypeQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"start_time","description":"Deprecated: use created_date[gte] instead.","schema":{"type":"string","format":"date-time","example":"2023-03-15T13:45:30Z"},"required":false},{"in":"query","name":"end_time","description":"Deprecated: use created_date[lte] instead.","schema":{"type":"string","format":"date-time","example":"2023-03-15T13:45:30Z"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierFilesListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["carrier","Files"],"summary":"List Carrier Files","description":"Returns raw invoice files (CSV, PDF, etc.) from the carrier connection, each with\na presigned download URL. Filter with created_date to select a time range.\nSubscribe to the carrier-file.created webhook to be notified when a new file is\navailable, then fetch that file from /carrier/files/{id} for a fresh URL instead\nof polling.","operationId":"get_carrier_get_files"}},"/cart/products":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/CartProductIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/CartProductCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartProductUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartProductTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartProductTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/CartProductTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"sku","description":"The SKU of the product.","schema":{"$ref":"#/components/schemas/CartProductSkuQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProductsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["cart","Products"],"summary":"Get All Cart Products","description":"Returns all Products for the Cart connection associated with the provided access token.","operationId":"get_cart_get_products"}},"/erp/inventory":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpInventoryItemIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpInventoryItemCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpInventoryItemUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpInventoryItemTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpInventoryItemTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpInventoryItemTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"sku","description":"The SKU of the inventory item.","schema":{"$ref":"#/components/schemas/ErpInventoryItemSkuQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"active","description":"Whether or not the inventory item is active.","schema":{"type":"boolean","example":true},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpInventoryListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Inventory"],"summary":"Get All ERP Inventory Items","description":"Returns all Inventory Items for the ERP connection associated with the provided access token.","operationId":"get_erp_get_inventory"}},"/erp/locations":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpLocationIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpLocationCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpLocationUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpLocationTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpLocationTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpLocationTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"name","description":"The name of the location.","schema":{"$ref":"#/components/schemas/ErpLocationNameQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"code","description":"The location code.","schema":{"$ref":"#/components/schemas/ErpLocationCodeQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpLocationsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Locations"],"summary":"Get All ERP Locations","description":"Returns all Locations for the ERP connection associated with the provided access token.","operationId":"get_erp_get_locations"}},"/erp/customers":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpCustomerIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpCustomerCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpCustomerUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpCustomerTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpCustomerTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpCustomerTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"customer_number","description":"The user-facing identifier of the customer.","schema":{"$ref":"#/components/schemas/ErpCustomerCustomer_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"name","description":"Display name of the customer.","schema":{"$ref":"#/components/schemas/ErpCustomerNameQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"email","description":"Primary email address on the customer.","schema":{"$ref":"#/components/schemas/ErpCustomerEmailQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpCustomersListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Customers"],"summary":"Get All ERP Customers","description":"Returns all Customers for the ERP connection associated with the provided access token.","operationId":"get_erp_get_customers"}},"/erp/employees":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpEmployeeIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpEmployeeCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpEmployeeUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpEmployeeTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpEmployeeTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpEmployeeTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"employee_number","description":"The user-facing identifier of the employee.","schema":{"$ref":"#/components/schemas/ErpEmployeeEmployee_NumberQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpEmployeesListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Employees"],"summary":"Get All ERP Employees","description":"Returns all Employees for the ERP connection associated with the provided access token.","operationId":"get_erp_get_employees"}},"/wms/warehouses":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsWarehouseIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsWarehouseCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/WmsWarehouseTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"name","description":"The name of the warehouse.","schema":{"$ref":"#/components/schemas/WmsWarehouseNameQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"code","description":"The warehouse code.","schema":{"$ref":"#/components/schemas/WmsWarehouseCodeQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehousesListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Warehouses"],"summary":"Get All Warehouses","description":"Returns all Warehouses for the WMS connection associated with the provided access token.","operationId":"get_wms_get_warehouses"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateWarehouseResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Warehouses"],"summary":"Create Warehouse","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_warehouse","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsWarehouseInputSchema"}}}}}},"/api-logs/facets":{"get":{"parameters":[{"in":"query","name":"start_date","description":"Only return requests received at or after this time. Cannot be more than 180 days ago, which is how long we retain logs.","schema":{"type":"string","format":"date-time","example":"2024-01-15T00:00:00Z"},"required":true},{"in":"query","name":"end_date","description":"Only return requests received at or before this time. Defaults to now.","schema":{"type":"string","format":"date-time","example":"2024-01-16T00:00:00Z"},"required":false},{"in":"query","name":"connection_id","description":"Only return requests made against this connection.","schema":{"type":"string","example":"abc123def456abc123def456abc123de"},"required":false},{"in":"query","name":"integration_name","description":"Only return requests made against connections to this integration. The same name can exist across types, so pair it with `integration_type` to disambiguate.","schema":{"type":"string","enum":["active-ants","adp","amazon","amphora","amplifier","ams","amware","atomix","bdi","bergen","best-inc","bigblue","bigcommerce","bleckmann","bluebox","boxzooka","byrd","camelot","canary7","capacity","carton-cloud","cin7-omni","cirro","clarus","controlport","crafty","cwr","cybership","dart","darwynn-fulfillment","davinci","dcl","dear-systems","delmarcargo","deposco","dhl-ecom","dhl-express","distribution-alternatives","distribution-management","dotcom-distribution","douyin","dpd","ebay","elite-ops","emerson","eshipping","etsy","evolve","excelsior","extensiv-3pl-central","fabfitfun","faire","fba","fedex","fedex-fulfillment","ffe","finale","flat-fee-shipping","flexport","florisoft","flowspace","forceget","fulfil","fulfillment","fulfillment-lab","fulfillor","fulfilmentcrowd","fullgood-fulfillment","g-global","geodis","gobolt","greenmark","groupon","helm-wms","hive","i-fulfilment","icreate","ilg","infoplus","itshere","jas","jaygroup","jazz-central","joor","landmark","leanafy","leanware","lineage","linnall","linnworks","logicpod","logiwa","logiwa-io","longtail","luminous","luxroutage","mabang","magento","mai","mainfreight","masonhub","mayple","mintsoft","mirakl","mochila-fulfillment","moda-express","monta","netsuite","next3pl","nextsmartship","nfi","nimble","nlrp","npfulfilment","nri","nuorder","oia-global","omnitrans","ongoing","orderdesk","orderflow","orderwise","osa-commerce","overstock","packem","packiyo","pattern","peoplevox","picqer","pimento","podfoods","portless","postnord","pulpo","qls","quiet","return-helper","rithum-home-depot","rjw","royal-mail","rs-logistics","rush-order","salesupply","sandbox","sg-spedition","shipbob","shipedge","shipfusion","shiphero","shipmonk","shipnetwork","shipoffers","shipout","shipping-and-handling","shipping-tree","shippingbo","shipsidekick","shipstation","shipstream","shipwire","shopify","skladon","skulabs","skusavvy","skuvault","smart-warehousing","smartpack","snapfulfil","sojo","souko","squarespace","star","states-logistics","stock-and-trace","stockhub","stord","stylux","teamship","teapplix","techship","thg-ingenuity-fulfil","tiktok","tlogistics","tps","tradepeg","unis","unleashed","ups","usps","veeqo","veracore","vertical-cold","vox","walmart","warehance","warehouseos","wayfair","whiplash","wineshipping","wix","woocommerce","xorosoft","zenventory","zoho"],"example":"shipbob"},"required":false},{"in":"query","name":"integration_type","description":"Only return requests made against connections of this integration type.","schema":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"example":"wms"},"required":false},{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APILogFacetsResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Get API Log Facets","description":"Returns the distinct values your organization's API logs contain for each filter, so you can discover what to pass to the search endpoint. Scoped to the same connection, integration, and date range.","operationId":"get_get_api_log_facets"}},"/wms/passthrough":{"post":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassthroughResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Passthrough"],"summary":"WMS Passthrough Request","description":"Make API requests directly to Trackstar's supported integrations.","operationId":"post_wms_passthrough","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassthroughRequestSchema"}}}}}},"/cart/warehouses":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/CartWarehouseIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/CartWarehouseCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartWarehouseUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartWarehouseTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CartWarehouseTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/CartWarehouseTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartWarehousesListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["cart","Warehouses"],"summary":"Get All Cart Warehouses","description":"Returns all Warehouses for the Cart connection associated with the provided access token.","operationId":"get_cart_get_warehouses"}},"/erp/passthrough":{"post":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassthroughResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Passthrough"],"summary":"ERP Passthrough Request","description":"Make API requests directly to Trackstar's supported ERP integrations.","operationId":"post_erp_passthrough","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassthroughRequestSchema"}}}}}},"/connections/sync":{"post":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConnectionResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Sync Connection","description":"Manually trigger a sync for the connection associated with your access token.\n\nNote - this does not sync historical data. Rather, it syncs data from the last sync time to the current time. To sync historical data, use the on-demand syncs endpoint.","operationId":"post_sync_connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResourceSyncSchema"}}}}}},"/cart/passthrough":{"post":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassthroughResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["cart","Passthrough"],"summary":"Cart Passthrough Request","description":"Make API requests directly to Trackstar's supported cart integrations.","operationId":"post_cart_passthrough","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassthroughRequestSchema"}}}}}},"/erp/sales-orders":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpSalesOrderIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpSalesOrderTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"status","description":"The status of the sales order. See the [sales order information](info) for more details.","schema":{"$ref":"#/components/schemas/ErpSalesOrderStatusQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"order_number","description":"A user-facing identifier for the order.","schema":{"$ref":"#/components/schemas/ErpSalesOrderOrder_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"reference_id","description":"An external reference on the order, such as the customer's PO number.","schema":{"$ref":"#/components/schemas/ErpSalesOrderReference_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"order_date","description":"The date the order was placed. Same syntax as created_date/updated_date.","schema":{"$ref":"#/components/schemas/ErpSalesOrderOrder_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrdersListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Sales Orders"],"summary":"Get All ERP Sales Orders","description":"Returns all Sales Orders for the ERP connection associated with the provided access token.","operationId":"get_erp_get_sales_orders"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpCreateSalesOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Sales Orders"],"summary":"Create ERP Sales Order","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_erp_create_sales_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateerpSalesOrderInputSchema"}}}}}},"/freight/shipments":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/FreightShipmentIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/FreightShipmentCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/FreightShipmentUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/FreightShipmentTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/FreightShipmentTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightShipmentsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["freight","Shipments"],"summary":"Get All Shipments","description":"Returns all Shipments for the Freight connection associated with the provided access token.","operationId":"get_freight_get_shipments"}},"/wms/orders/channels":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsOrderChannelIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsOrderChannelCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsOrderChannelUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsOrderChannelTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsOrderChannelTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsOrderChannelWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrderChannelsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Order Channels"],"summary":"Get All Order Channels","description":"Returns all Order Channels for the WMS connection associated with the provided access token.","operationId":"get_wms_get_order_channels"}},"/erp/purchase-orders":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"status","description":"The status of the purchase order. See the [purchase order information](info) for more details.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderStatusQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"order_number","description":"A user-facing identifier for the order.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderOrder_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"reference_id","description":"An external reference on the order, such as the supplier's quote number.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReference_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"order_date","description":"The date the order was placed. Same syntax as created_date/updated_date.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderOrder_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrdersListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Purchase Orders"],"summary":"Get All ERP Purchase Orders","description":"Returns all Purchase Orders for the ERP connection associated with the provided access token.","operationId":"get_erp_get_purchase_orders"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpCreatePurchaseOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Purchase Orders"],"summary":"Create ERP Purchase Order","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_erp_create_purchase_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateerpPurchaseOrderInputSchema"}}}}}},"/schedules/toggle-all":{"patch":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Schedules"],"summary":"Toggle All Schedules","description":"Pause or unpause every schedule for the connection associated with your access token in a single call.","operationId":"patch_toggle_all_schedules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleScheduleSchema"}}}}}},"/integration-requests":{"post":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationRequestResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"summary":"Request an Integration","description":"Ask us to build an integration we don't support yet. We open a ticket and follow up with you.","operationId":"post_POST__integration-requests","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationRequestBodySchema"}}}}}},"/wms/inventory/ledger":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"event_type","description":"The event that occurred resulting in the inventory ledger entry.","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerEvent_TypeQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"entry_date","description":"The timestamp of the inventory ledger entry.","schema":{"$ref":"#/components/schemas/WmsInventoryLedgerEntry_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventoryLedgerListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Inventory Ledger"],"summary":"Get Inventory Ledger","description":"Returns the Inventory Ledger for the WMS connection associated with the provided access token.","operationId":"get_wms_get_inventory_ledger"}},"/wms/shipping-methods":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsShippingMethodIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsShippingMethodCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsShippingMethodUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsShippingMethodTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsShippingMethodTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsShippingMethodsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Shipping Methods"],"summary":"Get All Shipping Methods","description":"Returns all Shipping Methods for the WMS connection associated with the provided access token.","operationId":"get_wms_get_shipping_methods"}},"/wms/inbound-shipments":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsInboundShipmentIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"status","description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentStatusQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsInboundShipmentWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_id","description":"Filter by the ID of the warehouse that will be receiving the shipment.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentWarehouse_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"expected_arrival_date","description":"The date the shipment is expected to arrive at the warehouse.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentExpected_Arrival_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"purchase_order_number","description":"The number of the purchase order associated with the inbound shipment.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentPurchase_Order_NumberQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Inbound Shipments"],"summary":"Get All Inbound Shipments","description":"Returns all Inbound Shipments for the WMS connection associated with the provided access token.","operationId":"get_wms_get_inbound_shipments"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateInboundShipmentResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Inbound Shipments"],"summary":"Create Inbound Shipment","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_inbound_shipment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsInboundShipmentInputSchema"}}}}}},"/wms/kits/{kit_id}":{"put":{"parameters":[{"in":"path","name":"kit_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsUpdateKitResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Kits"],"summary":"Update a Kit Product","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_kit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatewmsKitInputSchema"}}}}}},"/wms/warehouse-customers":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsWarehouseCustomerIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsWarehouseCustomerCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseCustomerUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseCustomerTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseCustomerTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseCustomersListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Warehouse Customers"],"summary":"Get All Warehouse Customers","description":"Returns all Warehouse Customers for the WMS connection associated with the provided access token.","operationId":"get_wms_get_warehouse_customers"}},"/erp/items/{item_id}":{"get":{"parameters":[{"in":"path","name":"item_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpItemsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Items"],"summary":"Get ERP Item","description":"Returns a single Item for the ERP connection with the associated item id.","operationId":"get_erp_get_item"}},"/erp/sales-order-shipments":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"sales_order_id","description":"ID of the parent sales order.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentSales_Order_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"shipment_number","description":"A user-facing identifier for the shipment.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentShipment_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"shipped_date","description":"The date the shipment was sent. Same syntax as created_date/updated_date.","schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentShipped_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Sales Order Shipments"],"summary":"Get All ERP Sales Order Shipments","description":"Returns all Sales Order Shipments for the ERP connection associated\nwith the provided access token. Shipments are fulfillment events\nrecorded against a parent sales order; the parent is linked via\n`sales_order_id`.","operationId":"get_erp_get_sales_order_shipments"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpCreateSalesOrderShipmentResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Sales Order Shipments"],"summary":"Create ERP Sales Order Shipment","description":"Records a shipment (fulfillment) against an existing sales order. The\nparent sales order is identified by `sales_order_id` in the request\nbody. Get the required, optional, and integration specific fields by\ncalling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_erp_create_sales_order_shipment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateerpSalesOrderShipmentInputSchema"}}}}}},"/integration-requests/flows":{"get":{"parameters":[{"in":"query","name":"integration_type","description":"Only return flows for this integration type. Omit to get every type.","schema":{"type":"string","enum":["wms","cart","carrier"],"example":"wms"},"required":false},{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationRequestFlowsResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"summary":"Integration Request Flows","description":"The flows you can ask for when requesting a new integration. Use the `value` of each in the `flows` field of an integration request.","operationId":"get_GET__integration-requests_flows"}},"/wms/orders/{order_id}":{"get":{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Orders"],"summary":"Get Order","description":"Returns a single Order for the WMS connection with the associated order id.","operationId":"get_wms_get_order"},"put":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsUpdateOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Orders"],"summary":"Update Order","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatewmsOrderInputSchema"}}}}}},"/wms/billing/{bill_id}":{"get":{"parameters":[{"in":"path","name":"bill_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsBillsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Bills"],"summary":"Get Bill","description":"Returns a single Bill for the WMS connection with the associated bill id.","operationId":"get_wms_get_bill"}},"/carrier/invoice-line-items":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"transaction_date","description":"Filter by the transaction date of the invoice line item.","schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemTransaction_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["carrier","Invoice Line Items"],"summary":"Get All Invoice Line Items","description":"Returns all Invoice Line Items for the Carrier connection associated with the provided access token.","operationId":"get_carrier_get_invoice_line_items"}},"/magic-links/{magic_link_id}":{"get":{"parameters":[{"in":"path","name":"magic_link_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MagicLinkResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Auth"],"summary":"Get Magic Link","description":"Get a Magic Link by its ID.","operationId":"get_get_magic_link_external"},"delete":{"parameters":[{"in":"path","name":"magic_link_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMagic_LinkResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Auth"],"summary":"Delete Magic Link","description":"Delete a Magic Link by its ID.","operationId":"delete_delete_magic_link_external"}},"/connections/on-demand-syncs":{"get":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnDemandSyncsResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"List On-Demand Syncs","description":"Get all on-demand sync jobs for the connection.","operationId":"get_list_on_demand_syncs"},"post":{"parameters":[{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnDemandSyncResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Auth"],"summary":"Create On-Demand Sync","description":"Request a sync for a specific date range. Creates a sync job that is\nprocessed by a scheduler.","operationId":"post_create_on_demand_sync","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DateRangeSyncInputSchema"}}}}}},"/cart/orders/{order_id}":{"get":{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Orders"],"summary":"Get Cart Order","description":"Returns a single Order for the Cart connection with the associated order ID.","operationId":"get_cart_get_order"}},"/erp/purchase-order-receipts":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_tags","description":"Filter by trackstar tags. Dict-shaped tags should be queried as \"key:value\" strings.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptTrackstar_Tags_FlatQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"purchase_order_id","description":"ID of the parent purchase order.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptPurchase_Order_IdQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"receipt_number","description":"A user-facing identifier for the receipt.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptReceipt_NumberQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"received_date","description":"The date the receipt was recorded. Same syntax as created_date/updated_date.","schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptReceived_DateQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Purchase Order Receipts"],"summary":"Get All ERP Purchase Order Receipts","description":"Returns all Purchase Order Receipts for the ERP connection associated\nwith the provided access token. Receipts are goods-receipt events\nrecorded against a parent purchase order; the parent is linked via\n`purchase_order_id`.","operationId":"get_erp_get_purchase_order_receipts"},"post":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpCreatePurchaseOrderReceiptResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["erp","Purchase Order Receipts"],"summary":"Create ERP Purchase Order Receipt","description":"Records a goods-receipt event against an existing purchase order. The\nparent purchase order is identified by `purchase_order_id` in the\nrequest body. Get the required, optional, and integration specific\nfields by calling the [integrations](/api-reference/mgmt/integrations)\nendpoint.","operationId":"post_erp_create_purchase_order_receipt","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateErpPurchaseOrderReceiptSchema"}}}}}},"/sandbox/simulate/cart/orders":{"post":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartOrdersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Sandbox"],"summary":"Create Sandbox Cart Order","description":"Simulates a new order landing in the cart sandbox. Builds a random order\nagainst the existing sandbox products and warehouses, stores it, and fires\nan order webhook. Generate the sandbox first so products exist to reference.","operationId":"post_POST__sandbox_simulate_cart_orders"}},"/wms/returns/{return_id}":{"get":{"parameters":[{"in":"path","name":"return_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsReturnsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Returns"],"summary":"Get Return","description":"Returns a single Return for the WMS connection with the associated return id.","operationId":"get_wms_get_return"},"put":{"parameters":[{"in":"path","name":"return_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsUpdateReturnResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Returns"],"summary":"Update Return","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_return","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatewmsReturnInputSchema"}}}}}},"/carrier/files/{file_id}":{"get":{"parameters":[{"in":"path","name":"file_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierFilesSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["carrier","Files"],"summary":"Get Carrier File","description":"Returns a single raw file for the Carrier connection with the associated id, with a\nfreshly minted download URL. This is what the carrier-file.created webhook points\nat: the webhook carries the file's id, and the URL is minted here because a\npresigned URL expires faster than a webhook can be retried.","operationId":"get_carrier_get_file"}},"/erp/vendors/{vendor_id}":{"get":{"parameters":[{"in":"path","name":"vendor_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpVendorsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Vendors"],"summary":"Get ERP Vendor","description":"Returns a single Vendor for the ERP connection with the associated vendor id.","operationId":"get_erp_get_vendor"}},"/sandbox/simulate/cart/products":{"post":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProductsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["Sandbox"],"summary":"Create Sandbox Cart Product","description":"Simulates a new product landing in the cart sandbox. Builds a random parent\nproduct with variants against the existing sandbox warehouses, stores them,\nand fires a product webhook. Returns the parent product.","operationId":"post_POST__sandbox_simulate_cart_products"}},"/webhooks/payloads/{payload_id}":{"get":{"parameters":[{"in":"path","name":"payload_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Webhooks"],"summary":"Get Webhook Payload","description":"Returns a download link for the full payload of a webhook that was too\nlarge to deliver in one piece. Call this with the `data_url` from the event\nyou received, then fetch `download_url` to get that same event with\neverything filled in. The link is good for 20 minutes.","operationId":"get_get_webhook_payload"}},"/wms/products/{product_id}":{"get":{"parameters":[{"in":"path","name":"product_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsProductsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Products"],"summary":"Get Product","description":"Returns a single Product for the WMS connection with the associated product ID.","operationId":"get_wms_get_product"},"put":{"parameters":[{"in":"path","name":"product_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsUpdateProductResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Products"],"summary":"Update Product","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_product","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatewmsProductInputSchema"}}}}}},"/integrations/{integration_type}":{"get":{"parameters":[{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true},{"in":"query","name":"integration_name","description":"Filter integrations by name. Supports eq, neq, in, and nin (e.g. integration_name[in]=shipbob,packiyo).","schema":{"$ref":"#/components/schemas/AllowedOperators"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"actions","description":"A comma separated list of actions an integration must support to be included (e.g. get_orders,get_inventory).","schema":{"type":"array","example":"get_orders,get_inventory","items":{"type":"string","description":"","example":"actions"}},"required":false,"explode":true,"style":"form"},{"in":"path","name":"integration_type","description":"The type of integration to filter by.","schema":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"example":"carrier"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"summary":"Integration Info","description":"Information about the data provided by each integration.","operationId":"get_get_integration_info"}},"/wms/orders/{order_id}/file":{"post":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachFileOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"summary":"Create Order File","description":"Create a file for the specified order.","operationId":"post_wms_attach_order_file","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AttachFileSchema"}}}}}},"/wms/inbound-shipments/suppliers":{"get":{"parameters":[{"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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsInboundShipmentSupplierIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentSupplierCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentSupplierUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentSupplierTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsInboundShipmentSupplierTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"warehouse_customer_id","description":"The ID of the customer associated with the resource","schema":{"$ref":"#/components/schemas/WmsInboundShipmentSupplierWarehouse_Customer_IdQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentSuppliersListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["wms","Inbound Shipment Suppliers"],"summary":"Get All Inbound Shipment Suppliers","operationId":"get_wms_get_inbound_shipment_suppliers"}},"/cart/products/{product_id}":{"get":{"parameters":[{"in":"path","name":"product_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartProductsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Products"],"summary":"Get Cart Product","description":"Returns a single Product for the Cart connection with the associated product ID.","operationId":"get_cart_get_product"}},"/connections/{connection_id}":{"get":{"parameters":[{"in":"path","name":"connection_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConnectionsResponseonlydata"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Auth"],"summary":"Get Connection","description":"Returns the specified connection.","operationId":"get_GET__connections_path_connection_id"}},"/schedules/{function_name}/toggle":{"patch":{"parameters":[{"in":"path","name":"function_name","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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Schedules"],"summary":"Toggle Schedule","description":"Pause or unpause a schedule for the connection associated with your access token.","operationId":"patch_toggle_schedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleScheduleSchema"}}}}}},"/wms/orders/{order_id}/packs":{"get":{"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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrderPacksSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"summary":"Get Order Packs","description":"Returns the packs for the specified order.","operationId":"get_wms_get_order_packs"}},"/erp/locations/{location_id}":{"get":{"parameters":[{"in":"path","name":"location_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpLocationsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Locations"],"summary":"Get ERP Location","description":"Returns a single Location for the ERP connection with the associated location id.","operationId":"get_erp_get_location"}},"/erp/customers/{customer_id}":{"get":{"parameters":[{"in":"path","name":"customer_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpCustomersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Customers"],"summary":"Get ERP Customer","description":"Returns a single Customer for the ERP connection with the associated customer id.","operationId":"get_erp_get_customer"}},"/erp/employees/{employee_id}":{"get":{"parameters":[{"in":"path","name":"employee_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpEmployeesSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Employees"],"summary":"Get ERP Employee","description":"Returns a single Employee for the ERP connection with the associated employee id.","operationId":"get_erp_get_employee"}},"/wms/inventory/{inventory_id}":{"get":{"parameters":[{"in":"path","name":"inventory_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInventorySingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inventory"],"summary":"Get Inventory Item","description":"Returns a single Inventory Item for the WMS connection with the associated inventory id.","operationId":"get_wms_get_inventory_item"},"put":{"parameters":[{"in":"path","name":"inventory_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsUpdateInventoryItemResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inventory"],"summary":"Update an Inventory Item","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_inventory_item","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatewmsInventoryItemInputSchema"}}}}}},"/wms/orders/{order_id}/cancel":{"put":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCancelOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Orders"],"summary":"Cancel Order","description":"Cancel an order for the WMS connection with the associated order id.","operationId":"put_wms_cancel_order"}},"/erp/inventory/{inventory_id}":{"get":{"parameters":[{"in":"path","name":"inventory_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpInventorySingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Inventory"],"summary":"Get ERP Inventory Item","description":"Returns a single Inventory Item for the ERP connection with the associated inventory id.","operationId":"get_erp_get_inventory_item"}},"/wms/warehouses/{warehouse_id}":{"get":{"parameters":[{"in":"path","name":"warehouse_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehousesSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Warehouses"],"summary":"Get Warehouse","description":"Returns a single Warehouse for the WMS connection with the associated warehouse id.","operationId":"get_wms_get_warehouse"},"put":{"parameters":[{"in":"path","name":"warehouse_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsUpdateWarehouseResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Warehouses"],"summary":"Update a Warehouse","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_warehouse","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatewmsWarehouseInputSchema"}}}}}},"/cart/orders/{order_id}/refund":{"post":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartRefundOrderOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Orders"],"summary":"Refund Cart Order","description":"Refunds an order with the specified line items and amount.","operationId":"post_cart_refund_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundOrdercartOrderInputSchema"}}}}}},"/wms/returns/{return_id}/cancel":{"put":{"parameters":[{"in":"path","name":"return_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCancelReturnResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Returns"],"summary":"Cancel Return","description":"Cancel a return for the WMS connection with the associated return id.","operationId":"put_wms_cancel_return"}},"/cart/warehouses/{warehouse_id}":{"get":{"parameters":[{"in":"path","name":"warehouse_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartWarehousesSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Warehouses"],"summary":"Get Cart Warehouse","description":"Returns a single Warehouse for the Cart connection with the associated warehouse ID.","operationId":"get_cart_get_warehouse"}},"/wms/orders/{order_id}/shipments":{"post":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateShipmentOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Orders"],"summary":"Ship Order","description":"Marks the order as fulfilled and passes in the provided shipment and package information.\n\nGet the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"post_wms_create_order_shipment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentwmsOrderInputSchema"}}}}}},"/freight/shipments/{shipment_id}":{"get":{"parameters":[{"in":"path","name":"shipment_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightShipmentsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["freight","Shipments"],"summary":"Get Shipment","description":"Returns a single Shipment for the Freight connection with the associated shipment id.","operationId":"get_freight_get_shipment"}},"/cart/products/batch-adjust-inventory":{"put":{"parameters":[{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartBatchAdjustInventoryProductResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"}},"tags":["cart","Products"],"summary":"Batch Adjust Inventory for Cart Products","description":"Set the exact on-hand inventory for multiple cart products in a single call.\nEach line specifies a product and the exact quantity to set; increase and\ndecrease adjustments are not supported here.","operationId":"put_cart_batch_adjust_inventory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAdjustInventorycartProductInputSchema"}}}}}},"/connections/on-demand-syncs/{sync_id}":{"get":{"parameters":[{"in":"path","name":"sync_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnDemandSyncResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Auth"],"summary":"Get On-Demand Sync","description":"Get details of a specific on-demand sync job.","operationId":"get_get_on_demand_sync"}},"/cart/orders/{order_id}/shipments":{"post":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartCreateShipmentOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"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","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentcartOrderInputSchema"}}}}}},"/erp/sales-orders/{sales_order_id}":{"get":{"parameters":[{"in":"path","name":"sales_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrdersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Sales Orders"],"summary":"Get ERP Sales Order","description":"Returns a single Sales Order for the ERP connection with the associated sales order id.","operationId":"get_erp_get_sales_order"},"put":{"parameters":[{"in":"path","name":"sales_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpUpdateSalesOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Sales Orders"],"summary":"Update ERP Sales Order","description":"Edits header fields, edits or closes existing line items, and/or adds\nnew line items on an existing sales order. Get the required, optional,\nand integration specific fields by calling the\n[integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_erp_update_sales_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateerpSalesOrderInputSchema"}}}}}},"/erp/items/{item_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"item_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagItemResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Items"],"summary":"Update ERP Item Trackstar Tags","description":"Update the trackstar tags for the specified ERP item.","operationId":"put_erp_update_item_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagitemsSchema"}}}}}},"/wms/inventory/{inventory_id}/adjust":{"put":{"parameters":[{"in":"path","name":"inventory_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsAdjustInventoryInventoryItemResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inventory"],"summary":"Adjust Inventory Item","description":"Adjust the inventory for the specified inventory item.","operationId":"put_wms_adjust_inventory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustInventorywmsInventoryItemInputSchema"}}}}}},"/wms/orders/{order_id}/trackstar-tags":{"put":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsAddTrackstarTagOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Orders"],"summary":"Update Order Trackstar Tags","description":"Update the trackstar tags for the specified order.","operationId":"put_wms_update_order_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagordersSchema"}}}}}},"/sandbox/simulate/orders/{order_id}/fulfill":{"put":{"parameters":[{"in":"path","name":"order_id","schema":{"type":"string"},"required":true},{"in":"query","name":"partial","description":"Whether or not to fulfill the order partially.","schema":{"type":"boolean","default":false,"example":false},"required":false},{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsOrdersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Sandbox"],"summary":"Sandbox Simulate Fulfill","operationId":"put_PUT__sandbox_simulate_orders_order_id_fulfill"}},"/cart/orders/{order_id}/trackstar-tags":{"put":{"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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartAddTrackstarTagOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Orders"],"summary":"Update Cart Order Trackstar Tags","description":"Update the trackstar tags for the specified cart order.","operationId":"put_cart_update_order_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagordersSchema"}}}}}},"/sandbox/generate-sandbox/{integration_type}":{"post":{"parameters":[{"in":"path","name":"integration_type","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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeResponseSandbox"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Sandbox"],"summary":"Generate Sandbox","description":"Generates a sandbox with mocked out data.\nUses the same connection ID every time, and will reset any existing sandbox.\nSee the [walkthrough](/how-to-guides/sandbox) for more information.","operationId":"post_POST__sandbox_generate-sandbox_integration_type"}},"/wms/returns/{return_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"return_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsAddTrackstarTagReturnResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Returns"],"summary":"Update Return Trackstar Tags","description":"Update the trackstar tags for the specified return.","operationId":"put_wms_update_return_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagreturnsSchema"}}}}}},"/erp/vendors/{vendor_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"vendor_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagVendorResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Vendors"],"summary":"Update ERP Vendor Trackstar Tags","description":"Update the trackstar tags for the specified ERP vendor.","operationId":"put_erp_update_vendor_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagvendorsSchema"}}}}}},"/connections/on-demand-syncs/{sync_id}/cancel":{"post":{"parameters":[{"in":"path","name":"sync_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnDemandSyncResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Auth"],"summary":"Cancel On-Demand Sync","description":"Cancel a pending on-demand sync job.","operationId":"post_cancel_on_demand_sync"}},"/sandbox/simulate/returns/{return_id}/receive":{"put":{"parameters":[{"in":"path","name":"return_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsReturnsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["Sandbox"],"summary":"Receive Return","description":"Simulates a warehouse operative receiving and inspecting a return shipment.\nSubmit line items with condition (good/damaged/defective/worn) and disposition\n(return_to_stock/return_to_supplier/thrown_away/inspect) to process the return.","operationId":"put_PUT__sandbox_simulate_returns_return_id_receive","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxReturnReceiveSchema"}}}}}},"/wms/warehouses/{warehouse_id}/locations":{"get":{"parameters":[{"in":"path","name":"warehouse_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},{"in":"query","name":"page_token","description":"The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.","schema":{"type":["string","null"],"example":"page_token"},"required":false},{"in":"query","name":"limit","description":"The maximum number of items to return. The default is 1000.","schema":{"type":"integer","minimum":1,"maximum":1000,"example":1000},"required":false},{"in":"query","name":"ids","schema":{"$ref":"#/components/schemas/WmsWarehouseLocationIdsQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"created_date","description":"Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. \n Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`.","schema":{"$ref":"#/components/schemas/WmsWarehouseLocationCreated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseLocationUpdated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_created_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseLocationTrackstar_Created_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"trackstar_updated_date","description":"Same syntax as `created_date`.","schema":{"$ref":"#/components/schemas/WmsWarehouseLocationTrackstar_Updated_DateQueryParam"},"required":false,"style":"deepObject","explode":true},{"in":"query","name":"type","description":"The type of the location. e.g. pallet, bin, etc.","schema":{"$ref":"#/components/schemas/WmsWarehouseLocationTypeQueryParam"},"required":false,"style":"deepObject","explode":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseLocationsListEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Warehouse Locations"],"summary":"Get All Warehouse Locations","description":"Returns all Warehouse Locations for the WMS connection with the associated warehouse id.","operationId":"get_wms_get_warehouse_locations"}},"/erp/sales-order-shipments/{shipment_id}":{"get":{"parameters":[{"in":"path","name":"shipment_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Sales Order Shipments"],"summary":"Get ERP Sales Order Shipment","description":"Returns a single Sales Order Shipment for the ERP connection with the\nassociated shipment id.","operationId":"get_erp_get_sales_order_shipment"}},"/erp/purchase-orders/{purchase_order_id}":{"get":{"parameters":[{"in":"path","name":"purchase_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrdersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Purchase Orders"],"summary":"Get ERP Purchase Order","description":"Returns a single Purchase Order for the ERP connection with the associated purchase order id.","operationId":"get_erp_get_purchase_order"},"put":{"parameters":[{"in":"path","name":"purchase_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpUpdatePurchaseOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Purchase Orders"],"summary":"Update ERP Purchase Order","description":"Edits header fields, edits or closes existing line items, and/or adds\nnew line items on an existing purchase order. Get the required,\noptional, and integration specific fields by calling the\n[integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_erp_update_purchase_order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateErpPurchaseOrderSchema"}}}}}},"/wms/products/{product_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"product_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsAddTrackstarTagProductResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Products"],"summary":"Update Product Trackstar Tags","description":"Update the trackstar tags for the specified product.","operationId":"put_wms_update_product_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagproductsSchema"}}}}}},"/erp/sales-orders/{sales_order_id}/cancel":{"put":{"parameters":[{"in":"path","name":"sales_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpCancelSalesOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Sales Orders"],"summary":"Cancel ERP Sales Order","description":"Cancels an existing sales order. The exact transition is integration\nspecific \u2014 for NetSuite, all open lines are closed.","operationId":"put_erp_cancel_sales_order"}},"/erp/purchase-order-receipts/{receipt_id}":{"get":{"parameters":[{"in":"path","name":"receipt_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Purchase Order Receipts"],"summary":"Get ERP Purchase Order Receipt","description":"Returns a single Purchase Order Receipt for the ERP connection with\nthe associated receipt id.","operationId":"get_erp_get_purchase_order_receipt"}},"/wms/shipping-methods/{shipping_method_id}":{"get":{"parameters":[{"in":"path","name":"shipping_method_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsShippingMethodsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Shipping Methods"],"summary":"Get Shipping Method","description":"Returns a single Shipping Method for the WMS connection with the associated shipping method id.","operationId":"get_wms_get_shipping_method"}},"/cart/products/{product_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"product_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartAddTrackstarTagProductResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Products"],"summary":"Update Cart Product Trackstar Tags","description":"Update the trackstar tags for the specified cart product.","operationId":"put_cart_update_product_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagproductsSchema"}}}}}},"/erp/locations/{location_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"location_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagLocationResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Locations"],"summary":"Update ERP Location Trackstar Tags","description":"Update the trackstar tags for the specified ERP location.","operationId":"put_erp_update_location_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTaglocationsSchema"}}}}}},"/erp/customers/{customer_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"customer_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagCustomerResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Customers"],"summary":"Update ERP Customer Trackstar Tags","description":"Update the trackstar tags for the specified ERP customer.","operationId":"put_erp_update_customer_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagcustomersSchema"}}}}}},"/erp/employees/{employee_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"employee_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagEmployeeResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Employees"],"summary":"Update ERP Employee Trackstar Tags","description":"Update the trackstar tags for the specified ERP employee.","operationId":"put_erp_update_employee_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagemployeesSchema"}}}}}},"/wms/inventory/{inventory_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"inventory_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsAddTrackstarTagInventoryItemResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inventory"],"summary":"Update Inventory Trackstar Tags","description":"Update the trackstar tags for the specified inventory item.","operationId":"put_wms_update_inventory_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTaginventorySchema"}}}}}},"/wms/inbound-shipments/{inbound_shipment_id}":{"get":{"parameters":[{"in":"path","name":"inbound_shipment_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsInboundShipmentsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inbound Shipments"],"summary":"Get Inbound Shipment","description":"Returns a single Inbound Shipment for the WMS connection with the associated inbound shipment id.","operationId":"get_wms_get_inbound_shipment"},"put":{"parameters":[{"in":"path","name":"inbound_shipment_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsUpdateInboundShipmentResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inbound Shipments"],"summary":"Update Inbound Shipment","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_inbound_shipment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatewmsInboundShipmentInputSchema"}}}}}},"/cart/products/{product_id}/adjust-inventory":{"put":{"parameters":[{"in":"path","name":"product_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartAdjustInventoryProductResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Products"],"summary":"Adjust Inventory for Product","description":"Adjust the inventory for the specified cart product.","operationId":"put_cart_adjust_inventory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustInventorycartProductInputSchema"}}}}}},"/erp/inventory/{inventory_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"inventory_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagInventoryItemResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Inventory"],"summary":"Update ERP Inventory Trackstar Tags","description":"Update the trackstar tags for the specified ERP inventory item.","operationId":"put_erp_update_inventory_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTaginventorySchema"}}}}}},"/wms/warehouses/{warehouse_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"warehouse_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsAddTrackstarTagWarehouseResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Warehouses"],"summary":"Update Warehouse Trackstar Tags","description":"Update the trackstar tags for the specified warehouse.","operationId":"put_wms_update_warehouse_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagwarehousesSchema"}}}}}},"/integrations/{integration_type}/{integration_name}":{"get":{"parameters":[{"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":"Optional. Pass this in to get connection-specific field information. Your user's access token for a specific integration (ShipHero, Extensiv, etc).","schema":{"type":"string","example":""},"required":false},{"in":"path","name":"integration_type","description":"The type of integration to filter by.","schema":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"example":"carrier"},"required":true},{"in":"path","name":"integration_name","description":"The name of the integration to filter by.","schema":{"type":"string","example":"integration_name"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsResponseSchema"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"summary":"Integration Info for Single Integration","description":"Information about the data provided by a single integration.","operationId":"get_get_single_integration_info"}},"/cart/warehouses/{warehouse_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"warehouse_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cartAddTrackstarTagWarehouseResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["cart","Warehouses"],"summary":"Update Cart Warehouse Trackstar Tags","description":"Update the trackstar tags for the specified cart warehouse.","operationId":"put_cart_update_warehouse_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagwarehousesSchema"}}}}}},"/erp/purchase-orders/{purchase_order_id}/cancel":{"put":{"parameters":[{"in":"path","name":"purchase_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpCancelPurchaseOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Purchase Orders"],"summary":"Cancel ERP Purchase Order","description":"Cancels an existing purchase order. The exact transition is\nintegration specific \u2014 for NetSuite, all open lines are closed.","operationId":"put_erp_cancel_purchase_order"}},"/wms/warehouse-customers/{warehouse_customer_id}":{"get":{"parameters":[{"in":"path","name":"warehouse_customer_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseCustomersSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Warehouse Customers"],"summary":"Get Warehouse Customer","description":"Returns a single Warehouse Customer for the WMS connection with the associated warehouse customer id.","operationId":"get_wms_get_warehouse_customer"}},"/erp/sales-orders/{sales_order_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"sales_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagSalesOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Sales Orders"],"summary":"Update ERP Sales Order Trackstar Tags","description":"Update the trackstar tags for the specified ERP sales order.","operationId":"put_erp_update_sales_order_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagsales_ordersSchema"}}}}}},"/carrier/invoice-line-items/{invoice_line_item_id}":{"get":{"parameters":[{"in":"path","name":"invoice_line_item_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["carrier","Invoice Line Items"],"summary":"Get Invoice Line Item","description":"Returns a single Invoice Line Item for the Carrier connection with the associated id.","operationId":"get_carrier_get_invoice_line_item"}},"/wms/inbound-shipments/{inbound_shipment_id}/receive":{"put":{"parameters":[{"in":"path","name":"inbound_shipment_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsCreateReceiptInboundShipmentResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inbound Shipments"],"summary":"Receive Inbound Shipment","description":"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.","operationId":"put_wms_create_receipt","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReceiptwmsInboundShipmentInputSchema"}}}}}},"/erp/purchase-orders/{purchase_order_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"purchase_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erpAddTrackstarTagPurchaseOrderResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["erp","Purchase Orders"],"summary":"Update ERP Purchase Order Trackstar Tags","description":"Update the trackstar tags for the specified ERP purchase order.","operationId":"put_erp_update_purchase_order_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTagpurchase_ordersSchema"}}}}}},"/integrations/{integration_type}/{integration_name}/write-info":{"get":{"parameters":[{"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":"Optional. Pass this in to get connection-specific field information. Your user's access token for a specific integration (ShipHero, Extensiv, etc).","schema":{"type":"string","example":""},"required":false},{"in":"path","name":"integration_type","description":"The type of integration to filter by.","schema":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"example":"carrier"},"required":true},{"in":"path","name":"integration_name","description":"The name of the integration to filter by.","schema":{"type":"string","example":"integration_name"},"required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassthroughSchema"},"example":{"openapi":"3.1.0","paths":{"/wms/returns":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatewmsReturnOngoingSchema"}}}},"responses":{"200":{"description":"Create WMS Return output"}}}}},"components":{"schemas":{"CreatewmsReturnOngoingSchema":{"type":"object","properties":{"return_number":{"type":"string","description":"Return number"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"TEST-SKU","expected_quantity":1,"return_cause":null}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemongoing"}},"tracking_number":{"type":"string","description":""},"tracking_url":{"type":"string","description":""},"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":{}}},"required":["line_items","order_id","return_number"],"additionalProperties":false,"title":"CreatewmsReturnOngoingSchema"},"WmsReturnWriteLineItemongoing":{"type":"object","properties":{"sku":{"type":"string","description":""},"expected_quantity":{"type":"integer","description":"","example":0},"return_cause":{"$ref":"#/components/schemas/ReturnCause"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemongoing"},"ReturnCause":{"type":"object","properties":{"code":{"type":"string","enum":["1","13","3"],"description":"The reason code for this return. Specific to your connection."},"return_reason":{"type":["string","null"],"enum":["damaged","wrong size","no longer needed"],"description":"The reason description for this return. Specific to your connection."}},"required":["code"],"additionalProperties":false,"title":"ReturnCause"}}}}}},"description":"OpenAPI 3.1.0 formatted JSON"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"summary":"Integration Write Info","description":"The spec for all the write operations supported by an integration,\nin [OpenAPI 3.1.0](https://swagger.io/specification/) format.\nAlso provides the connection-specific fields for an integration if you pass in the access token.","operationId":"get_get_integration_write_info_endpoint"}},"/wms/inbound-shipments/{inbound_shipment_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"inbound_shipment_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/wmsAddTrackstarTagInboundShipmentResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Inbound Shipments"],"summary":"Update Inbound Shipment Trackstar Tags","description":"Update the trackstar tags for the specified inbound shipment.","operationId":"put_wms_update_inbound_shipment_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTaginbound_shipmentsSchema"}}}}}},"/wms/warehouses/{warehouse_id}/locations/{location_id}":{"get":{"parameters":[{"in":"path","name":"warehouse_id","schema":{"type":"string"},"required":true},{"in":"path","name":"location_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}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WmsWarehouseLocationsSingleItemEndpoint"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["wms","Warehouse Locations"],"summary":"Get Warehouse Location","description":"Returns a single Warehouse Location for the WMS connection with the associated warehouse and location id.","operationId":"get_wms_get_warehouse_location"}},"/carrier/invoice-line-items/{invoice_line_item_id}/trackstar-tags":{"put":{"parameters":[{"in":"path","name":"invoice_line_item_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},{"in":"header","name":"Idempotency-Key","description":"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.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/carrierAddTrackstarTagInvoiceLineItemResponse"}}},"description":"Successful response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}},"description":"Validation error"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}},"description":"Not found"}},"tags":["carrier","Invoice Line Items"],"summary":"Update Invoice Line Item Trackstar Tags","description":"Update the trackstar tags for the specified invoice line item.","operationId":"put_carrier_update_invoice_line_item_trackstar_tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTrackstarTaginvoice_line_itemsSchema"}}}}}}},"openapi":"3.1.0","components":{"schemas":{"Event":{"type":"object","properties":{"id":{"type":"string","description":"The event id.","example":"550e8400-e29b-41d4-a716-446655440000"},"type":{"type":"string","enum":["install_failed","connection_error","schedule_stuck","schedule_unstuck","on_demand_sync_stuck","connection_created","connection_reinstalled","connection_deleted","connection_disabled","connection_enabled","schedule_paused","schedule_unpaused","on_demand_sync_started","on_demand_sync_completed","on_demand_sync_cancelled","historical_sync_completed"],"description":"The event type.","example":"install_failed"},"integration_name":{"type":"string","description":"The integration name.","example":"shipbob"},"integration_type":{"type":"string","description":"The integration type.","example":"wms"},"customer_id":{"type":["string","null"],"description":"Your identifier for the end customer, if any.","example":"cust_123"},"connection_id":{"type":["string","null"],"description":"The connection the event belongs to, if any.","example":"07b344db-0304-4866-9ae1-ac8af5292a28"},"message":{"type":["string","null"],"description":"A human-readable message, if the event has one.","example":"Invalid credentials."},"created_at":{"type":"string","format":"date-time","description":"When the event occurred.","example":"2024-01-15T12:00:00Z"},"additional_fields":{}},"required":["connection_id","created_at","customer_id","id","integration_name","integration_type","message","type"],"additionalProperties":false,"title":"Event"},"EventsResponseSchema":{"type":"object","properties":{"data":{"type":"array","description":"The list of events, newest first.","items":{"$ref":"#/components/schemas/Event"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"}},"required":["data","next_token"],"additionalProperties":false,"title":"EventsResponseSchema"},"ValidationError":{"properties":{"error":{"type":"string"},"detail":{"type":"object","properties":{"":{"type":"object","properties":{"":{"type":"array","items":{"type":"string"}}}}}}},"required":["error"],"type":"object","title":"ValidationError"},"APILogIntegrationRequest":{"type":"object","properties":{"url":{"type":["string","null"],"description":"The integration endpoint Trackstar called.","example":"https://api.example-wms.com/orders"},"method":{"type":"string","description":"The HTTP method Trackstar used.","example":"POST"},"body":{"description":"The body Trackstar sent to the integration.","type":["object","null"],"example":{"order_number":"1001"}}},"required":["body","method","url"],"additionalProperties":false,"title":"APILogIntegrationRequest"},"APILog":{"type":"object","properties":{"request_id":{"type":["string","null"],"description":"The id of the request, also returned on every response in the `X-Request-Id` header.","example":"Root=1-abc12345-abc123def456abc123def456"},"idempotency_key":{"type":["string","null"],"description":"The `Idempotency-Key` header the request was made with, if any.","example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"},"connection_id":{"type":["string","null"],"description":"The connection the request was made against.","example":"abc123def456abc123def456abc123de"},"integration_name":{"type":["string","null"],"description":"The integration the connection belongs to.","example":"example_wms"},"integration_type":{"type":["string","null"],"description":"The type of integration the connection belongs to.","example":"wms"},"request_time":{"type":"string","format":"date-time","description":"When Trackstar received the request.","example":"2024-01-15T13:45:30Z"},"request_method":{"type":"string","description":"The HTTP method of the request.","example":"GET"},"request_path":{"type":"string","description":"The endpoint that was called, with path parameters replaced by ``.","example":"/wms/orders/"},"path_param":{"type":["string","null"],"description":"The path parameter the request was made with.","example":"123"},"query_params":{"description":"The query parameters the request was made with.","type":["object","null"],"example":{"limit":100}},"request_body":{"description":"The body the request was made with.","type":["object","null"],"example":{"reference_id":"order-1001"}},"integration_request_bodies":{"type":["array","null"],"description":"The calls Trackstar made to the integration while handling this request. Credentials are redacted.","items":{"$ref":"#/components/schemas/APILogIntegrationRequest"}},"status_code":{"type":"integer","description":"The HTTP status code the request returned.","example":200},"error":{"type":["string","null"],"description":"The error the request returned, if it failed.","example":"Order not found"},"error_origin":{"type":["string","null"],"description":"Whether the error came from Trackstar or the integration.","example":"integration"},"duration_ms":{"type":["integer","null"],"description":"How long the request took, in milliseconds.","example":142}},"required":["connection_id","duration_ms","error","error_origin","idempotency_key","integration_name","integration_request_bodies","integration_type","path_param","query_params","request_body","request_id","request_method","request_path","request_time","status_code"],"additionalProperties":false,"title":"APILog"},"APILogsResponseSchema":{"type":"object","properties":{"data":{"type":"array","description":"The requests that matched the search, most recent first.","items":{"$ref":"#/components/schemas/APILog"}},"total_count":{"type":"integer","description":"The number of items returned.","example":1},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"APILogsResponseSchema"},"ProductInventoryItems":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"inv_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"unit_quantity":{"type":"integer","description":"The number of units of the inventory item in the product.","example":0}},"required":["inventory_item_id","sku","unit_quantity"],"additionalProperties":false,"title":"ProductInventoryItems"},"ProductSupplier":{"type":"object","properties":{"supplier_id":{"type":"string","description":"The ID of the supplier.","example":"supplier_id"},"supplier_name":{"type":["string","null"],"description":"The name of the supplier.","example":"supplier_name"}},"required":["supplier_id","supplier_name"],"additionalProperties":false,"title":"ProductSupplier"},"ProductSupplierProducts":{"type":"object","properties":{"supplier_id":{"type":"string","description":"ID of the supplier.","example":"sup_id"},"supplier_name":{"type":["string","null"],"description":"Name of the supplier.","example":"sup_name"},"external_id":{"type":["string","null"],"description":"The external ID of the product from the supplier.","example":"ext_id"},"unit_cost":{"type":["string","null"],"description":"The cost of the product from the supplier.","example":"unit_cost"}},"required":["external_id","supplier_id","supplier_name","unit_cost"],"additionalProperties":false,"title":"ProductSupplierProducts"},"WmsKitApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":["number","null"],"description":"The price of the product.","example":10.99},"inventory_items":{"type":"array","description":"A list of inventory items associated with the product.","example":[{"inventory_item_id":"id1","sku":"sku1","unit_quantity":1},{"inventory_item_id":"id2","sku":"sku2","unit_quantity":1}],"items":{"$ref":"#/components/schemas/ProductInventoryItems"}},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/ProductSupplier"},{"type":"null"}]},"country_of_origin":{"type":["string","null"],"description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":["string","null"],"description":"The harmonized HS code of the product.","example":"123456"},"supplier_products":{"type":"array","description":"A list of supplier products associated with the product.","example":[{"supplier_id":"id1","supplier_name":"name1","external_id":"ext_id1","unit_cost":1.0},{"supplier_id":"id2","supplier_name":"name2","external_id":"ext_id2","unit_cost":2.5}],"items":{"$ref":"#/components/schemas/ProductSupplierProducts"}},"categories":{"type":"array","description":"A list of category names associated with the product.","example":["Electronics","Accessories"],"items":{"type":"string","description":"","example":"categories"}},"image_urls":{"type":"array","description":"A list of image URLs associated with the product.","example":["https://example.com/image1.jpg"],"items":{"type":"string","description":"","example":"image_urls"}},"external_system_url":{"type":["string","null"],"description":"URL link to the product in the external system (WMS/Freight etc).","example":"https://example.com/product/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","categories","country_of_origin","created_date","external_system_url","gtin","harmonized_code","id","image_urls","inventory_items","is_kit","name","sku","supplier_object","supplier_products","trackstar_created_date","trackstar_tags","trackstar_updated_date","unit_price","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsKitApiItemSchema"},"wmsCreateKitResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsKitApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateKitResponse"},"WmsKitCreateInventoryItemsandbox":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitCreateInventoryItemsandbox"},"CreatewmsKit--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"XS-RED-SHIRT"},"name":{"type":"string","description":"name","example":"XS Red Shirt"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"012345678905"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitCreateInventoryItemsandbox"}}},"required":["gtin","inventory_items","name","sku"],"additionalProperties":false,"title":"WMS Sandbox"},"WmsKitWriteInventoryItemdear-systems":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Inventory Item ID of the kit component.","example":"inventory_item_id"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["inventory_item_id","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemdear-systems"},"CreatewmsKit--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"costing_method":{"type":"string","enum":["FIFO","Special - Batch","Special - Serial Number","FIFO - Serial Number","FIFO - Batch","FEFO - Batch","FEFO - Serial Number"],"description":"Costing method for the product.","example":"FEFO - Batch"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemdear-systems"}}},"required":["costing_method","inventory_items","name","sku"],"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"WmsKitWriteInventoryItemextensiv-3pl-central":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemextensiv-3pl-central"},"CreatewmsKit--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemextensiv-3pl-central"}}},"required":["inventory_items","name","sku","warehouse_customer_id"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"WmsKitCreateInventoryIteminfoplus":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitCreateInventoryIteminfoplus"},"CreatewmsKit--Infoplus--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"warehouse_customer_id":{"type":"string","description":"ID of the warehouse customer that owns this product","example":"warehouse_customer_id"},"name":{"type":"string","description":"name","example":"name"},"status":{"type":"string","enum":["Active","Deplete","Blocked","Placeholder","Outside Vendor","Print on Demand"],"description":"Status of the product","example":"Active"},"lot_mixing_rule":{"type":"string","default":"SKU","enum":["Item Receipt","Inventory Properties","SKU"],"description":"Controls how an item can be mixed in a lot. (e.g. items in a location all have to have come from the same production lot,\n items in a location have to have the same SKU but can have different inventory properties).","example":"SKU"},"item_mixing_rule":{"type":"string","default":"Single","enum":["Single","Multi"],"description":"Controls if items can be mixed with other items in a location.","example":"Single"},"allocation_rule":{"type":"string","default":"Strict","enum":["Strict","Weak","Labor Optimized"],"description":"Rule for allocating inventory to orders. Strict and Weak require a lot mixing rule of Item Receipt","example":"Strict"},"backorder":{"type":"boolean","default":false,"description":"Backorders created for this item when it is out of stock","example":true},"major_group_id":{"type":"integer","description":"ID of the major group this item belongs to. Must exist in Infoplus","example":0},"subgroup_id":{"type":"integer","description":"ID of the subgroup this item belongs to. Must exist in Infoplus","example":0},"hazmat":{"type":"boolean","default":false,"description":"Whether this item is hazardous","example":true},"secure":{"type":"boolean","default":false,"description":"Control if item must be stored in a secure warehouse","example":true},"seasonal_item":{"type":"boolean","default":false,"description":"Whether this item expereinces significant differences in usage based on time of year","example":true},"receiving_criteria_scheme_id":{"type":"integer","description":"ID of the receiving criteria scheme this item belongs to. Must exist in Infoplus","example":0},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"touches":{"type":"integer","description":"The number of assembly points there are to build a single kit","example":0},"is_kit_on_demand":{"type":"string","default":"No","enum":["Yes","No"],"description":"Whether this kit is built on demand (as in built at the point of fulfillment)","example":"No"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitCreateInventoryIteminfoplus"}},"price":{"type":"number","description":"Price of the product","example":0.0}},"required":["inventory_items","major_group_id","name","receiving_criteria_scheme_id","sku","status","subgroup_id","touches","warehouse_customer_id"],"additionalProperties":false,"title":"Infoplus"},"WmsKitWriteInventoryItemluminous":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemluminous"},"CreatewmsKit--Luminous--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"category_id":{"type":"integer","minimum":1,"description":"The ID of the Luminous category the kit belongs to.","example":1},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemluminous"}}},"required":["category_id","inventory_items","name","sku"],"additionalProperties":false,"title":"Luminous"},"ProductMeasurementsmasonhub":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsmasonhub"},"WmsKitWriteInventoryItemmasonhub":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","minimum":1,"description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemmasonhub"},"CreatewmsKit--MasonHub--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsmasonhub"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"description":{"type":"string","description":"Description of the product.","example":"description"},"customer_bar_code":{"type":"string","description":"Customer provided bar code for this sku.","example":"customer_bar_code"},"brand_name":{"type":"string","description":"Brand name for this sku and product.","example":"brand_name"},"category":{"type":"string","description":"Product category for this sku.","example":"category"},"sub_category":{"type":"string","description":"Product sub category for this sku.","example":"sub_category"},"vendor_brand_code":{"type":"string","description":"Vendor provided brand code for identifying this sku.","example":"vendor_brand_code"},"customer_brand_code":{"type":"string","description":"Customer provided brand code for identifying this sku. Used on packing lists.","example":"customer_brand_code"},"vendor_style":{"type":"string","description":"Vendor style code for item identification.","example":"vendor_style"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemmasonhub"}}},"required":["brand_name","category","customer_bar_code","customer_brand_code","description","inventory_items","measurements","name","sku","sub_category","vendor_brand_code","vendor_style"],"additionalProperties":false,"title":"MasonHub"},"WmsKitCreateInventoryItemongoing":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitCreateInventoryItemongoing"},"CreatewmsKit--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitCreateInventoryItemongoing"}}},"required":["gtin","inventory_items","name","sku"],"additionalProperties":false,"title":"Ongoing WMS"},"WmsKitWriteInventoryItemshiphero":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemshiphero"},"CreatewmsKit--ShipHero--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"warehouse_id":{"type":"string","description":"Warehouse ID where the product is stored. Use warehouse_ids to seed several warehouses in one call.","example":"warehouse_id"},"warehouse_ids":{"type":"array","description":"Warehouse IDs to seed the backing product into (one WarehouseProduct each, 0 on hand). Use instead of warehouse_id to seed multiple warehouses in a single call.","example":["warehouse_id_1","warehouse_id_2"],"items":{"type":"string","description":"","example":"warehouse_ids"}},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemshiphero"}}},"required":["inventory_items","name","sku"],"additionalProperties":false,"title":"ShipHero"},"WmsKitCreateInventoryItemshipstream":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitCreateInventoryItemshipstream"},"CreatewmsKit--ShipStream--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitCreateInventoryItemshipstream"}}},"required":["inventory_items","name","sku"],"additionalProperties":false,"title":"ShipStream"},"ProductMeasurementsshipwire":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"weight":{"type":["number","null"],"description":"","example":2.5},"units":{"type":"string","default":"US","enum":["US","METRIC"],"description":"The unit of measurement. If US, inches and pounds. If Metric, cm and kgs.","example":"US"}},"required":["height","length","weight","width"],"additionalProperties":false,"title":"ProductMeasurementsshipwire"},"WmsKitWriteInventoryItemshipwire":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemshipwire"},"CreatewmsKit--Shipwire--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","minLength":1,"maxLength":26,"description":"sku","example":"sku"},"category":{"type":"string","default":"OTHER","enum":["OTHER","APPAREL","TOYS_SPORTS_HOBBIES"],"description":"The product category","example":"OTHER"},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshipwire"},"cost_value":{"type":"number","description":"The cost of the product","example":0.0},"retail_value":{"type":"number","description":"The retail value of the product","example":0.0},"battery_configuration":{"type":"string","default":"NOBATTERY","enum":["NOBATTERY","ISBATTERY","HASBATTERY","HASLOOSEBATTERY"],"description":"The battery configuration of the product","example":"NOBATTERY"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemshipwire"}},"classification":{"type":"string","default":"kit","enum":["kit","virtualKit"],"description":"The classification of the product.\n A virtual kit is picked and packed at the time of shipment,\n while the items of a regular kit are physically packaged together.","example":"kit"}},"required":["cost_value","inventory_items","measurements","name","retail_value","sku"],"additionalProperties":false,"title":"Shipwire"},"WmsKitWriteInventoryItemskuvault":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemskuvault"},"CreatewmsKit--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemskuvault"}}},"required":["inventory_items","name","sku"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"WmsKitWriteInventoryItemwhiplash":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitWriteInventoryItemwhiplash"},"CreatewmsKit--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemwhiplash"}}},"required":["gtin","inventory_items","sku"],"additionalProperties":false,"title":"Whiplash (Ryder)"},"CreatewmsKitInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreatewmsKit--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreatewmsKit--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/CreatewmsKit--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/CreatewmsKit--Infoplus--"},{"$ref":"#/components/schemas/CreatewmsKit--Luminous--"},{"$ref":"#/components/schemas/CreatewmsKit--MasonHub--"},{"$ref":"#/components/schemas/CreatewmsKit--Ongoing__WMS--"},{"$ref":"#/components/schemas/CreatewmsKit--ShipHero--"},{"$ref":"#/components/schemas/CreatewmsKit--ShipStream--"},{"$ref":"#/components/schemas/CreatewmsKit--Shipwire--"},{"$ref":"#/components/schemas/CreatewmsKit--Linnworks__Core__-_SKUVault_---"},{"$ref":"#/components/schemas/CreatewmsKit--Whiplash__-_Ryder_---"}],"title":"CreatewmsKitInputSchema"},"ErpItemIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpItemIdsQueryParam"},"ErpItemCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpItemCreated_DateQueryParam"},"ErpItemUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpItemUpdated_DateQueryParam"},"ErpItemTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpItemTrackstar_Created_DateQueryParam"},"ErpItemTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpItemTrackstar_Updated_DateQueryParam"},"ErpItemTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpItemTrackstar_Tags_FlatQueryParam"},"ErpItemSkuQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"sku"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"},"is_null":{"type":"boolean","description":"Filter by whether the field is null.","example":true}},"additionalProperties":false,"title":"ErpItemSkuQueryParam"},"ErpKitComponent":{"type":"object","properties":{"item_id":{"type":"string","description":"ID of the component item.","example":"item_id"},"sku":{"type":"string","description":"SKU / item number of the component item.","example":"sku"},"unit_quantity":{"type":"number","description":"How many of this component go into a single kit.","example":0.0}},"required":["item_id","sku","unit_quantity"],"additionalProperties":false,"title":"ErpKitComponent"},"ErpItemCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpItemCustomFieldEntry"},"ErpItemApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the item in the ERP.","example":"item_id"},"created_date":{"type":"string","format":"date-time","description":"The date the item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The display name of the item.","example":"Apple - Fuji"},"sku":{"type":["string","null"],"description":"The SKU / item number of the item.","example":"10000"},"description":{"type":["string","null"],"description":"A long-form description of the item.","example":"Fuji apple, loose"},"active":{"type":"boolean","description":"Whether the item is active.","example":true},"is_kit":{"type":"boolean","description":"Whether this item is a kit. A kit is not stocked itself; its components carry the inventory and ship in its place.","example":false},"kit_components":{"type":"array","description":"The items that make up this kit, and how many of each go into a single kit. Empty for items that are not kits.","example":[{"item_id":"610","sku":"10000","unit_quantity":2.0}],"items":{"$ref":"#/components/schemas/ErpKitComponent"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the item. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpItemCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the item in the external system (WMS/Freight etc).","example":"https://example.com/item/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","created_date","custom_fields","description","external_system_url","id","is_kit","kit_components","name","sku","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"ErpItemApiItemSchema"},"ErpItemsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpItemApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpItemsListEndpoint"},"LinkTokenResponseSchema":{"type":"object","properties":{"link_token":{"type":"string","description":"The link token that is required to initiate the `react-trackstar-link` component.","example":"your_link_token"}},"required":["link_token"],"additionalProperties":false,"title":"LinkTokenResponseSchema"},"LinkTokenInputSchema":{"type":"object","properties":{"connection_id":{"type":"string","description":"An optional existing connection ID. If provided, the connection is reinstalled instead of a new connection being created.","example":"existing_connection_id"},"customer_id":{"type":"string","description":"An optional identifier for your end customer. If provided, it is recorded on any failed install attempts made with this link token and carried onto the connection once it is created, so you can trace either back to a specific customer.","example":"customer_id"}},"additionalProperties":false,"title":"LinkTokenInputSchema"},"WmsOrderIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsOrderIdsQueryParam"},"WmsOrderCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderCreated_DateQueryParam"},"WmsOrderUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderUpdated_DateQueryParam"},"WmsOrderTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderTrackstar_Created_DateQueryParam"},"WmsOrderTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderTrackstar_Updated_DateQueryParam"},"WmsOrderTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"WmsOrderTrackstar_Tags_FlatQueryParam"},"WmsOrderStatusQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"open"},"neq":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"backordered"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"backordered"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"backordered"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsOrderStatusQueryParam"},"WmsOrderWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsOrderWarehouse_Customer_IdQueryParam"},"WmsOrderTypeQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["d2c","b2b","dropship","transfer"],"description":"","example":"d2c"},"neq":{"type":"string","enum":["d2c","b2b","dropship","transfer"],"description":"","example":"b2b"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["d2c","b2b","dropship","transfer"],"description":"","example":"b2b"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["d2c","b2b","dropship","transfer"],"description":"","example":"b2b"}}},"additionalProperties":false,"title":"WmsOrderTypeQueryParam"},"WmsOrderOrder_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"order_num"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsOrderOrder_NumberQueryParam"},"WmsOrderReference_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"ref_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsOrderReference_IdQueryParam"},"WmsOrderRequired_Ship_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2021-01-01T12:00:00Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderRequired_Ship_DateQueryParam"},"WmsOrderTagsQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"WmsOrderTagsQueryParam"},"OrderChannel":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"},"channel_name":{"type":["string","null"],"description":"The name of the channel.","example":"channel_name"}},"required":["channel_id","channel_name"],"additionalProperties":false,"title":"OrderChannel"},"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"},"WmsOrderLineItem":{"type":"object","properties":{"product_id":{"type":"string","description":"Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details.","example":"product_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"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_amount":{"type":["number","null"],"description":"The amount discounted from the product for this order.","example":1.5}},"required":["discount_amount","product_id","quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderLineItem"},"ShipmentLineItem":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"inventory_item_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"parent_product_id":{"type":["string","null"],"description":"The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details.","example":"parent_product_id"}},"required":["inventory_item_id","parent_product_id","quantity","sku"],"additionalProperties":false,"title":"ShipmentLineItem"},"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"},"PackageMeasurements":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the package.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the package.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"PackageMeasurements"},"PackageLineItem":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"inventory_item_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"lot_id":{"type":["string","null"],"description":"The ID of the lot the inventory item was picked from.","example":"lot_id"},"expiration_date":{"type":["string","null"],"format":"date-time","description":"The expiration date of the lot the inventory item was picked from.","example":"2023-03-15T13:45:30Z"},"parent_product_id":{"type":["string","null"],"description":"The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details.","example":"parent_product_id"}},"required":["expiration_date","inventory_item_id","lot_id","parent_product_id","quantity","sku"],"additionalProperties":false,"title":"PackageLineItem"},"Package":{"type":"object","properties":{"package_id":{"type":"string","description":"The ID of the package.","example":"package_id"},"package_name":{"type":["string","null"],"description":"The name of the package. (e.g. 12x9x4)","example":"package_name"},"tracking_number":{"type":["string","null"],"description":"The tracking number for the package.","example":"tracking_number"},"tracking_url":{"type":["string","null"],"description":"The URL for the tracking number.","example":"tracking_url"},"shipping_method_id":{"type":["string","null"],"description":"The ID of the shipping method returned at the package level.","example":"shipping_method_id"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method returned at the package level.","example":"Standard Shipping"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the package.","example":"carrier_id"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier used to ship the package.","example":"carrier_name"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code for the carrier used to ship the package.","example":"scac"},"bill_of_lading":{"type":["string","null"],"description":"The bill of lading number associated with the package's shipment.","example":"bill_of_lading"},"sscc":{"type":["string","null"],"description":"The Serial Shipping Container Code (GS1) identifying the package.","example":"sscc"},"pro_number":{"type":["string","null"],"description":"The PRO (freight tracking) number associated with the package's shipment.","example":"pro_number"},"shipping_cost":{"type":["number","null"],"description":"The cost incurred by the warehouse to ship the package.","example":2.5},"measurements":{"$ref":"#/components/schemas/PackageMeasurements"},"line_items":{"type":"array","description":"A list of the inventory items included in the package.","items":{"$ref":"#/components/schemas/PackageLineItem"}}},"required":["bill_of_lading","carrier_id","carrier_name","line_items","measurements","package_id","package_name","pro_number","scac","shipping_cost","shipping_method_id","shipping_method_name","sscc","tracking_number","tracking_url"],"additionalProperties":false,"title":"Package"},"OrderShipment":{"type":"object","properties":{"shipment_id":{"type":"string","description":"The ID of the shipment.","example":"shipment_id"},"warehouse_id":{"type":"string","description":"The warehouse this order was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) of the shipment returned directly from the WMS.","example":"raw_status"},"status":{"type":"string","enum":["open","shipped","cancelled","other"],"description":"The status of the shipment.","example":"shipped"},"shipped_date":{"type":["string","null"],"format":"date-time","description":"The date the shipment was sent.","example":"2022-05-06T01:02:03Z"},"line_items":{"type":"array","description":"List of the inventory items listed in the shipment.","items":{"$ref":"#/components/schemas/ShipmentLineItem"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddress"},"packages":{"type":"array","description":"A list of the packages included in the shipment.","items":{"$ref":"#/components/schemas/Package"}}},"required":["line_items","packages","raw_status","ship_from_address","ship_to_address","shipment_id","shipped_date","status","warehouse_id"],"additionalProperties":false,"title":"OrderShipment"},"WmsOrderApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the order.","example":"order_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":["string","null"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"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"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order. Defaults to `reference_id` if not provided.","example":"order_number"},"status":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"The status of the order. See the [order information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"channel_object":{"anyOf":[{"$ref":"#/components/schemas/OrderChannel"},{"type":"null"}]},"type":{"type":["string","null"],"enum":["d2c","b2b","dropship","transfer"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"trading_partner":{"type":["string","null"],"description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"service_level":{"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 used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level.","example":"fedex_ground"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method used to ship the order.","example":"FedEx Ground"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code for the carrier used to ship the order.","example":"scac"},"is_third_party_freight":{"type":["boolean","null"],"description":"True if the order was shipped using a third party freight account.","example":false},"third_party_freight_account_number":{"type":["string","null"],"description":"The third party freight account number used to ship the order.","example":"123456"},"first_party_freight_account_number":{"type":["string","null"],"description":"The first party freight account number used to ship the order.","example":"123456"},"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"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":1,"unit_price":10.99,"discount_amount":1.5}],"items":{"$ref":"#/components/schemas/WmsOrderLineItem"}},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":["string","null"],"format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"saturday_delivery":{"type":["boolean","null"],"description":"True if the order requires Saturday delivery.","example":false},"signature_required":{"type":["boolean","null"],"description":"True if the order requires a signature upon delivery.","example":false},"international_duty_paid_by":{"type":["string","null"],"enum":["sender","recipient","third_party"],"description":"The party responsible for paying international duties.","example":"sender"},"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","example":[{"shipment_id":"shipment_id","warehouse_id":"wh_id","shipped_date":"2022-05-06T01:02:03Z","raw_status":"raw_status","status":"shipped","line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"parent_product_id":null}],"ship_to_address":{"full_name":"John Doe","company":"company","address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"ship_from_address":{"address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"packages":[{"package_id":"package_id","package_name":"package_name","tracking_number":"tracking_number","tracking_url":"tracking_url","shipping_method_id":"shipping_method_id","shipping_method_name":"shipping_method_name","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"scac","bill_of_lading":"bill_of_lading","sscc":"sscc","pro_number":"pro_number","shipping_cost":1.0,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-06-06T01:02:03Z","parent_product_id":null}]}]}],"items":{"$ref":"#/components/schemas/OrderShipment"}},"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","carrier_id","carrier_name","channel_object","created_date","external_system_url","first_party_freight_account_number","id","international_duty_paid_by","invoice_currency_code","is_third_party_freight","line_items","order_number","raw_status","reference_id","required_ship_date","saturday_delivery","scac","service_level","ship_to_address","shipments","shipping_method_id","shipping_method_name","signature_required","status","tags","third_party_freight_account_number","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","trading_partner","type","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"WmsOrderApiItemSchema"},"WmsOrdersListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsOrderApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsOrdersListEndpoint"},"CreateWmsOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the order.","example":"order_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":["string","null"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"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"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order. Defaults to `reference_id` if not provided.","example":"order_number"},"status":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"The status of the order. See the [order information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"channel_object":{"anyOf":[{"$ref":"#/components/schemas/OrderChannel"},{"type":"null"}]},"type":{"type":["string","null"],"enum":["d2c","b2b","dropship","transfer"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"trading_partner":{"type":["string","null"],"description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"service_level":{"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 used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level.","example":"fedex_ground"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method used to ship the order.","example":"FedEx Ground"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code for the carrier used to ship the order.","example":"scac"},"is_third_party_freight":{"type":["boolean","null"],"description":"True if the order was shipped using a third party freight account.","example":false},"third_party_freight_account_number":{"type":["string","null"],"description":"The third party freight account number used to ship the order.","example":"123456"},"first_party_freight_account_number":{"type":["string","null"],"description":"The first party freight account number used to ship the order.","example":"123456"},"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"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":1,"unit_price":10.99,"discount_amount":1.5}],"items":{"$ref":"#/components/schemas/WmsOrderLineItem"}},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":["string","null"],"format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"saturday_delivery":{"type":["boolean","null"],"description":"True if the order requires Saturday delivery.","example":false},"signature_required":{"type":["boolean","null"],"description":"True if the order requires a signature upon delivery.","example":false},"international_duty_paid_by":{"type":["string","null"],"enum":["sender","recipient","third_party"],"description":"The party responsible for paying international duties.","example":"sender"},"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","example":[],"items":{"$ref":"#/components/schemas/OrderShipment"}},"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","carrier_id","carrier_name","channel_object","created_date","external_system_url","first_party_freight_account_number","id","international_duty_paid_by","invoice_currency_code","is_third_party_freight","line_items","order_number","raw_status","reference_id","required_ship_date","saturday_delivery","scac","service_level","ship_to_address","shipments","shipping_method_id","shipping_method_name","signature_required","status","tags","third_party_freight_account_number","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","trading_partner","type","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"CreateWmsOrderResponseDataSchema"},"wmsCreateOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateWmsOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateOrderResponse"},"SandboxChannelIdSchema":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"SandboxChannelIdSchema"},"SandboxCreateOrderShipToAddress":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code"],"additionalProperties":false,"title":"SandboxCreateOrderShipToAddress"},"WmsOrderCreateLineItemsandbox":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":1}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemsandbox"},"CreatewmsOrder--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"so_80090"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/SandboxChannelIdSchema"},"shipping_method_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"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","description":"The total price a customer paid for the order.","example":13.49},"ship_to_address":{"$ref":"#/components/schemas/SandboxCreateOrderShipToAddress"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemsandbox"}}},"required":["order_number","reference_id","ship_to_address"],"additionalProperties":false,"title":"WMS Sandbox"},"WmsOrderWriteLineItemactive-ants":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemactive-ants"},"ShipToAddressActive-Ants":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","company","country","full_name","postal_code"],"additionalProperties":false,"title":"ShipToAddressActive-Ants"},"CreatewmsOrder--Active__Ants--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemactive-ants"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressActive-Ants"},"order_type_id":{"type":"string","enum":["N/A \u2014 connect an account to see options"],"description":"Active Ants order type name","example":"order_type_id"}},"required":["line_items","order_type_id","reference_id","ship_to_address"],"additionalProperties":false,"title":"Active Ants"},"ShipToAddressAdp":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","state"],"additionalProperties":false,"title":"ShipToAddressAdp"},"WmsOrderCreateLineItemadp":{"type":"object","properties":{"sku":{"type":"string","maxLength":48,"description":"SKU or product code","example":"sku"},"quantity":{"type":"integer","description":"Quantity to ship","example":0},"uom":{"type":"string","maxLength":3,"description":"Unit of measure","example":"CT"}},"required":["quantity","sku","uom"],"additionalProperties":false,"title":"WmsOrderCreateLineItemadp"},"CreatewmsOrder--A.__Duie__Pyle__-_ADP_---":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","maxLength":22,"description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","maxLength":22,"description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressAdp"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"uom":"CT"}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemadp"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"A. Duie Pyle (ADP)"},"ShipToAddressAmphora":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"+1234567890"},"email_address":{"type":"string","description":"","example":"user@example.com"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"ShipToAddressAmphora"},"WmsOrderCreateLineItemamphora":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderCreateLineItemamphora"},"CreatewmsOrder--Amphora--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"invoice_currency_code":{"type":"string","description":"The currency code for this order (e.g. EUR, USD).","example":"USD"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressAmphora"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemamphora"}}},"required":["invoice_currency_code","line_items","order_number","ship_to_address","total_price"],"additionalProperties":false,"title":"Amphora"},"AmplifierChannelIdSchema":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"AmplifierChannelIdSchema"},"ShipToAddressAmplifier":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressAmplifier"},"BillToAddressAmplifier":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"BillToAddressAmplifier"},"WmsOrderWriteLineItemamplifier":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the item.","example":"sku"},"quantity":{"type":"integer","description":"Quantity of the item.","example":1},"description":{"type":"string","description":"Description of the item.","example":"Widget"}},"required":["description","quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemamplifier"},"CreatewmsOrder--Amplifier--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/AmplifierChannelIdSchema"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressAmplifier"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressAmplifier"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1,"description":"Widget"}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemamplifier"}}},"required":["bill_to_address","line_items","order_number","service_level","ship_to_address"],"additionalProperties":false,"title":"Amplifier"},"ChannelIdSchema":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"ChannelIdSchema"},"ShipToAddressAms":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"555-867-5309"},"email_address":{"type":"string","description":"","example":"jdoe@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressAms"},"BillToAddressAms":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"555-867-5309"},"email_address":{"type":"string","description":"","example":"jdoe@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"BillToAddressAms"},"WmsOrderWriteLineItemams":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemams"},"CreatewmsOrder--AMS--":{"type":"object","properties":{"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":{}},"client_code":{"type":"string","description":"The AMS-assigned client code the order should be created under.","example":"AB"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelIdSchema"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"total_tax":{"type":"number","description":"The total tax on the order.","example":1.5},"total_discount":{"type":"number","description":"The total amount discounted from the order.","example":2.5},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressAms"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressAms"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemams"}}},"required":["bill_to_address","channel_object","client_code","line_items","reference_id","ship_to_address","shipping_method_id","warehouse_id"],"additionalProperties":false,"title":"AMS"},"ShipToAddressAmware":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"}},"additionalProperties":false,"title":"ShipToAddressAmware"},"WmsOrderWriteLineItemamware":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemamware"},"CreatewmsOrder--Staci__Americas__-_AMWare_---":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressAmware"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemamware"}},"shipping_method_id":{"type":"string","enum":["AEG0","CPU","SRG","AMH","UP04","UP05","UP03","UP01","UP02","UP08","UP06","UP12","UP36","UP37","UP33","SURP","UP15","UP16","UP17","UP18","UP35","UP21","UP13","UP22","UP19","UP25","UP20","US02","US03","US18","USPS","US04","US05","RASP","RSNU","RS2D","PP01","PP02","PP03"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"AEG0"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelIdSchema"},"type":{"type":"string","enum":["d2c","b2b"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"order_type":{"type":"string","description":"A free-text order flag (e.g. a sales channel like \"TikTok\"). Separate from `type`, which sets B2C / B2B billing.","example":"TikTok"}},"required":["line_items","reference_id","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Staci Americas (AMWare)"},"ShipToAddressAtomix":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"customer@example.com"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"required":["address1","city","country","email_address","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressAtomix"},"WmsOrderWriteLineItematomix":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItematomix"},"CreatewmsOrder--Atomix--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"type":{"type":"string","enum":["dtc","b2b"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"b2b"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressAtomix"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItematomix"}}},"required":["line_items","reference_id","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"Atomix"},"ShipToAddressBergen":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"Phone number for the shipping address.","example":"phone_number"}},"required":["address1","city","country","full_name","state"],"additionalProperties":false,"title":"ShipToAddressBergen"},"BillToAddressBergen":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","company","country","full_name","postal_code","state"],"additionalProperties":false,"title":"BillToAddressBergen"},"WmsOrderWriteLineItembergen":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItembergen"},"CreatewmsOrder--Bergen--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"payment_terms":{"type":"string","enum":["Net","COD","CC","WIRE"],"description":"Payment terms of the order.","example":"CC"},"carrier_id":{"type":"string","enum":["GILBERT EAST","FREIGHT FORWARDER","ROUTING GUIDE","CUSTOMER PICKUP","TRUCK P/P","TRUCK F/C","FEDEX","DHL EXPRESS","BAX GLOBAL","TNT","UPS","USPS","UPS FREIGHT","JB HUNT","A&S TRUCKING SERVICE","PORT LOGISTICS GROUP","ESTES EXPRESS LINES","PITT OHIO","EXACTA MESSENGER","ROCKET MESSENGER","Front Line Freight","DMS EXPRESS","Messenger","KINGS EXPRESS","Gilbert Express","RANGER TRANSPORTATION INC","Fedex Freight east","Fedex Freight West","FREIGHTCO LOGISTICS","Vale Trucking","EDI TRUCKING","SWIFT TRANSPORT","PERFORMANCE TEAM","DISPATCH CENTRAL","warehouse transfer","NORTH EAST COURIERS INC","Old Dominion","Champion","YRC","All Time","BENJAMIN MAZER TRUCKING","VEECO SERVICES","CTE","GALE TRIANGLE","VISION EXPRESS","THE RIGHT MOVE","ABF","JAYDEE","BARNEYS","NEW DEAL","FOXS","NRT","T&M","MIGO TRUCKING","TRIANGLE","YELLOW FREIGHT","ROADWAY","Gilbert West","Pacific Logistics","City Fashion","Main Freight","Allstates Freight","NEW ENGLAND MOTOR FREIGHT","YAMATO TRANSPORTATION","PANALPINA","EXPEDITORS","DSV AIR & SEA","YUSEN AIR","HERCULES TRANSPORTATION","CITY GARMENT","US XPRESS","DYNAMIC","R&S TRANSPORTATION","Knight Transportation","WTG","SCHNEIDER TRANSPORT","Araiza Express","SELECT EXPRESS & LOGISTICS","INTERCARGO LOGISTICS","RoadEx America","ASSET TRANSFER","Fedex Freight Regional","UPS EU","National Retail Trans","EASTERN FREIGHT WAYS","Daylight Transport","Jet Speed","MOL","TOWNE AIR FREIGHT","ROADRUNNER","DIAMOND LOGISTICS","Global Spedition","Altruck Inc","DL EXpress","EVER CONCORD","LAND AIR EXPRESS","RONIE TRUCKING","JET SPEED AIR CARGO","DAX EXPRESS","J.O. TRUCKING INC","Same Day Delivery","KEYSTONE TRUCKING","ROBINSON TRANSPORTATION SERVICES","UNITED CENTURY EXPRESS C.","TI LOGISTICS","WTG.","FREIGHT FORCE","TY DELIVERY SERVICES","USF REDDAWAY INC","ClearLane Freight","Landstar","PASCHALL TRUCK LINES INBOUND","ARCTIC EXPRESS","SCHNEIDER","JRC","KINTETSU WORLD EXPRESS","TOPOCEAN CONSOLIDATION","DHL","Borderlinx","O.T Delivery","UBER","OAK HARBOR FREIGHT","Caltop Logistics","AFN","OCEAN ONE","NFI LOGISTICS","Jamex","DeCaro","Vanguard Logistics","ATS","CONWAY","ARCHILLA TRANSPORT","AMERICAN CARGO EXPRESS","Pacer","SKYWAY TRUCKING","New Rochell","RAPID DELIVERY SERVICE","REGIONAL TRUCKING","MRZ TRUCKING","BEO SUPPLY INC","FORWARD AIR","1st Freight","WESTERN EXPRESS","GRANDVIEW","Cargo International","UPS SUPPLY CHAIN","AXIS GLOBAL LOGISTICS","FRESH AIR TRUCKING","CRST","CSA TRANSPORTATION","BLJ TRUCKING","EAGLE TRANSPORTATION","ADAMS THIRD WAVE CONSULTING","MERCER TRANSPORTATION","A DUIE PYLE","PIZA TRUCKING","MOUNTAIN VALLEY EXORESS","R & L Transfer","SAIA MOTOR FREIGHT","Celadon Trucking Services","NATIONAL RETAIL SYSTEMS INC.","DM TRANSPORTATION","JV Transportation","VSS TRANSPORTATION GROUP INC","GLS","INXP","Dependable Highway Express","GILBERT CONSOLIDATION","Crosby Trucking Inbound","SCOTT LOGISTICS","EXPO LOGISTICS","NEW PENN","West End Express","L-Freight","OCEAN ONE","Dms services","JSTAR","Land Air Express","CRYSTAL MOTORS","MAP CARGO","DHL GLOBAL FORWARDING","VOLPE EXPRESS","XPORT SERVICE","RANGER EXPRESS","T I Logistics","Roadrunner","WTG OTR Inbound","Bergen Truck EC","BLACKHAWK SOUTHWEST","SERVICE TRANSPORT","DOT-LINE TRANSPORTATION","HUB GROUP INTERMODAL","PAYSTAR LOGISTICS","SPI INTL TRANSPORTATION","SAIA INC","ALL CARTAGE","HASSET EXPRESS","HAWK TRANSPORTATION","WARD trucking","Diamond freight distribution INC","GOLDEN","Logical Logistics","Transport America Regional Fleet","CELADON","BEST OVERNITE LTL","HTL","APPAREL MOVERS","Keanes Cartage","BRUIN TRUCKING","Polaris Transport","OSBORN","FRONTLINE FREIGHT","BTX GLOBAL LOGISITICS","XPO LOGISTICS","J.Q. Trucking Inc","IMPULSE","SKYNET","Central Freight Lines Inc","DESANTIS","EXPORT SERVICES","PAI TRUCKING","Central Transport","AMERICAN TRUCKING","Shinju Express","AIR CITY","AMERICAN AIRFREIGHT TRUCKING","AAA TRUCKING","CONCORD TRUCKING","BREAKWAY CARRIER","FERSCHO TRUCKING","CH ROBINSON","MGR FREIGHT","DHL GLOBAL FORWARDING","A&F","CROWN TRUCKING","DYNAMIC EXPRESS","Premier Transportation Inbound","ALBATRANS","Fedex LTL","Prostar Logistics","INTERSTATE DISTRIBUTOR COMPANY","CSRT","USA TRUCK, INC.","EZ WORLDWIDE EXPRESS","BEAR TRANSPORTATION","TRICAP INTERNATIONAL","Unyson Logistics","NFI","Complete distribution solution","BNSF LOGISTICS LLC","SCHNEIDER NATIONAL","APC","TOTAL QUALITY LOGISTICS","TM LOGISTICS","Transplace","ZTC FREIGHT","Falcon Logistics","Transport America Inbound","FARMORE TRANSPORTATION","FNS DISTRIBUTING COMPNAY","FNS DISTRIBUTING COMPANY","JEM EXPRESS INC","KRG Logistics","Covenant Transport","Globaltranz"],"description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"FEDEX"},"shipping_method_id":{"type":"string","enum":["1st Freight","AAAT","AAIE","ABFS","AFN","AHWE","ALBA WHEELS","ALBATRANS","ALCY","ALTR","ALUK","ANSW","APC LOGISTICS","APPAREL MOVERS","ARIE","ASSET","ASUR","AXIG","All Time","Araiza Express","BARNEYS","BAX GLOBAL GURANTEED- 1ST ARRIVAL","BAX GLOBAL GURANTEED- 2ND DAY","BAX GLOBAL GURANTEED- AIRPORT TO AIRPORT","BAX GLOBAL GURANTEED- OVERNIGHT","BAX GLOBAL STANDARD- 2ND DAY","BAX GLOBAL STANDARD- BAX SAVER","BAX GLOBAL STANDARD- NEXT AVAILABLE FLIGHT","BAX GLOBAL STANDARD- OVERNIGHT","BAX GLOBAL TRUCK","BAXG","BEOS","BLJF","BLKW","BNLS","BREAKWAY CARRIER","BRTK","BTG","BTVP","BTXA","Bergen Truck","Borderlinx","CAIE","CARRIER","CDNK","CDSS","CENF","CETR","CEVA LOGISTICS","CFX","CGMC","CH ROBINSON","CLFS","CNWY","CONC","COURIER EXPRESS LLC","CPPV","CPUP","CRGO","CRPS","CRWT","CRYS","CSAP","CSBI","CTQH","CUSTOMER TRUCK - Pickup By Customer","CVEN","Carrier","Celadon Trucking Services","Central Freight Lines Inc","Cosmo Freight Solutions","DAXX","DCDS","DFDO","DHE","DHL 2ND DAY","DHL 2ND DAY -Residential","DHL DOMESTIC PRIORITY","DHL DOMESTIC PRIORITY -Residential","DHL DOMESTIC STANDARD","DHL DOMESTIC STANDARD -Residential","DHL EASYSHOP","DHL EASYSHOP - SATURDAY DELIVERY","DHL ECONOMY SELECT","DHL ECONOMY SELECT - SATURDAY DELIVERY","DHL EUROPACK","DHL EUROPACK - SATURDAY DELIVERY","DHL EXPRESS 10:30","DHL EXPRESS 10:30 - SATURDAY DELIVERY","DHL EXPRESS 12:00","DHL EXPRESS 12:00 - SATURDAY DELIVERY","DHL EXPRESS 9:00","DHL EXPRESS 9:00 - SATURDAY DELIVERY","DHL EXPRESS WORLDWIDE","DHL EXPRESS WORLDWIDE - SATURDAY DELIVERY","DHL GLOBAL FORWARDING","DHL GROUND","DHL GROUND -Residential","DHL INTL PRIORITY","DHL INTL PRIORITY -Residential","DHL INTL STANDARD","DHL INTL STANDARD -Residential","DHL NEXT DAY 10:30","DHL NEXT DAY 10:30 -Residential","DHL NEXT DAY 12PM","DHL NEXT DAY 12PM -Residential","DHL NEXT DAY 3PM","DHL NEXT DAY 3PM -Residential","DHL SATURDAY DELIVERY(OPTIONAL)","DHL SATURDAY DELIVERY(OPTIONAL) -Residential","DHLG","DISP","DMRG","DMSD","DOLR","DSV1","DYEX","DYLT","DYXI","DYXT","Daylight Transport","EDI","EFWY","ESDR","ETSI","EVCD","EXLA","EXPD","EZWO","FCLL","FCSY","FEDEX 2Day - Commercial","FEDEX 2Day - Residential","FEDEX 2Day - SATURDAY DELIVERY - Commercial","FEDEX 2Day - SATURDAY DELIVERY - Residential","FEDEX Express Saver - Commercial","FEDEX Express Saver - Residential","FEDEX First Overnight - Commercial","FEDEX First Overnight - Residential","FEDEX Ground - Commercial","FEDEX Ground - Residential","FEDEX International Economy - Commercial","FEDEX International Economy - Residential","FEDEX International Ground (to Canada) - Commercial","FEDEX International Ground (to Canada) - Residential","FEDEX International Priority - Commercial","FEDEX International Priority - Residential","FEDEX Priority Overnight - Commercial","FEDEX Priority Overnight - Residential","FEDEX Standard Overnight - Commercial","FEDEX Standard Overnight - Residential","FETR","FFFF","FLOG","FMTS","FNSD","FORWARD AIR","FORWARDER","FOXS","FREIGHT","FREIGHT FORWARDER","FRESH AIR TRUCKING","FWDR","FXFE","FXFW","FXNL","Falcon Logistics","GADQ","GBEA","GBXI","GILBERT EAST","GLS Standard","GLTN","GOLD","GRWE","Gilbert Express","Globaltranz","HACC","HAXS","HJBT","HRCF","HTL GROUND","HUBG","IMPULSE","INTD","INXPRESS","J.O. TRUCKING INC","JANEL GROUP","JDFD","JEM EXPRESS INC.","JEMA","JETP","JETS","JQTR","JRS TRUCKING","JRSK","JV Transportation","Jefron","KCSS","KIGE","KNIG","KRGS","KWEO","KYSO","LAEX","LAND","LFGT","LTL","Land Air Express","Landstar","Logical Logistics","MAPC","MAZR","MCET","MESSENGER","MGRF","MIGO TRUCKING","MRZT","MSNG","MVEX","Main Freight","Metro Trucking","NAFT","NART","NDCW","NDLO","NECI","NEMF","NEW PENN","NRCL","NRD","OAKH","ODFL","OSTP","OTDS","PASC","PAYL","PFLP","PITD","PNE1","POGM","POLT","PSLP","PTAG","PYLE","PYLR","PZAT","RBTW","RDFS","RDSC","RDWY","RDXA","RGTR","RNGR","RNLO","ROTR","ROUTING GUIDE","RSTN","RTNG","RXPF","Rock freight system","SAIA","SAMD","SCDS","SCGP","SCNN","SIVP","SKYNET Worldwide Express","SRVP","SWFT","SXLT","T I Logistics","T&M","T-soon trucking","TCAM","TCSI","TGIR","TGNA","THE RIGHT MOVE","TMLS","TNT DOMESTICS- TRUCK","TNT DOMESTICS- USA EXPRESS","TNT DOMESTICS- USA GROUND","TNT INTL- 12PM EXPRESS","TNT INTL- 9PM EXPRESS","TNT INTL- ECONOMY EXPRESS","TNT INTL- GLOBAL EXPRESS","TNT INTL- NEXT DAY","TODL","TODM","TPFF","TPQL","TPXY","TQYL","TRMI","TRUCK F/C TRUCK F/C","TRUCK P/P TRUCK P/P","TRUCKING","TYDS","Transport America Inbound","Trucking","UBER","UCEC","UCL trucking","UPGF","UPS 2ND DAY AIR - Commercial","UPS 2ND DAY AIR - Residential","UPS 2ND DAY AIR AM - Commercial","UPS 2ND DAY AIR AM - Residential","UPS 3 DAY SELECT - Commercial","UPS 3 DAY SELECT - Residential","UPS Expedited","UPS Express","UPS Express Saver","UPS FREIGHT","UPS GROUND - Commercial","UPS GROUND - Residential","UPS NEXT DAY AIR - Commercial","UPS NEXT DAY AIR - Residential","UPS NEXT DAY AIR EARLY AM - Commercial","UPS NEXT DAY AIR EARLY AM - Residential","UPS NEXT DAY AIR SAVER - Commercial","UPS NEXT DAY AIR SAVER - Residential","UPS Standard","UPS WORLD SHIP EXPEDITED - Commercial","UPS WORLD SHIP EXPEDITED - Residential","UPS WORLD SHIP EXPRESS - Commercial","UPS WORLD SHIP EXPRESS - Residential","UPS WORLD SHIP EXPRESS PLUS- Commercial","UPS WORLD SHIP EXPRESS SAVER- Commercial","UPS WORLD SHIP EXPRESS SAVER- Residential","UPSF","USFR","USIT","USPS DOM 1ST CLASS","USPS DOM EXPRESS","USPS DOM PARCEL POST","USPS DOM PRIORITY","USPS GLOB 1ST CLASS PACKAGE","USPS GLOB AIRMAIL","USPS GLOB EXP GTD","USPS GLOB EXP MAIL","USPS GLOB PRI MAIL","USPS Media Mail","USPS United States Postal Service","USXI","UYSN","VALT","VHLC","VIEX","VISION EXPRESS","VOEX","VSS TRANSPORTATION GROUP INC","VSXP","WEXI","WHTN","WMI","WRDT","WTGG","XPORT","YAT1","YFSY","YUS1","ZTCF"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"1st Freight"},"billing_option":{"type":"string","enum":["Prepaid","Freight Collect","Third Party","Consignee Bill","Collect Billing"],"description":"Billing option of the order.","example":"Collect Billing"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressBergen"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressBergen"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItembergen"}},"order_type":{"type":"string","enum":["Web","Wholesale","Retail","Dropship","CrossDock"],"description":"Type of the order.","example":"CrossDock"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"}},"required":["billing_option","carrier_id","line_items","order_number","order_type","payment_terms","ship_to_address","shipping_method_id","warehouse_id"],"additionalProperties":false,"title":"Bergen"},"ShipToAddressBest-Inc":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"}},"required":["address1","city","country","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressBest-Inc"},"WmsOrderWriteLineItembest-inc":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItembest-inc"},"CreatewmsOrder--BEST__Inc.--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"is_third_party_freight":{"type":"boolean","description":"True if the order was shipped using a third party freight account.","example":false},"third_party_freight_account_number":{"type":["string","null"],"description":"The carrier account number to bill when is_third_party_freight is true.","example":"123456"},"invoice_currency_code":{"type":"string","enum":["USD","CAD","CNY","THB"],"description":"The currency for this order. Best Inc. supports USD, CAD, CNY, and THB.","example":"USD"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressBest-Inc"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItembest-inc"}}},"required":["carrier_id","line_items","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"BEST Inc."},"ShipToAddressBluebox":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressBluebox"},"WmsOrderCreateLineItembluebox":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItembluebox"},"CreatewmsOrder--BlueBox__-_IDrive__Fulfillment_---":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressBluebox"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItembluebox"}},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"}},"required":["carrier_id","line_items","reference_id","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"BlueBox (IDrive Fulfillment)"},"CreateOrderShipToAddressBoxzooka":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"CreateOrderShipToAddressBoxzooka"},"WmsOrderWriteLineItemboxzooka":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"name":{"type":"string","description":"The name of the item, as it should appear on the packing slip.","example":"Crew Tee - XS / White"},"quantity":{"type":"integer","description":"","example":0},"weight":{"type":"number","description":"The weight of the line item, in pounds.","example":1.5},"unit_price":{"type":"number","description":"","example":0.0}},"required":["name","quantity","sku","weight"],"additionalProperties":false,"title":"WmsOrderWriteLineItemboxzooka"},"CreatewmsOrder--Boxzooka--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"shipping_method_id":{"type":"string","enum":["BXZ.PKP","BXZ.USA.1","BXZ.USA.2","BXZ.USA.3","BXZ.USA.5","BXZ.USA.7","UPS.EXP.1","UPS.DOM.1","UPS.DOM.2","UPS.DOM.3","UPS.GRD.RESI","SUREPOST","USPS.PRIORITY","USPS.GRD","USPS.EXPRESS","FDX.EXP.1","FDX.DOM.1","FDX.DOM.2","FDX.DOM.3","FDX.GRD","FDX.GRD.COLLECT","FDX.HOME","SMARTPOST","DHLEC.GRD","DHLEC.MAX","FDX.INTL.ECO","FDX.CONNECT.PLUS","UPS.INTL.EXP","DHLEC.PLT"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Must be one of Boxzooka's documented method codes, e.g. FDX.GRD or UPS.GRD.RESI.","example":"BXZ.PKP"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressBoxzooka"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","name":"Crew Tee - XS / White","quantity":0,"weight":1.5,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemboxzooka"}},"type":{"type":"string","enum":["d2c","b2b","dropship"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"}},"required":["line_items","reference_id","ship_to_address","shipping_method_id","total_price"],"additionalProperties":false,"title":"Boxzooka"},"ShipToAddressCamelot":{"type":"object","properties":{"full_name":{"type":"string","maxLength":30,"description":"","example":"John Doe"},"address1":{"type":"string","maxLength":30,"description":"","example":"123 Main St"},"address2":{"type":"string","maxLength":30,"description":"","example":"Apt 2"},"city":{"type":"string","maxLength":30,"description":"","example":"San Francisco"},"state":{"type":"string","maxLength":30,"description":"","example":"CA"},"postal_code":{"type":"string","maxLength":30,"description":"","example":"94105"},"country":{"type":"string","maxLength":30,"description":"","example":"United States"}},"required":["address1","address2","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressCamelot"},"WmsOrderWriteLineItemcamelot":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemcamelot"},"CreatewmsOrder--Camelot--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","maxLength":30,"description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressCamelot"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemcamelot"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Camelot"},"WmsOrderWriteLineItemcapacity":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemcapacity"},"ShipToAddressCapacity":{"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","address2","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressCapacity"},"CreatewmsOrder--Capacity--":{"type":"object","properties":{"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":{}},"shipping_method_id":{"type":"string","enum":["DHL SmartMail Parcel Expedited Max","DHL SmartMail Parcel Plus Expedited Max","FedEx Home","FedEx 2nd Day Air","UPS Ground Residential","USPS Priority Mail","FedEx Express Saver","UPS 2nd Day Air","UPS 3 Day Select","UPS Next Day Air Saver","FedEx Standard Overnight","Free","3-4 Day","2-3 Day","1-2 Day","FedEx Overnight Saturday Delivery","DHL International Standard","FedEx Priority Overnight","OpenBorder","DHL Parcel International Direct","Customer Pickup","USPS Ground Advantage"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"1-2 Day"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemcapacity"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressCapacity"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"}},"required":["line_items","order_number","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"Capacity"},"ShipToAddressCarton-Cloud":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code"],"additionalProperties":false,"title":"ShipToAddressCarton-Cloud"},"WmsOrderWriteLineItemcarton-cloud":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemcarton-cloud"},"CreatewmsOrder--CartonCloud--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressCarton-Cloud"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemcarton-cloud"}},"service_level":{"type":"string","description":"Requested shipping service level","example":"service_level"},"required_ship_date":{"type":"string","format":"date-time","description":"Required delivery date (YYYY-MM-DD)","example":"2023-03-15T13:45:30Z"}},"required":["line_items","reference_id","ship_to_address","warehouse_customer_id"],"additionalProperties":false,"title":"CartonCloud"},"ClarusCreateOrderShipToAddressClarus":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"customer@example.com"},"phone_number":{"type":"string","description":"","example":"+441234567890"}},"required":["address1","city","full_name"],"additionalProperties":false,"title":"ClarusCreateOrderShipToAddressClarus"},"WmsOrderCreateLineItemclarus":{"type":"object","properties":{"product_id":{"type":"string","description":"The Clarus product id. Use this or `sku`.","example":"108"},"sku":{"type":"string","description":"The product SKU. Use this or `product_id`. Must match exactly one Clarus product.","example":"40116"},"quantity":{"type":"integer","minimum":1,"description":"","example":1}},"required":["quantity"],"additionalProperties":false,"title":"WmsOrderCreateLineItemclarus"},"CreatewmsOrder--Clarus--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"ship_to_address":{"$ref":"#/components/schemas/ClarusCreateOrderShipToAddressClarus"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"108","sku":"40116","quantity":1}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemclarus"}}},"required":["line_items","reference_id","required_ship_date","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Clarus"},"ControlportChannelIdSchema":{"type":"object","properties":{"channel_id":{"type":"string","pattern":"^(\\d+_)?\\d+$","description":"The ID of the channel.","example":"12345"}},"required":["channel_id"],"additionalProperties":false,"title":"ControlportChannelIdSchema"},"CreateOrderShipToAddressControlport":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"+447712356789"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","full_name","phone_number","postal_code"],"additionalProperties":false,"title":"CreateOrderShipToAddressControlport"},"CreateOrderBillToAddressControlport":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"+447712356789"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","full_name","phone_number","postal_code"],"additionalProperties":false,"title":"CreateOrderBillToAddressControlport"},"WmsOrderWriteLineItemcontrolport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":1},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemcontrolport"},"CreatewmsOrder--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ControlportChannelIdSchema"},"type":{"type":"string","enum":["d2c","b2b"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"postage_speed":{"type":"integer","description":"How fast the order should ship. 0 is urgent (fastest, most expensive), 3 is economy (cheapest, slowest).","example":2},"preferred_carrier_id":{"type":"integer","description":"The carrier to prefer when choosing a shipping service for the order.","example":1},"international_duty_paid_by":{"type":"string","enum":["sender","recipient"],"description":"Who pays international duties on the order.","example":"sender"},"invoice_currency_code":{"type":"string","description":"The currency used for this order. If not provided, uses the account default.","example":"GBP"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressControlport"},"bill_to_address":{"$ref":"#/components/schemas/CreateOrderBillToAddressControlport"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemcontrolport"}}},"required":["bill_to_address","channel_object","line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"ShipToAddressDarwynn-Fulfillment":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","address2","city","country","email_address","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressDarwynn-Fulfillment"},"WmsOrderWriteLineItemdarwynn-fulfillment":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemdarwynn-fulfillment"},"CreatewmsOrder--Darwynn__Fulfillment--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"type":{"type":"string","enum":["b2b","d2c"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"service_level":{"type":"string","enum":["Standard","Expedited"],"description":"The type of shipping method requested by the customer. Darwynn courier SLA: Standard or Expedited.","example":"Standard"},"operation_sla":{"type":"string","enum":["Standard","Expedited","Priority"],"description":"Darwynn pick/processing SLA: Standard (24-48h), Expedited (same day), or Priority (3h rush).","example":"Standard"},"signature_required":{"type":"boolean","description":"","example":true},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"note":{"type":"string","description":"","example":"note"},"from_plat_code":{"type":"string","description":"","example":"from_plat_code"},"shop_id":{"type":"string","description":"","example":"shop_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDarwynn-Fulfillment"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdarwynn-fulfillment"}}},"required":["carrier_id","line_items","operation_sla","order_number","required_ship_date","service_level","ship_to_address","type","warehouse_id"],"additionalProperties":false,"title":"Darwynn Fulfillment"},"WmsOrderWriteLineItemdcl":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"custom_field1":{"type":"string","description":"Custom field 1.","example":"custom value"},"custom_field2":{"type":"string","description":"Custom field 2.","example":"custom value"},"custom_field5":{"type":"string","description":"Custom field 5.","example":"custom value"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemdcl"},"ShipToAddressDcl":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressDcl"},"CreatewmsOrder--DCL--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","pattern":"^[^a-z]*$","description":"The order number for the order in DCL. Must be uppercase (letters, digits, '#' or '-', max 25 characters). Auto-generated if not provided.","example":"ORDER-1001"},"freight_account":{"type":"string","description":"Which account to bill for freight. To charge DCL, use 00500, for Collect shipment use 99999, to charge the customer use the customer's account number, to a third party account use 00000. If left blank, the customer's account number will be used.","example":"00500"},"shipping_instructions":{"type":"string","description":"Instructions for the warehouse's distribution clerks. Not printed on the packing list.","example":"Ship with ice packs"},"custom_field1":{"type":"string","description":"Custom field 1.","example":"custom value"},"custom_field2":{"type":"string","description":"Custom field 2.","example":"custom value"},"custom_field3":{"type":"string","description":"Custom field 3.","example":"custom value"},"custom_field4":{"type":"string","description":"Custom field 4. For B2B orders, DCL stores the vendor number here.","example":"custom value"},"custom_field5":{"type":"string","description":"Custom field 5.","example":"custom value"},"shipping_method_id":{"type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52","53","54","55","56","57","58","59","60","61","62","63","64","65","66","67","68","69","70","71","72","73","74","75","76","77","78","79","80","81","82","83","84","85","86","87","88","89","90","91","92","93","94","95","96","97","98","99","100","101","102","103","104","105","106","107","108","109","110","111","112","113","114","115","116","117","118","119","120","121","122","123","124","125","126","127","128","129","130","131","132","133","134","135","136","137","138","139","140","141","142","143","144","145","146","147","148","149","150","151","152","153","154","155","156","157","158","159","160","161","162","163","164","165","166","167","168","169","170","171","172","173","174","175","176","177","178","179","180","181","182","183","184","185","186","187","188","189","190","191","192","193","194","195","196","197","198","199","200","201","202","203","204","205","206","207","208","209","210","211","212","213","214","215","216","217","218","219","220","221","222","223","224","225","226","227","228","229","230","231","232","233","234","235","236","237","238","239","240","241","242","243","244","245","246","247","248","249","250","251","252","253","254","255","256","257","258","259","260","261","262","263","264","265","266","267","268","269","270","271","272","273","274","275","276","277","278","279","280","281","282","283","284","285","286","287","288","289","290","291","292","293","294","295","296","297","298","299","300","301","302","303","304","305","306","307","308","309","310","311","312","313","314","315","316","317","318","319","320","321","322","323","324","325","326","327","328","329","330","331","332","333","334","335","336","337","338","339","340","341","342","343","344","345","346","347","348","349","350","351","352","353","354","355","356","357","358","359","360","361","362","363","364","365","366","367","368","369","370","371","372","373","374","375","376","377","378","379","380","381","382","383","384","385","386","387","388","389","390","391","392","393","394","395","396","397","398","399","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","425","426","427","428","429","430","431","432","433","434","435","436","437","438","439","440","441","442","443","444","445","446","447","448","449","450","451","452","453","454","455","456","457","458","459","460","461","462","463","464","465","466","467","468","469","470","471","472","473","474","475","476","477","478","479","480","481","482","483","484","485","486","487","488","489","490","491","492","493","494","495","496","497","498","499","500","501","502","503","504","505","506","507","508","509","510","511","512","513","514","515","516","517","518","519","520","521","522","523","524","525","526","527","528","529","530","531","532","533","534","535","536","537","538","539","540","541","542","543","544","545","546","547","548","549","550","551","552","553","554","555","556","557","558","559","560","561","562","563","564","565","566","567","568","569","570","571","572","573","574","575","576","577","578","579","580","581","582","583","584","585","586","587","588","589","590","591","592","593","594","595","596","597","598","599","600","601","602","603","604","605","606","607","608","609","610","611","612","613","614","615","616","617","618","619","620","621","622","623","624","625","626","627","628","629","630","631","632","633","634","635","636","637","638","639","640","641","642","643","644","645","646","647","648","649","650","651","652","653","654","655","656","657","658","659","660","661","662","663","664","665","666","667","668","669","670","671","672","673","674","675","676","677","678","679","680","681","682","683","684","685","686","687","688","689","690","691","692","693","694","695","696","697","698","699","700","701","702","703","704","705","706","707","708","709","710","711","712","713","714","715","716","717","718","719","720","721","722","723","724","725","726","727","728","729","730","731","732","733","734","735","736","737","738","739","740","741","742","743","744","745","746","747","748","749","750","751","752","753","754","755","756","757","758","759","760","761","762","763","764","765","766","767","768","769","770","771","772","773","774","775","776","777","778","779","780","781","782","783","784","785","786","787","788","789","790","791","792","793","794","795","796","797","798","799","800","801","802","803","804","805","806","807","808","809","810","811","812","813","814","815","816","817","818","819","820","821","822","823","824","825","826","827","828","829","830","831","832","833","834","835","836","837","838","839","840","841","842","843","844","845","846","847","848","849","850","851","852","853","854","855","856","857","858","859","860","861","862","863","864","865","866","867","868","869","870","871","872","873","874","875","876","877","878","879","880","881","882","883","884","885","886","887","888","889","890","891","892","893","894","895","896","897","898","899","900","901","902","903","904","905","906","907","908","909","910","911","912","913","914","915","916","917","918","919","920","921","922","923","924","925","926","927","928","929","930","931","932","933","934","935","936","937","938","939","940","941","942","943","944","945","946","947","948","949","950","951","952","953","954","955","956","957","958","959","960","961","962","963","964","965","966","967","968","969","970","971","972","973","974","975","976","977","978","979","980","981","982","983"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Must pass in shipping_method_id or shipping_method_name + carrier_id","example":"1"},"shipping_method_name":{"type":"string","enum":["ESU","GROUND-APH","SB POOL DISTRIBUTION","LTL","OSM PREMIUM EXPEDITED","INTL CONSOLIDATE FREIGHT EC","GROUND SERVICE RESIDENTIAL","INTERNATIONAL AIR","2DAY RS","PRIORITY MAIL SR PB","NEXT DAY AIR-SR RS","Priority Mail FRB L PB","TRUCK-3 DAY SELECT","INT IMPORT","First Overnight RES-SR","2ND DAY AIR RESIDENTIAL","INTERNATIONAL PRIORITY","EXPEDITERS","WORLDWIDE EXPRESS-SR","2DAY","Express Worldwide-NDS","EXPRESS ECONOMY","NON CONTINENTAL STANDARD","DCL","Parcel Select","Parcel Select Non-Presort PB","REGULAR 2-4 HOUR","STANDARD INTL.","TRUCKLOAD","3 DAY","FIRST CLASS MAIL","SELECT","GLOBAL FORWARDING","TL","2ND DAY AIR RES-ASR","3DAY","EXPRESS","NEXT DAY AIR EARLY AM SR","STANDARD OVERNIGHT","NEXT DAY AIR EARLY AM","NEXT DAY AIR RESIDENTIAL-ASR","3 DAY SELECT RESIDENTIAL","2DAY AM RS","2DAY-SR","GROUND ADVANTAGE","2ND DAY","GROUND ADVANTAGE SR PB","3DAY RESIDENTIAL","2ND DAY AIR SATURDAY","PRIORITY OVERNIGHT OR","MAIL INNOVATIONS","OVERNIGHT FREIGHT","EXPEDITE","GROUND RESIDENTIAL-RPDCS","SM Parcel Plus Ground","SM Parcel Plus Exp Max RS","AT CARRIER","DEFERRED AIR","PRIORITY OVERNIGHT SATURDAY RE","SAME DAY","STANDARD INTERNATIONAL","First Overnight RESIDENTIAL RS","NEXT DAY AIR SATURDAY RS","NEXT DAY AIR SATURDAY","PRIORITY MAIL ACSR PB","INTERNATIONAL PRIORITY-CSR","TRANSPORTATION INC","PRIORITY OVERNIGHT RESIDENTIAL","GROUND ADVANTAGE ASR PB","2ND DAY AIR SATURDAY-APH","FREIGHT SERVICES","WORLDWIDE EXPEDITED-SR","EXPEDITED TO CANADA","NFO","SERVICE METHOD","INT CUSTOMS BROKERAGE","TX POOL PM","2ND DAY AIR FREIGHT","NEXT DAY AIR SAVER-SR","PRI DDP DC","EXPRESS WORLDWIDE","First Overnight-RPDCS","2ND DAY AIR FREIGHT NGS","TX POOL DISTRIBUTION","STD. INTERSTATE","STANDARD","2DAY OR RS","2DAY FREIGHT","First Overnight RES-ASR","2 DAY SERVICE","EXPRESS SAVER-RPDCS","INTL AIR","2ND DAY AIR RES-SR","STANDARD OVERNIGHT RES-ASR","3DAY RES-ASR","2ND DAY AIR AM -SR","2ND DAY AIR-SR","EXPRESS SAVER CANADA","First Overnight RESIDENTIAL","WORLDWIDE EXPEDITED","GROUND","STD TO CANADA","3 DAY SELECT RESIDENTIAL RS","HOME DELIVERY-CSR","Expedited","PARCEL","Priority Mail FRB XL PB","STANDARD AIR","GROUND-SR","Parcel International Standard","EPKT DDP","Standard Overnight","GUIDE","SPECIAL 1-2 HOUR","CONSIGNEE","PRIORITY MAIL EXPRESS INT PB","NEXT DAY AIR SAVER RES-SR","2ND DAY AIR AM-APH","EXPRESS SAVER","First Overnight RS","OVERNIGHT","GROUND SERVICE COMMERCIAL RS","NEXT DAY AIR EARLY AM-APH RS","1 DAY","EXPRESS AIR","Parcel Select Lightweight","SUNRISE","FREIGHT","FL POOL","GROUND-APH RS","INTERNATIONAL ECONOMY","PRIME","NEXT DAY AIR","3 DAY SELECT-SR","3 DAY SELECT-SR RS","3 DAY SELECT RS","WORLDWIDE EXPRESS SAVER-ASR","AIR STANDARD","NEXT DAY","Priority Mail FRB M PB","INTERNATIONAL GROUND","STANDARD OVERNIGHT RS","STANDARD TO CANADA-SR","FIRST-CLASS PACKAGE INT PB","STANDARD TO CANADA","TRANSPORTATION STANDARD","NEXT DAY AIR SAVER RESIDENTIAL","3RD DAY AIR FREIGHT NGS","COLLECT","RUSH 1-HR DIRECT","NEXTDAY","SAVER","NEXT DAY AIR-SR","FIRST CLASS-SR","Priority Overnight","INT LCL","Room of Choice-PRS","FIRST-CLASS MAIL INTL PB","SPECIAL INTRASTATE CA","PARCEL INTERNATIONAL DIRECT","GROUND DELIVERY","SM Parcel Expedited Max","INTERNATIONAL PRIORITY MPS","PRIORITY MAIL EXPRESS INT","Express Worldwide RESIDENTIAL","1 lb or Greater RESIDENTIAL","3 DAY SELECT RES-SR","NEXT DAY AIR FREIGHT","SEE SHIPPING INSTRUCTIONS","SM Parcel Plus Ground RS","DOOR TO DOOR","NEXT DAY AIR RES-SR","2ND DAY AIR SATURDAY-APH RS","PRIORITY MAIL INT","SM Parcels Expedited RS","3 DAY SELECT RES-ASR","SAMEDAY","Regional","INTERNATIONAL STANDARD DDU","Express Plus","INSIDE DELIVERY","TIMEKEEPER","Through the Door-PRS","2DAY RESIDENTIAL","2DAY RES-SR","STD INTERSTATE","STANDARD TO MEXICO","ECONOMY","SM Parcel Plus Expedited","EXPRESS MAIL ASR PB","HOME DELIVERY-ASR","3 Day","HOME DELIVERY","2ND DAY AIR-SR RS","International Priority","3 DAY SELECT-APH","EXPRESS MAIL PB","PRIORITY OVERNIGHT RES-SR","2ND DAY AIR-APH","NEXT DAY AIR FREIGHT NGS","ECONOMY SERVICE","PRIORITY MAIL EXPRESS PB","3 DAY SELECT","DOMESTIC AIR","To the Door","NEXT DAY AIR RES-ASR","AIR","FCL OCEAN","EXPRESS MAIL INT PB","INTERNATIONAL PRIORITY FREIGHT","EXPRESS MAIL SR PB","PRIORITY OVERNIGHT RES-ASR","HOO","First Overnight","SEE ROUTING GUIDE","PRIORITY OVERNIGHT RESIDENT RS","2ND DAY AIR RS","REDDAWAY INC","WORLDWIDE EXPRESS FREIGHT","2DAY-RPS","STANDARD FREIGHT","3DAY-RPS","PRIORITY OVERNIGHT SATURDAY","NEXT DAY AIR SATURDAY SR","2ND DAY AIR AM","Overnight","PARCEL SELECT","BES","PICKUP","International Document Service","STANDARD OVERNIGHT SR","PRIORITY OVERNIGHT SATURDAY RS","INTERNATIONAL ECONOMY-SR","2ND DAY AIR AM RS","SOUTHERN-US","3DAY RES-SR","Standard","2ND DAY AIR SATURDAY RS","EXPEDIT","3rd DAY","3 DAYS SELECT","NEXT DAY AIR SAVER-APH RS","3 DAY SELECT-APH RS","2DAY RES-ASR","EXPRESS MAIL ACSR PB","2DAY AM","NEXT DAY AIR RESIDENTIAL","NEXT DAY AIR RESIDENTIAL RS","STANDARD OVERNIGHT RESIDEN RS","DOMESTIC GROUND","2ND DAY AIR-APH RS","Express Worldwide","RETAIL GROUND PB","INTERNATIONAL PRIORITY-SR","Priority Mail FRB ENV PB","NEXT DAY AIR SATURDAY RESIDENT","NEXT DAY AIR-PRS","PRIORITY OVERNIGHT RES-CSR","GROUND SERVICE COMMERCIAL","STANDARD INTL","INTERNATIONAL ECONOMY FREIGHT","GROUND RESIDENTIAL RS","PRIORITY MAIL RS PB","Expedited Canada","STANDARD OVERNIGHT-RPS","3RD DAY AIR FREIGHT","PRIORITY MAIL PB","GROUND ADVANTAGE PB","PRIORITY OVERNIGHT -SR","Expedited to Canada","First Overnight Freight","GROUND ADVANTAGE RS PB","SCH","EXPRESS PREMIUM","International Economy","INTERNATIONAL","2ND DAY AIR SATURDAY-PRS","3-5 DAY","International","2DAY RES-CSR","PRIORITY","EXPRESS SAVER FREIGHT","STANDARD OVERNIGHT OR","2DAY AM OR","GROUND SERV RESIDENTIAL-SR RS","CARGO LOGISTICS","AIR EXPRESS","INTERNATIONAL CONNECT PLUS-SR","Ground Economy Standard Mail","NEXT DAY AIR EARLY AM RS","WORLDWIDE","STD INTRASTATE","STANDARD PREMIUM DDP","TX POOL FLEX","INTERNATIONAL PARCELS","DEFERRED 3-5 DAY","WORLDWIDE EXPRESS SAVER-SR","OSM PREMIUM","GROUND SERVICE RESIDENTIAL RS","STANDARD INTRASTATE CA","FIRST CLASS","EXPRESS SAVER RESIDENTIAL","PRIORITY EXPRESS","GROUND SERVICE","2ND DAY AIR","2DAY-RPDCS","2 Day","2DAY OR","INT CUSTOMS CLEARANCE","2ND DAY AIR RESIDENTIAL RS","LIGHTWEIGHT PARCEL","EXPRESS SAVER SR","First Overnight-RPS","2DAY SAT OR","GROUND SERVICE COMMERCIAL-PRS","Priority Mail FRB S PB","SM Parcels Ground","LIVE LOAD FREIGHT","EXPRESS CANADA","TEST","WORLDWIDE EXPRESS","FIRST CLASS PACKAGE INT","Less than 1 lb RESIDENTIAL","HOME DELIVERY-SR","STANDARD OVERNIGHT RESIDENTIAL","PRIORITY MAIL","WAREHOUSE-LTL","EXPRESS SAVER RESIDENTIAL RS","SUNRISE GOLD","AIR FREIGHT DIRECT INT","FIRST OVERNIGHT OR","CA POOL W2","2DAY RESIDENTIAL RS","PRIORITY OVERNIGHT-RPDCS","STANDARD OVERNIGHT-RPDCS","NEXT DAY AIR SAVER","OCEAN","USPS PARCEL SELECT","EXPRESS SAVER-RPS","LTL FREIGHT","EXPRESS SAVER RES-SR","Priority Mail International PB","INTERNATIONAL ECONOMY-CSR","AIR FREIGHT CONSOLIDATED INT","NIE","INTERNATIONAL CONNECT PLUS","INT FCL","GROUND-ASR","INTERNATIONAL STANDARD DDP","EXPRESS SAVER OR","Ground Economy PS","STANDARD OVERNIGHT RES-SR","3DAY RES-CSR","INT DOOR TO DOOR","EXPRESS SAVER RS","STD INTRASTATE CA","INT EXPORT","3DAY FREIGHT","CANADA","Ground","AM","2ND DAY AIR-PRS","EXPEDITED","GROUND SERVICE COMMERCIAL-SR","NEXT DAY AIR EARLY AM-APH","Parcel Select Ground PB","PRIORITY OVERNIGHT RS","GROUND RESIDENTIAL","TX POOL AM","3DAY RS","GROUND SERVICE RES-SR","NEXT DAY AIR SATURDAY-PRS","PRIORITY OVERNIGHT","NEXT DAY AIR-APH","2ND DAY AIR SATURDAY RESIDENT","GROUND RESIDENTIAL-RPS","INTERNATIONAL ECONOMY - MPS","LOCAL","3DAY-RPDCS","TRUCK-GROUND","Economy","WORLDWIDE EXPRESS SAVER","2 DAY","EXPRESS SAVER RES-ASR","STANDARD ABQR","STANDARD OVERNIGHT RES-CSR","HOME DELIVERY-RPDCS","PRIORITY MAIL ASR PB","SM Parcel Expedited Max RS","GROUND SERVICE RES-ASR","XPRESSPOST","STANDARD INTERSTATE","INTERNATIONAL CONNECT PLUS-CSR","URGENT","DG Routing","International Air","AIR FREIGHT","NEXT DAY AIR SAVER RS","LCL OCEAN","3DAY RESIDENTIAL RS","NEXT DAY AIR SATURDAY-APH","FIRST-CLASS MAIL PB","2ND DAY AIR AM-APH RS","INTL CONSOLIDATE FREIGHT PR","HOME DELIVERY RS","NEXT DAY AIR SAVER-PRS","EXPRESS SAVER RES-CSR","Expedited Parcel Select","VALUE EXPRESS","WORLDWIDE EXPRESS-ASR","NEXT DAY AIR SATURDAY-APH RS","SM Parcels Expedited","SYSTEMS","Packet International","LIFTGATE","HOME DELIVERY-RPS","GROUND EXPEDITED","CA POOL W1","NEXT DAY AIR-APH RS","WORLDWIDE EXPEDITED-ASR","1DAY FREIGHT","BEST WAY RATE","FTL","PRIORITY OVERNIGHT-RPS","SPECIAL DELIVERY","NEXT DAY AIR SAVER RES-ASR","FIRST CLASS-ASR","SM Parcel Plus Expedited Max","NEXT DAY AIR EARLY AM-SR RS","First Overnight RES-CSR","WORLD EASE","TRANSPORTATION","PRI DDU DC","3 DAY SELECT-PRS","3 DAY SERVICE","INTERNATIONAL MANUAL","NEXT DAY AIR SAVER-APH","NEXT DAY AIR RS","DIRECT","GROUND RS","GROUND SERVICE RESIDENTIAL-PRS","SM Parcel Plus Expedited RS"],"description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. Must pass in shipping_method_id or shipping_method_name + carrier_id","example":"1 DAY"},"carrier_id":{"type":"string","enum":["SPECIALTY LOGISTICS","ONTRAC","LTL","ARAMEX INTERNATIONAL COURIERS","MAGELLAN TRANSPORT LOGISITCS","ECHO GLOBAL LOGISTICS","USPS","THE TRANSPORT COMPANY","ALYBRE TRUCKING","UNIUNI","Federal Express","R&B","GILBERT COMPANY","MACH 1 GLOBAL","US GROUP CONSOLIDATOR","Great World Express","HUB HIGHWAY","DBSH","ESTES EXPRESS LINES","FLEXPORT","ARAMEX","USA TRUCK BROKERAGE","GEFCO COURIER","JB HUNT","LETAREMAN INC","NEWGISTICS","WARREN TRANSPORT","WALMART","ES EXPRESS","LOADMASTER","ALPHA HOLDING","AERONET","DYNASTY CUSTOMS BROKER INC","CORTRANS","PILOT","VALENCIA TRANSPORT SERVICE INC","REALWAY","ARRIVE LOGISTICS","ITF GROUP","EXPEDITORS INTL","U FREIGHT","PROTRANS INTERNATIONAL","MAINFREIGHT INTERNATIONAL","MORRISON EXPRESS CORP","SIGNATURE SUPPLY","SPEEDMARK","TOTAL QUALITY LOGISTICS","RJW","ADELCAR","CANADIAN FREIGHTWAYS","OLD DOMINION","INXPRESS","WHITACRE INTERMODAL","DYNAMIC EXPRESS","ESTENSON LOGISTICS","UPS SurePost","HUB DEDICATED","TIA CHAPIS TRANSPORTATION LLC","DHL Global Mail","SWIFT LOGISTICS","NATIONAL RETAIL TRANSPORTATION","M AND W LOGISTICS","Corporate Traffic TL","CEVA","KOHLS 855 BACKHAUL GALE","AMAZON FREIGHT","MAIL ON THE MOVE","HERCULES","WORLD ASIA","MARANATHA TRANSPORTATION","CALTOP LOGISTICS","ROADRUNNER","SONICA","AirOne Logistics","HOLD","CANADIAN SERVICE","SUNSET PACIFIC TRANSPORTATION","CURRENT EXPRESS","PITNEY BOWES","AMAZON","OMNI LOGISTICS","ASTEC LOGISTICS","AMZ_US_PREMIUM_SWA","UPS SUPPLY CHAIN SOLUTIONS","FE TRUCKLOAD","EAGLE","UPS Access Point","CONCORD","Home Direct","CITY TRANSPORT","TRIAD","KINTETSU WORLD EXPRESS","USF REDDAWAY","PGL","ADAMS THIRD WAVE","CANPAR","LANDMARK","HUB INTERMODAL","TRANSCON","KULAR ENTERPRISES INC","TFORCE FREIGHT","UNYSON LOGISTICS","Claude Laguerre Transport","USPS_ATS_BPM","WILL CALL","AIT WORLDWIDE LOGISTICS","10G LOGISTICS","URBAN FREIGHT","SCHENKER","CLOCK","ESTES LEVEL 2","AOC FREIGHT CORPORATION","ACE FLEET","ROCHESTER ART CLUB","PANALPINA","CTE","CANADIAN TIRE","ESL EXPRESS","USA FULGER TRANSPORT","COVENANT TRANSPORT","JW LOGISTICS","GEODIS","MOTO TRANSPORTATION","STREAMLINE INC","STG LOGISTICS","FREIGHT LOGISTICS","JC MARTINEZ TRUCKING","ALGON TRANSPORT INC","USPS_ATS_STD","OAK HARBOR","ONE SOURCE","AAA COOPER","UNI-TRADE BROKERS LOGISTICS","JL BARR TRUCKING","STR GROUP","SONDH FREIGHT SYSTEMS","FRONTLINE FREIGHT","HOLLAND MOTOR EXPRESS","BRENTWOOD DRIVE","ARMSTRONG TRANSPORT","ORANGE COURIER","CIRCLE LOGISTICS","ULTRA EX","AMZ_US_LMA","KNIGHT TRANSPORTATION INC","JAEZRA TRANSPORT","DUPRE LOGISTICS","SHIFT FREIGHT","CON-WAY","PONCE GROUND SERIVE","FALCON GLOBAL EDGE","AIRGROUP","BA CARRIER INC","GORDON TRUCKING","INTELLITRANS LLC","ROADWAY EXPRESS","CORNERSTONE","VFR TRANSPORT","HUB GROUP","KUEHNE AND NAGEL","GALE TRIANGLE","TOTAL TRANSPORTATION","HG FORWARDING","RHENUS LOGISTICS","CH ROBINSON WORLDWIDE","CENTRAL TRANSPORT","ACB","TNT","SEE SHIPPING INSTRUCTIONS","UPS Mail Innovations","FARREX FREIGHT","TRI-AD","DAY AND ROSS","CSA TRANSPORTATION","OTX LOGISTICS","HUB GROUP CENTRAL TRANSPORT","E&A TRANSPORT LLC","EU CARRIER","WALMART FLEET","MODE TRANSPORTATION","INTERMARK TRANSPORT","CH ROBINSON","ROHLIG","ALLIANCE SHIPPERS","TROPICAL SHIPPING","PROGRESSIVE LOGISTICS","KGL AMERICA","YRC INC","UNIS TRANSPORTATION","BNSF LOGISTICS","BLM TRANSPORTATION","JIT","LIVE LOGISTICS","SOUTHEASTERN FREIGHT","TRANSFIX","UBER FREIGHT","EXPRESS LINE","MIDWEST EXPRESS","ENGLAND LOGISTICS","JSI","UPS Ground Saver","WEBTRANS","DPD/BES","OSM","WESTERN DIRECT EXPRESS","MAERSK LOGISTICS","PASSPORT","CRANE WW","USF","EXPRESS FREIGHT SYSTEM","USA TRUCK","VZ TRANSPORTATION INC","ADCOM WORLDWIDE LAX","WEST COAST","EASYPOST USPS","CALIFORNIA OVERNIGHT","JB HUNT CENTRAL TRANSPORT","DHL","TRANS EXPEDITE","COOL RUNNINGS INC","EXPRESS AIR FREIGHT","PRECISION TRUCK LINES","AMERICAN FREIGHTWAYS","ASSOCIATED GLOBAL SYSTEMS","DBSCHENKER","CONWAY","LAB CARRIER","MAV TRANSPORTATION","USF BESTWAY","SEE ROUTING GUIDE","FORWARD AIR","HILTON TRANSPORT","PORTLINK USA","WESTERN EAGLE FOUNDATION","YRC","LYNDEN","ALFA LOGISTICS","AIT WORLWIDE LOGISTICS","ATL TRANSPORTATION INC","CAVALIER LOGISTICS","GREAT AMERICAN TRANS","Pacer Group IM","FEDEX TRUCKLOAD BROKERAGE","GENTRANS CARGO EXPRESS","U GOT IT TRANSPORT","KNICHEL LOGISTICS","BESTUSA","ALL CARTAGE","PLATINUM","TRUMP CARD","UPS","MARITIME-ONTARIO FREIGHT","MSM TRANSPORTATION INC.","PACE AIR FREIGHT","AIRWAVES","ABNT","BEST OVERNITE EXPRESS","BAX GLOBAL","R&L CARRIERS INC","FNS INC","FREIGHTQUOTE.COM","AMZ_US_BULK","RELAY LOAD BOARD","PILOT PORTLAND","CUSTOMER","VITRAN","ESTES LOGISTICS","AMERIKA LAND","RAIL DELIVERY","ICAT LOGISTICS","WILL CALL GLOBAL-E","MOUNTAIN VALLEY EXPRESS","TRUCKLAND INC","PTL FREIGHT FORWARDERS","MAINFREIGHT","WESHIP","CLICK4TRUCK","EASE LOGISTICS","AIT","NIPPON EXPRESS","PRIMARY FREIGHT SERVICE","CVS HEALTH DISTRIBUTION CENTER","SUNNY EXPR","DAYTON FREIGHT","FITZMARK TRUCKING","COMTRAK LOGISTICS","SPEEDX","PUROLATOR COURIER","B2C/WEE","R&L TRANSFER","CONVOY","ALTRIA","PREMIER LOGISTICS","CLEAR LANE FREIGHT SYSTEMS","POLARIS","DYNASTY","CTS","CALIFORNIA SIERRA EXPRESS","GARRY MERCER","MARTINEZ ENTERPRISE","ABF","NEXZIS","DEL MAR USA","DEPENDABLE HIGHWAY EXPRESS","ONEATOS TRUCKING","TRU58","NEXT TRUCKING","G & I LOGISTICS","KCC TRANSPORT","PRIORITY","UTI","JOHNNY AIR CARGO","SFO EXPRESS","HEARTLAND EXPRESS","VRTX LOGISTICS","KEYSTONE DEDICATED","AMZ_US_PREMIUM","DSV","SPOT","NFI INDUSTRIES","HORIZON INTL CARGO","APORTILLOTRANSPORTLLC","GREATWIDE AMERICAN TRANS","FLAVOR CLOUD","FEDEX FREIGHT","SHIPCO TRANSPORTATION","GLOBAL TRANZ","DUNBLARE IPORT EXPORT","POS","KUEHNE+NAGEL","INTERNATIONAL BRIDGE","TEAM WORLDWIDE","C AND S TRANSPORTATION","WATCO SUPPLY CHAIN","MILGRAM","BEST DELIVERY SERVICES","ALLSTATE INT FREIGHT","BULLET TRANSPORT","YUSEN","JB HUNT INTERMODAL","NATIONAL CONSOLIDATION SERVICE","RE TRANSPORTATION","INTEGRITY LOGISTICS","GALEX LOGISTICS","CSX INTERMODAL TERMINALS","WORLDWIDE EXPRESS","PERIMETER GLOBAL","TARGET LOGISTICS","CANADA POST","RHAPSODY NAVIGATION LIMITED","EXPEDITORS","CALSIERRA","ULTRA LOGISTICS","SAIA","DIMERCO EXPRESS SINGAPORE","WERNER ENTERPRISE","XPO LOGISTICS","SEAAIR","ALD LOGISTICS","S&J","STERLING","ASR TRANSPORTATION","PRIORITY1","WRDS","WHITE ARROW","SEKO LOGISTICS","W AND D","AXIZ","BAY CITY","ORANGECOURIER","BTX GLOBAL LOGISTICS","AVERITT EXPRESS","PEGASUS","DCL14","RHEOUS","SEKO WORLDWIDE","ROUTING","SWIFT DEDICATED","LOADSMART","DMX LOGISTICS","SERVICE PLUS TRANS","INSTICO GLOBAL LOGISTICS","PAM TRANSPORT","WATCHPOINT LOGISTICS","MC CARGO","WESTERN REGIONAL DELIVERY","FEED THE CHILDREN","INTERCARGO","FGE Inc.","CEVA LOGISTICS","NISSIN","CONVOY INTERSTATE","KWE","UPS FREIGHT","AMERICAN GLOBAL","GLOBALE","DART EXPRESS","CENTRAL FREIGHT LINES","SELECTSHIP","KAMINO","PREMIERE LOGISTICS","DIGITAL RIVER","APC_DCL","CRANE","JTS LOGISTICS","OMNI","DPD","DLS WORLDWIDE","FEDEX CUSTOM CRITICAL","DYNAMIC LTL","MAKO WAVES DISTRIBUTION","JD GLOBAL LOGISTICS","CALIFORNIA TRANSPORT","K LINE","XPRESS GLOBAL SYSTEMS","GULF RELAY","CAL STATE EXPRESS","ABILENE MOTOR EXPRESS","TRAFFIC TECH","SWIFT TRANSPORTATION","SONICAIR","NEW LEGEND","JOHANSON","SUPERCARGO","HELLMANN WORLDWIDE LOGISTICS","NORCON","UNIVERSAL TRUCK LOAD INC","MEGA FLEET CORP","FEDEX","FEDEX TRUCKLOAD","GSC LOGISTICS","FREIGHTSAVER","USPS_ATS_PARCEL","DCL DELIVERY","EPES LOGISTICS","EAGLE USA","TST OVERLAND EXPRESS","NATIONAL RETAIL SYSTEMS","ANC INTERNATIONAL","SURE SHOT TRANSIT SOLUTIONS","COYOTE LOGISTICS","KINETIC","CENTRAL TRANSPORT INC","DAYLIGHT TRANSPORT","AGILITY INTL LOGISTICS","PITT OHIO EXPRESS","OPC TRUCKING","US XPRESS","JMZ TRANSPORT","DYNAMEX OPERATIONS","USF HOLLAND","RXO","JAS FORWARDING","AO FREIGHT","AMAZON LOGISTICS INC","BEST WAY RATE","UNYSON","American Worldwide Agencies","FEDEX EXPRESS FREIGHT","HEAVEN","SUNTECK TRANSPORT","SCHNEIDER NATIONAL CARRIERS","NEXTRANS","TRANSGROUP","AMAZON FREIGHT EXCHANGE NETWOR","UPS LTL","CUSTOM COMPANIES","ESTES FORWARDING WORLDWIDE","UPDIKE DISTRIBUTION LOGISTICS","WESTERN EXPRESS","RED LOGISTICS","TLW FREIGHT","PUROLATOR LTL","ZNS CARGO","DTS","DHL DANZAS","PERFORMANCE TEAM GALE TRIANGLE","UPS CANADA","AVILA TRUCKING","TRANSPLACE"],"description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Must pass in shipping_method_id or shipping_method_name + carrier_id","example":"FEDEX"},"warehouse_id":{"type":"string","enum":["FR","LA","LN","YK","EX","EU","KY"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"EU"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"custom_field1":"custom value","custom_field2":"custom value","custom_field5":"custom value"}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdcl"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDcl"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"DCL"},"ShipToAddressDear-Systems":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressDear-Systems"},"BillToAddressDear-Systems":{"type":"object","properties":{"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","postal_code","state"],"additionalProperties":false,"title":"BillToAddressDear-Systems"},"WmsOrderWriteLineItemdear-systems":{"type":"object","properties":{"product_id":{"type":"string","description":"","example":"product_id"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"tax":{"type":"number","description":"","example":0.0}},"required":["product_id","quantity","tax","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemdear-systems"},"CreatewmsOrder--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDear-Systems"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressDear-Systems"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","quantity":0,"unit_price":0.0,"tax":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdear-systems"}}},"required":["warehouse_id"],"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"ShipToAddressDelmarcargo":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code"],"additionalProperties":false,"title":"ShipToAddressDelmarcargo"},"WmsOrderCreateLineItemdelmarcargo":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemdelmarcargo"},"CreatewmsOrder--Delmar--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"invoice_currency_code":{"type":"string","default":"USD","description":"The currency of the line item unit prices.","example":"USD"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDelmarcargo"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemdelmarcargo"}}},"required":["line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Delmar"},"OrderShipToAddressCreateDeposco":{"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"}},"required":["address1","city","country","full_name"],"additionalProperties":false,"title":"OrderShipToAddressCreateDeposco"},"LineItemNotes":{"type":"object","properties":{"title":{"type":"string","description":"Title of the note","example":"title"},"body":{"type":"string","description":"Body of the note","example":"body"}},"additionalProperties":false,"title":"LineItemNotes"},"WmsOrderWriteLineItemdeposco":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"notes":{"type":"array","description":"List of notes for this line item","example":[{"title":"Note Title","body":"Note Body"}],"items":{"$ref":"#/components/schemas/LineItemNotes"}}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemdeposco"},"ChannelId":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"ChannelId"},"ChannelName":{"type":"object","properties":{"channel_name":{"type":"string","description":"The name of the channel.","example":"channel_name"}},"required":["channel_name"],"additionalProperties":false,"title":"ChannelName"},"ChannelSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/ChannelId"},{"$ref":"#/components/schemas/ChannelName"}],"discriminator":{"propertyName":"type","mapping":{"id":"#/components/schemas/ChannelId","name":"#/components/schemas/ChannelName"}},"title":"ChannelSchema"},"Notes":{"type":"object","properties":{"title":{"type":"string","description":"Title of the note","example":"title"},"body":{"type":"string","description":"Body of the note","example":"body"}},"required":["body","title"],"additionalProperties":false,"title":"Notes"},"CreatewmsOrder--Deposco--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/OrderShipToAddressCreateDeposco"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"unit_cost":0.0,"notes":[{"title":"Note Title","body":"Note Body"}]}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdeposco"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"cancel_by_ship_date":{"type":"string","format":"date-time","description":"Date to cancel the order by","example":"2023-10-01T00:00:00Z"},"custom_attribute_1":{"type":"string","description":"Custom attribute 1","example":"Custom attribute 1"},"custom_attribute_2":{"type":"string","description":"Custom attribute 2","example":"Custom attribute 2"},"custom_attribute_6":{"type":"string","description":"Custom attribute 6","example":"Custom attribute 6"},"custom_attribute_7":{"type":"string","description":"Custom attribute 7","example":"Custom attribute 7"},"order_type":{"type":"string","default":"Sales Order","enum":["Sales Order","Outbound Transfer Order"],"description":"The type of Deposco order, defaults to Sales Order.","example":"Sales Order"},"freight_account_number":{"type":"string","description":"The freight account number.","example":"123456789"},"notes":{"type":"array","description":"List of the custom fields","example":[{"title":"Note Title","body":"Note Body"}],"items":{"$ref":"#/components/schemas/Notes"}}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Deposco"},"ShipToAddressDistribution-Management":{"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressDistribution-Management"},"WmsOrderWriteLineItemdistribution-management":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemdistribution-management"},"CreatewmsOrder--Distribution__Management--":{"type":"object","properties":{"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":{}},"type":{"type":"string","enum":["d2c","b2b","Dealer Dropship"],"description":"The type of order","example":"Dealer Dropship"},"comment":{"type":"string","description":"The comment to add to the order","example":"This is a test comment"},"confirmation_email":{"type":"string","description":"The email address to send the confirmation to","example":"email@email.com"},"warehouse_id":{"type":"string","enum":["2","3","4","6","8"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"2"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDistribution-Management"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdistribution-management"}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"customer_po_number":{"type":"string","description":"The customer PO number","example":"customer_po_number"},"ship_window_start_date":{"type":"string","format":"date-time","description":"The date to start the shipping window","example":"2023-03-15T13:45:30Z"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"retailer_id":{"type":"string","description":"The retailer ID DM assigned to the retailer this order is for","example":"644"}},"required":["line_items","order_number","ship_to_address","type"],"additionalProperties":false,"title":"Distribution Management"},"ShipToAddressDotcom-Distribution":{"type":"object","properties":{"full_name":{"type":"string","maxLength":40,"description":"","example":"John Doe"},"company":{"type":"string","maxLength":40,"description":"","example":"Company"},"address1":{"type":"string","maxLength":40,"description":"","example":"123 Main St"},"address2":{"type":"string","maxLength":40,"description":"","example":"Apt 2"},"city":{"type":"string","maxLength":40,"description":"","example":"San Francisco"},"state":{"type":"string","maxLength":40,"description":"","example":"CA"},"postal_code":{"type":"string","maxLength":40,"description":"","example":"94105"},"country":{"type":"string","maxLength":40,"description":"","example":"United States"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressDotcom-Distribution"},"WmsOrderWriteLineItemdotcom-distribution":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemdotcom-distribution"},"CreatewmsOrder--Dotcom__Distribution--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","maxLength":20,"description":"A user-friendly identifier for their order.","example":"order_number"},"shipping_method_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"total_tax":{"type":"number","description":"The total tax on the order.","example":1.5},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDotcom-Distribution"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdotcom-distribution"}}},"required":["line_items","order_number","ship_to_address","shipping_method_id","total_price","total_shipping","total_tax"],"additionalProperties":false,"title":"Dotcom Distribution"},"WmsOrderWriteLineItemelite-ops":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemelite-ops"},"ShipToAddressElite-Ops":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressElite-Ops"},"CreatewmsOrder--Elite__Ops--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemelite-ops"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressElite-Ops"},"shipping_method_id":{"type":"string","enum":["122","125","126","129","130","308","309","310","311","312","128","69","102","106","11","13","135","14","20","200","21","37","39","40","44","52","53","54","55","56","57","58","59","67","307","0","305","306","301","302","5","8","10","9","6","4","7","121OPP","121LOP","12","48","50","81P"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"0"},"shipping_method_name":{"type":"string","enum":["DHL GLOBAL MAIL-EXPEDITED","DHL GM PACKET PLUS","DHL XPARCEL GROUND","DHL PARCEL DIRECT PLT DDP","DHL PARCEL DIRECT PLT DDU","BUKUSHIP - DHL PARCEL EXPEDITED","BUKUSHIP - DHL PARCEL GROUND","BUKUSHIP - DHL PARCEL INTERNATIO","BUKUSHIP - DHL PARCEL PRIORITY","BUKUSHIP - DHL PACKET PRIORITY","DHL EXPRESS WORLDWIDE LETTER","DHL Express Worldwide (nondoc)","FedEx Smartpost","Amazon Prime","FedEx Express Saver (3 day)","FedEx Ground","FedEx Home Delivery w/ Signature","Fedex Home Delivery","FedEx 2 day","FedEx Ground Canada","Fedex First Overnight","FedEx Saturday","FedEx Priority Overnight","FedEx Standard Overnight","FedEx International Priority","FedEx 2 Day Freight","FedEx 3 Day Freight","FedEx Ground w/Signature","FedEx Priority Overnight w/Signa","FedEx Standard Overnight w/Sign","FedEx 2 day w/Signature","FedEx Express Saver w/Signature","FedEx International Economy","FedEx Express Saver w/Signature","Global-e","Unassigned","Parcel Priority DDU","Parcel Priority DDP","BUKUSHIP - USPS PRIORITY MAIL IN","BUKUSHIP - USPS COMMERICAL EPACK","UPS Next Day Air","UPS 2nd Day Air","UPS Ground","UPS 3 Day Select","UPS Next Day Air Saver","UPS Next Day Air Early AM","UPS 2nd Day Air AM","UPS SurePost 1 or More","UPS SurePost less 1 LB","UPS Home Delivery","USPS Priority Mail","USPS First Class Mail","FLAT RATE PADDED ENVELOPE"],"description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Elite Ops"},"ShipToAddressEshipping":{"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","postal_code"],"additionalProperties":false,"title":"ShipToAddressEshipping"},"WmsOrderWriteLineItemeshipping":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemeshipping"},"CreatewmsOrder--eShipping--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"Facility code to ship from","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressEshipping"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemeshipping"}},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"priority":{"type":"string","default":"0","enum":["0","A","S"],"description":"Order priority. Defaults to '0' (normal)","example":"0"},"ship_type":{"type":"string","default":"S","enum":["S","L","T"],"description":"Shipment type. Defaults to 'S' (small parcel)","example":"S"},"shipment_terms":{"type":"string","default":"PPD","enum":["PPD","COL","3RD"],"description":"Shipment terms. Defaults to 'PPD' (prepaid)","example":"PPD"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"}},"required":["line_items","order_number","reference_id","required_ship_date","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"eShipping"},"ShipToAddressEvolve":{"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressEvolve"},"WmsOrderCreateLineItemevolve":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","minimum":1,"description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemevolve"},"CreatewmsOrder--Evolve--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressEvolve"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemevolve"}}},"required":["line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"Evolve"},"ShipToAddressExtensiv":{"type":"object","properties":{"full_name":{"type":"string"},"company":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"country":{"type":"string"},"email_address":{"type":"string"},"phone_number":{"type":"string"}},"required":["address1","city","country","postal_code"],"additionalProperties":false,"title":"ShipToAddressExtensiv"},"CustomField":{"type":"object","properties":{"name":{"type":"string","description":"Name of the custom field","example":"name"},"value":{"type":"string","description":"Value of the custom field","example":"value"}},"required":["name","value"],"additionalProperties":false,"title":"CustomField"},"WmsOrderWriteLineItemextensiv-3pl-central":{"type":"object","properties":{"product_id":{"type":"string","description":"","example":"product_id"},"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"custom_fields":{"type":"array","description":"List of the custom fields","example":[{"name":"CustomField","value":"CustomValue"}],"items":{"$ref":"#/components/schemas/CustomField"}}},"required":["quantity"],"additionalProperties":false,"title":"WmsOrderWriteLineItemextensiv-3pl-central"},"BillToAddressExtensiv":{"type":"object","properties":{"full_name":{"type":"string"},"company":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"country":{"type":"string"},"retailer_id":{"type":"integer","description":"Retailer ID to bill the order to","example":0}},"required":["address1","city","country","postal_code","state"],"additionalProperties":false,"title":"BillToAddressExtensiv"},"CreatewmsOrder--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressExtensiv"},"billing_code":{"type":"string","enum":["default_Prepaid","default_FreightCollect","default_BillThirdParty","fedex_collect","fedex_recipient","fedex_sender","fedex_third_party","ups_BillThirdParty","ups_ConsigneeBilled","ups_FreightCollect","ups_Prepaid"],"description":"Billing Type","example":"default_BillThirdParty"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"carrier_account_number":{"type":"string","description":"Carrier account number to bill freight against (e.g. for third-party billing).","example":"carrier_account_number"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":0,"unit_price":0.0,"custom_fields":[{"name":"CustomField","value":"CustomValue"}]}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemextensiv-3pl-central"}},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"custom_fields":{"type":"array","description":"List of the custom fields","example":[{"name":"CustomField","value":"CustomValue"}],"items":{"$ref":"#/components/schemas/CustomField"}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"total_discount":{"type":"number","description":"The total amount discounted from the order.","example":2.5},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"total_tax":{"type":"number","description":"The total tax on the order.","example":1.5},"gift_message":{"type":"string","description":"Gift message","example":"gift_message"},"earliest_ship_date":{"type":"string","format":"date-time","description":"The projected ship date of the order","example":"2023-03-15T13:45:30Z"},"ship_cancel_date":{"type":"string","format":"date-time","description":"Ship cancel date","example":"2023-03-15T13:45:30Z"},"purchase_order_number":{"type":"string","description":"Purchase order number","example":"purchase_order_number"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressExtensiv"},"notes":{"type":"string","description":"Notes","example":"notes"}},"required":["line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"ShipToAddressFba":{"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressFba"},"WmsOrderCreateLineItemfba":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemfba"},"CreatewmsOrder--Amazon--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"displayable_order_comment":{"type":"string","description":"","example":"displayable_order_comment"},"service_level":{"type":"string","enum":["Standard","Expedited","Priority"],"description":"The type of shipping method requested by the customer.","example":"Standard"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressFba"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemfba"}}},"required":["displayable_order_comment","line_items","order_number","service_level","ship_to_address"],"additionalProperties":false,"title":"Amazon"},"CreateOrderFedex-Fulfillment":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"},"store_number":{"type":"string","description":"","example":"store_number"}},"required":["address1","city","company","country","email_address","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"CreateOrderFedex-Fulfillment"},"WmsOrderWriteLineItemfedex-fulfillment":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"vendor_sku":{"type":"string","description":"","example":"vendor_sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemfedex-fulfillment"},"Fedex-FulfillmentChannelIdSchema":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"Fedex-FulfillmentChannelIdSchema"},"CreatewmsOrder--FedEx__Fulfillment--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderFedex-Fulfillment"},"warehouse_id":{"type":"string","enum":["HFY","FCA"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"FCA"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","vendor_sku":"vendor_sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemfedex-fulfillment"}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/Fedex-FulfillmentChannelIdSchema"},"type":{"type":"string","description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Only used when ship type is PCL","example":"fedex_ground"},"ship_type":{"type":"string","enum":["LTL","PCL"],"description":"","example":"LTL"},"purchase_order_number":{"type":"string","description":"","example":"purchase_order_number"}},"required":["line_items","order_number","ship_to_address","ship_type","type","warehouse_id"],"additionalProperties":false,"title":"FedEx Fulfillment"},"ShipToAddressFfe":{"type":"object","properties":{"company":{"type":"string","description":"","example":"Company"},"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"},"first_name":{"type":"string","description":"The first name of the recipient.","example":"first_name"},"last_name":{"type":"string","description":"The last name of the recipient.","example":"last_name"},"phone":{"type":"string","pattern":"\\d{3}-\\d{3}-\\d{4}$","description":"The phone number of the customer.","example":"111-111-1111"},"email":{"type":"string","pattern":"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$","description":"The email address of the customer.","example":"johnsmith@gmail.com"}},"required":["address1","city","company","country","first_name","last_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressFfe"},"WmsOrderCreateLineItemffe":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"external_id":{"type":"string","description":"The retail item number for this line item","example":"retail item number"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemffe"},"CreatewmsOrder--FFE--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressFfe"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"external_id":"retail item number"}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemffe"}},"notes":{"type":"array","description":"List of notes associated with the order.","example":["note_1","note_2"],"items":{"type":"string","description":"A note associated with the order.","example":"note"}},"purchase_order_number":{"type":"string","description":"The purchase order number associated with the order.","example":"PO123"},"is_edi":{"type":"boolean","description":"Whether the order is an EDI order.","example":false},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Maps to FFE's PreferredCarrierId. Use GET /wms/shipping-methods (carrier_id) to find valid IDs. If omitted, the carrier is inferred from the shipping_method_id composite.","example":"fedex"},"shipping_method_id":{"type":["string","null"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Maps to FFE's PreferredCarrierServiceTypeId. Pass the id field returned by GET /wms/shipping-methods, which has the composite format '{carrier_id}-{service_type_id}'. A bare service_type_id (e.g. '21') is also accepted, in which case carrier_id should be supplied separately.","example":"fedex_ground"}},"required":["line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"FFE"},"WmsOrderCreateLineItem":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItem"},"CreatewmsOrder--Finale--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItem"}}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Finale"},"ShipToAddressFlexport":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number.","example":"phone_number"},"email_address":{"type":"string","description":"The email address.","example":"email_address"}},"required":["address1","city","country","full_name"],"additionalProperties":false,"title":"ShipToAddressFlexport"},"CustomsUnitValue":{"type":"object","properties":{"amount":{"type":"number","description":"The value of one unit of the line item. Must be greater than zero.","example":0.0},"invoice_currency_code":{"type":"string","description":"The three-letter code for the currency associated with the line item.","example":"invoice_currency_code"},"currency_code":{"type":"string","description":"use invoice_currency_code instead","example":"currency_code"}},"required":["amount"],"additionalProperties":false,"title":"CustomsUnitValue"},"WmsOrderWriteLineItemflexport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"product_id":{"type":"string","description":"","example":"product_id"},"customs_unit_value":{"$ref":"#/components/schemas/CustomsUnitValue"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemflexport"},"DutiesMerchantOfRecordSKUMap":{"type":"object","properties":{"dsku":{"type":"string","description":"The DSKU for the order.","example":"dsku"},"msku":{"type":"string","description":"The MSKU for the order.","example":"msku"},"quantity":{"type":"integer","description":"The quantity for the order.","example":0}},"required":["dsku","msku","quantity"],"additionalProperties":false,"title":"DutiesMerchantOfRecordSKUMap"},"Duties":{"type":"object","properties":{"merchant_of_record_provider":{"type":"string","enum":["PASSPORT","MARKETS_PRO","GLOBALE"],"description":"The merchant of record provider for the order.","example":"PASSPORT"},"merchant_of_record_order_id":{"type":"string","description":"The merchant order ID associated with the merchantOfRecordProvider.","example":"order_id"},"merchant_of_record_account_id":{"type":"string","description":"The merchant GUID associated with GLOBALE. Required for GLOBALE and MARKETS_PRO.","example":"account_id"},"merchant_of_record_carrier_code":{"type":"string","description":"The carrier code used by the carrier. Used for GLOBALE, MARKETS_PRO, and PASSPORT.","example":"carrier_code"},"merchant_of_record_sku_map":{"type":"array","description":"A list of DSKU to MSKU mappings. Required for PASSPORT.","example":[{"dsku":"dsku","msku":"msku","quantity":1}],"items":{"$ref":"#/components/schemas/DutiesMerchantOfRecordSKUMap"}},"incoterm":{"type":"string","enum":["DDP","DDU","DAP"],"description":"The Incoterm for the order.","example":"DDP"}},"required":["incoterm","merchant_of_record_order_id","merchant_of_record_provider","merchant_of_record_sku_map"],"additionalProperties":false,"title":"Duties"},"CreatewmsOrder--Flexport__-_Deliverr_---":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressFlexport"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"product_id":"product_id","customs_unit_value":null}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemflexport"}},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"delivery_days":{"type":"integer","enum":[1,2,3,7],"description":"Define the number of days in which this order must be delivered, counting from the date of shipment. Accepted values are limited to: 1,2,3,7.","example":1},"required_delivery_date":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 format) the packages in this fulfillment order should arrive at the buyer's address.","example":"2022-05-06T01:02:03Z"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"duties":{"$ref":"#/components/schemas/Duties"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"}},"required":["line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"Flexport (Deliverr)"},"FlowspaceCreateOrderShipToAddressFlowspace":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"","example":"jane@example.com"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"FlowspaceCreateOrderShipToAddressFlowspace"},"WmsOrderCreateLineItemflowspace":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemflowspace"},"FlowspaceCreateOrderPallet":{"type":"object","properties":{"length":{"type":"integer","description":"Pallet length in inches","example":0},"width":{"type":"integer","description":"Pallet width in inches","example":0},"height":{"type":"integer","description":"Pallet height in inches","example":0},"weight":{"type":"integer","description":"Pallet weight in pounds","example":0},"number_of_pallets":{"type":"integer","description":"Number of pallets with these dimensions","example":0}},"required":["height","length","number_of_pallets","weight","width"],"additionalProperties":false,"title":"FlowspaceCreateOrderPallet"},"FlowspaceCreateOrderAccessorialServices":{"type":"object","properties":{"liftgate_delivery":{"type":"boolean","description":"","example":true},"liftgate_pickup":{"type":"boolean","description":"","example":true},"inside_delivery":{"type":"boolean","description":"","example":true},"inside_pickup":{"type":"boolean","description":"","example":true},"limited_access_delivery":{"type":"boolean","description":"","example":true},"limited_access_pickup":{"type":"boolean","description":"","example":true},"residential_delivery":{"type":"boolean","description":"","example":true},"delivery_appointment":{"type":"boolean","description":"","example":true},"crossdock":{"type":"boolean","description":"","example":true},"construction_site_delivery":{"type":"boolean","description":"","example":true},"destination_exhibition_delivery":{"type":"boolean","description":"","example":true}},"additionalProperties":false,"title":"FlowspaceCreateOrderAccessorialServices"},"FlowspaceCreateOrderChannelObject":{"type":"object","properties":{"channel_name":{"type":"string","description":"The name of the channel.","example":"channel_name"}},"required":["channel_name"],"additionalProperties":false,"title":"FlowspaceCreateOrderChannelObject"},"CreatewmsOrder--Flowspace--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/FlowspaceCreateOrderShipToAddressFlowspace"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemflowspace"}},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"scac":{"type":"string","description":"Standard Carrier Alpha Code","example":"scac"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Either a service level (Ground, Three-Day, Two-Day, Next Day, Three-Day Guaranteed, Two-Day Guaranteed, Next Day Guaranteed) or, together with carrier_id, the carrier's own service code (e.g. GROUND_HOME_DELIVERY for FedEx).","example":"Ground"},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"saturday_delivery":{"type":"boolean","description":"Whether Saturday delivery is requested","example":false},"signature_required":{"type":"boolean","description":"Whether a signature is required for delivery","example":false},"needs_transportation":{"type":"boolean","description":"Whether Flowspace should arrange transportation (default: false)","example":false},"transportation_mode":{"type":"string","default":"parcel","enum":["parcel","freight"],"description":"Whether the order ships as parcel or freight (default: parcel)","example":"parcel"},"freight_class":{"type":"string","description":"Freight class for freight orders (e.g. 125)","example":"freight_class"},"pallets":{"type":"array","description":"Pallet details for freight orders","example":[{"length":48,"width":40,"height":48,"weight":500,"number_of_pallets":1}],"items":{"$ref":"#/components/schemas/FlowspaceCreateOrderPallet"}},"accessorial_services":{"$ref":"#/components/schemas/FlowspaceCreateOrderAccessorialServices"},"transportation_special_requests":{"type":"string","description":"Transportation notes for freight orders","example":"transportation_special_requests"},"channel_object":{"$ref":"#/components/schemas/FlowspaceCreateOrderChannelObject"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Flowspace"},"FulfillorShipToAddressFulfillor":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"+1234567890"},"email_address":{"type":"string","description":"","example":"customer@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"FulfillorShipToAddressFulfillor"},"WmsOrderWriteLineItemfulfillor":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemfulfillor"},"CreatewmsOrder--Fulfillor--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/FulfillorShipToAddressFulfillor"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemfulfillor"}}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Fulfillor"},"FulfilmentcrowdChannelId":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"FulfilmentcrowdChannelId"},"FulfilmentcrowdChannelName":{"type":"object","properties":{"channel_name":{"type":"string","description":"The name of the channel.","example":"channel_name"}},"required":["channel_name"],"additionalProperties":false,"title":"FulfilmentcrowdChannelName"},"FulfilmentcrowdChannelSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/FulfilmentcrowdChannelId"},{"$ref":"#/components/schemas/FulfilmentcrowdChannelName"}],"discriminator":{"propertyName":"type","mapping":{"id":"#/components/schemas/FulfilmentcrowdChannelId","name":"#/components/schemas/FulfilmentcrowdChannelName"}},"title":"FulfilmentcrowdChannelSchema"},"WmsOrderWriteLineItemfulfilmentcrowd":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemfulfilmentcrowd"},"CreateOrderShipToAddressFulfilmentcrowd":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"CreateOrderShipToAddressFulfilmentcrowd"},"CreatewmsOrder--fulfilmentcrowd--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"channel_object":{"description":"The channel the order was placed on. Defaults to what you provided while installing.","$ref":"#/components/schemas/FulfilmentcrowdChannelSchema"},"invoice_currency_code":{"type":"string","default":"USD","enum":["USD"],"description":"The currency used for this order. If not provided explicitly, defaults to USD.","example":"USD"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemfulfilmentcrowd"}},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressFulfilmentcrowd"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"type":{"type":"string","default":"d2c","enum":["d2c","b2b","dropship","transfer"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"total_shipping":{"type":"number","default":0.0,"minimum":0.0,"description":"The total shipping cost for the order incurred by the customer. Fulfilmentcrowd picks the delivery method from this, so we send 0 when you leave it out.","example":3.5}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"fulfilmentcrowd"},"ShipToAddressG-Global":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressG-Global"},"WmsOrderWriteLineItemg-global":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemg-global"},"CreatewmsOrder--G__Global--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressG-Global"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemg-global"}},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"}},"required":["line_items","order_number","ship_to_address","total_price"],"additionalProperties":false,"title":"G Global"},"WmsOrderWriteLineItemgobolt":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemgobolt"},"ShipToAddressGobolt":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","email_address","full_name","phone_number","postal_code"],"additionalProperties":false,"title":"ShipToAddressGobolt"},"CreatewmsOrder--GoBolt--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"signature_required":{"type":"boolean","description":"","example":true},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"notes":{"type":"string","description":"","example":"notes"},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemgobolt"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressGobolt"}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"GoBolt"},"ShipToAddressGreenmark":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"address1":{"type":"string","description":"","example":"123 Main St"},"city":{"type":"string","description":"","example":"San Francisco"},"postal_code":{"type":"string","description":"","example":"94105"},"country":{"type":"string","description":"","example":"United States"},"phone_number":{"type":"string","description":"","example":"+31612345678"},"email_address":{"type":"string","description":"","example":"user@example.com"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"ShipToAddressGreenmark"},"WmsOrderCreateLineItemgreenmark":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemgreenmark"},"CreatewmsOrder--Greenmark__Logistics--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressGreenmark"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemgreenmark"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Greenmark Logistics"},"I-FulfilmentChannelIdSchema":{"type":"object","properties":{"channel_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"I-FulfilmentChannelIdSchema"},"ShipToAddressI-Fulfilment":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number for the shipping address.","example":"phone_number"},"email_address":{"type":"string","description":"The email for the shipping address.","example":"email_address"}},"required":["address1","city","country","email_address","full_name","phone_number","postal_code"],"additionalProperties":false,"title":"ShipToAddressI-Fulfilment"},"WmsOrderCreateLineItemi-fulfilment":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"unit_price":{"type":"number","description":"","example":0.0},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderCreateLineItemi-fulfilment"},"CreatewmsOrder--I-Fulfilment--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/I-FulfilmentChannelIdSchema"},"product_channel":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The channel of the product","example":"product_channel"},"invoice_currency_code":{"type":"string","default":"GBP","description":"Defaults to GBP if not provided.","example":"GBP"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressI-Fulfilment"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","unit_price":0.0,"quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemi-fulfilment"}},"requested_service_level":{"type":"string","description":"The REQUESTED service level for the order.","example":"requested_service_level"},"tax_rate":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"tax_rate"}},"required":["line_items","product_channel","reference_id","requested_service_level","ship_to_address","tax_rate","warehouse_id"],"additionalProperties":false,"title":"I-Fulfilment"},"BillToAddressInfoplus":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","company","country","postal_code","state"],"additionalProperties":false,"title":"BillToAddressInfoplus"},"ShipToAddressInfoplus":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","company","country","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressInfoplus"},"WmsOrderWriteLineIteminfoplus":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineIteminfoplus"},"CreatewmsOrder--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressInfoplus"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressInfoplus"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineIteminfoplus"}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"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"}},"customer_po_number":{"type":"string","description":"Customer's purchase order number","example":"customer_po_number"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"gift_message":{"type":"string","description":"Gift message","example":"gift_message"}},"required":["bill_to_address","line_items","warehouse_id"],"additionalProperties":false,"title":"Infoplus"},"ShipToAddressJas":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number of the customer.","example":"111-111-1111"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressJas"},"WmsOrderWriteLineItemjas":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemjas"},"CreatewmsOrder--JAS--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"invoice_currency_code":{"type":"string","description":"","example":"invoice_currency_code"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"type":{"type":"string","description":"The type of order","example":"type"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressJas"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemjas"}}},"required":["line_items","order_number","reference_id","ship_to_address","type"],"additionalProperties":false,"title":"JAS"},"WmsOrderWriteLineItemjaygroup":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemjaygroup"},"ShipToAddressJaygroup":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"email_address"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressJaygroup"},"CreatewmsOrder--JayGroup--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","enum":["Lancaster","Reno","Chicago"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"Chicago"},"shipping_method_id":{"type":"string","enum":["Economy","Standard","Express","Expedited","NextDay"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"Economy"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemjaygroup"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressJaygroup"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"JayGroup"},"WmsOrderWriteLineItemjazz-central":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemjazz-central"},"ShipToAddressJazz-Central":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressJazz-Central"},"CreatewmsOrder--Cart.com__-_Jazz__Central_---":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemjazz-central"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressJazz-Central"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"required":["channel_object","line_items","ship_to_address"],"additionalProperties":false,"title":"Cart.com (Jazz Central)"},"ShipToAddressLeanafy":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"phone_country_code":{"type":"string","default":"+1","description":"","example":"+1"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"}},"required":["address1","address2","city","company","country","email_address","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressLeanafy"},"WmsOrderWriteLineItemleanafy":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemleanafy"},"CreatewmsOrder--Leanafy--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressLeanafy"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemleanafy"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"is_address_residential":{"type":"boolean","default":true,"description":"Shipping address is residential","example":true}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Leanafy"},"OrderShipToAddressLogicpod":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"}},"required":["address1","city","country","email_address","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"OrderShipToAddressLogicpod"},"WmsOrderWriteLineItemlogicpod":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemlogicpod"},"CreatewmsOrder--Quickbox__-_LogicPod_---":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"connection":{"type":"string","default":"CARTROVER","enum":["CARTROVER","DPSH","DROPSTREAM","IQCONNECT","PURA","SALESSUPPLY"],"description":"Order connection/channel source","example":"CARTROVER"},"ship_to_address":{"$ref":"#/components/schemas/OrderShipToAddressLogicpod"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemlogicpod"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Quickbox (LogicPod)"},"WmsOrderWriteLineItemlogiwa":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemlogiwa"},"ShipToAddressLogiwa":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"address1":{"type":"string","description":"","example":"123 Main St"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressLogiwa"},"CreatewmsOrder--Logiwa--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemlogiwa"}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressLogiwa"},"order_type":{"type":"string","default":"Customer Order","description":"The type of order. Defaults to 'Customer Order'.","example":"Customer Order"}},"required":["line_items","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Logiwa"},"WmsOrderWriteLineItemlogiwa-io":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"pack_type":{"type":"string","description":"The pack type of the line item (default: Each)","example":"Each"},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemlogiwa-io"},"ShipToAddressLogiwa-Io":{"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressLogiwa-Io"},"CreatewmsOrder--Logiwa__IO--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"order_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"notes":{"type":"string","description":"","example":"notes"},"shipment_order_type":{"type":"string","description":"","example":"shipment_order_type"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"pack_type":"Each","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemlogiwa-io"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressLogiwa-Io"}},"required":["line_items","order_date","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Logiwa IO"},"CreateOrderShipToAddressLuminous":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"required":["address1","city","country","full_name"],"additionalProperties":false,"title":"CreateOrderShipToAddressLuminous"},"WmsOrderCreateLineItemluminous":{"type":"object","properties":{"product_id":{"type":"integer","description":"","example":0},"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"number","minimum":0.001,"description":"","example":2},"unit_price":{"type":"number","description":"","example":9.99}},"required":["quantity","unit_price"],"additionalProperties":false,"title":"WmsOrderCreateLineItemluminous"},"CreatewmsOrder--Luminous--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"total_tax":{"type":"number","description":"The total tax on the order.","example":1.5},"total_discount":{"type":"number","description":"The total amount discounted from the order.","example":2.5},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressLuminous"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":0,"sku":"sku","quantity":2,"unit_price":9.99}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemluminous"}}},"required":["channel_object","line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Luminous"},"LuxroutageShipToLuxroutage":{"type":"object","properties":{"company":{"type":"string","description":"","example":"Company"},"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"},"first_name":{"type":"string","description":"","example":"first_name"},"last_name":{"type":"string","description":"","example":"last_name"}},"required":["address1","address2","city","company","country","first_name","last_name","postal_code","state"],"additionalProperties":false,"title":"LuxroutageShipToLuxroutage"},"LuxroutageBillToLuxroutage":{"type":"object","properties":{"company":{"type":"string","description":"","example":"Company"},"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"},"first_name":{"type":"string","description":"","example":"first_name"},"last_name":{"type":"string","description":"","example":"last_name"}},"required":["address1","address2","city","company","country","first_name","last_name","postal_code","state"],"additionalProperties":false,"title":"LuxroutageBillToLuxroutage"},"WmsOrderWriteLineItemluxroutage":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"name":{"type":"string","description":"The name of the product.","example":"name"},"quantity":{"type":"integer","description":"","example":0}},"required":["name","quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemluxroutage"},"CreatewmsOrder--Luxroutage__LRI--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"carrier_code":{"type":"string","description":"The code of the carrier to ship the order with. Reach out to your Luxroutage representative to get the mapping of available carrier_codes.","example":"carrier_code"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"ship_to_address":{"$ref":"#/components/schemas/LuxroutageShipToLuxroutage"},"bill_to_address":{"$ref":"#/components/schemas/LuxroutageBillToLuxroutage"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","name":"name","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemluxroutage"}}},"required":["bill_to_address","carrier_code","line_items","order_number","ship_to_address","total_price"],"additionalProperties":false,"title":"Luxroutage LRI"},"ShipToAddressMabang":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","full_name","phone_number"],"additionalProperties":false,"title":"ShipToAddressMabang"},"WmsOrderWriteLineItemmabang":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemmabang"},"CreatewmsOrder--Mabang--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressMabang"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemmabang"}},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shop_name":{"type":"string","description":"Shop name","example":"My Store"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"}},"required":["line_items","ship_to_address","shipping_method_id","shop_name"],"additionalProperties":false,"title":"Mabang"},"WmsOrderWriteLineItemmai":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemmai"},"ShipToAddressMai":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"555-555-5555"},"email_address":{"type":"string","description":"","example":"customer@example.com"}},"required":["address1","city","country","email_address","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressMai"},"CreatewmsOrder--Mai__Fulfillment--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemmai"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressMai"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"}},"required":["line_items","order_number","ship_to_address","shipping_method_name"],"additionalProperties":false,"title":"Mai Fulfillment"},"ShipToAddressMainfreight":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressMainfreight"},"WmsOrderCreateLineItemmainfreight":{"type":"object","properties":{"sku":{"type":"string","description":"Warehouse stock code","example":"SKU123"},"quantity":{"type":"integer","description":"Quantity to ship","example":1}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemmainfreight"},"CreatewmsOrder--Mainfreight--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"debtor_id":{"type":"string","description":"Mainfreight debtor code billed for the order.","example":"D12345"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressMainfreight"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"SKU123","quantity":1}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemmainfreight"}}},"required":["debtor_id","line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Mainfreight"},"WmsOrderWriteLineItemmasonhub":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"passthrough_fields":{"type":"object","description":"Use this object to pass fields directly to the underlying API. You will have to read the API's documentation to know what fields are available, and cannot override fields that are managed by Trackstar.","example":{"custom_field_1":"value1","custom_field_2":123},"additionalProperties":{}}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemmasonhub"},"ShipToAddressMasonhub":{"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressMasonhub"},"CreatewmsOrder--MasonHub--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"passthrough_fields":{"custom_field_1":"value1","custom_field_2":123}}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemmasonhub"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressMasonhub"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"type":{"type":"string","default":"customer","enum":["customer","destroy","packAndHold","quarantine","returnToVendor","transfer","wholesale","workOrder","dropship"],"description":"The type of order.","example":"customer"},"carrier_id":{"type":"string","default":"masonhub","enum":["rate_shop","masonhub","UPS","USPS","FEDEX","DHL","willCall"],"description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"FEDEX"},"service_level":{"type":"string","enum":["economy","nextDayAirEarlyAM","nextDay","guaranteedNextDay","standardOvernight","priorityOvernight","2-day","2day","3-day","3day","guaranteed2Day","ground","groundSelect","groundPlus","priority","LTL","FTL","willCall","international"],"description":"The type of shipping method requested by the customer.","example":"2-day"},"priority":{"type":"integer","default":100,"minimum":1,"maximum":10000,"description":"The priority number of the order. 1 is the highest priority and should only be used in special circumstances.","example":0},"shipping_address_type":{"type":"string","default":"residential","enum":["business","residential"],"description":"Business or residential address.","example":"residential"},"passthrough_fields":{"type":"object","description":"Use this object to pass fields directly to the underlying API. You will have to read the API's documentation to know what fields are available, and cannot override fields that are managed by Trackstar.","example":{"custom_field_1":"value1","custom_field_2":123},"additionalProperties":{}}},"required":["line_items","service_level","ship_to_address"],"additionalProperties":false,"title":"MasonHub"},"WmsOrderWriteLineItemmintsoft":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemmintsoft"},"ShipToAddressMintsoft":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email":{"type":"string","description":"","example":"email"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"required":["country","full_name"],"additionalProperties":false,"title":"ShipToAddressMintsoft"},"CreatewmsOrder--Mintsoft--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemmintsoft"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressMintsoft"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"notes":{"type":"string","description":"A note to attach to the order","example":"notes"},"delivery_notes":{"type":"string","description":"Delivery instructions, passed to the courier where supported","example":"delivery_notes"},"gift_messages":{"type":"string","description":"Gift message printed on the despatch note","example":"gift_messages"}},"required":["line_items","ship_to_address","shipping_method_id","warehouse_id"],"additionalProperties":false,"title":"Mintsoft"},"ShipToAddressModa-Express":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressModa-Express"},"WmsOrderCreateLineItemmoda-express":{"type":"object","properties":{"sku":{"type":"string","description":"Warehouse stock code.","example":"sku"},"quantity":{"type":"integer","minimum":1,"description":"Quantity to ship.","example":1},"unit_price":{"type":"number","minimum":0.0,"description":"The price of the product in the currency specified by invoice_currency_code.","example":10.99}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemmoda-express"},"CreatewmsOrder--Moda__Express--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"invoice_currency_code":{"type":"string","minLength":3,"maxLength":3,"description":"The currency used for this order. If not provided explicitly, defaults to USD.","example":"USD"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressModa-Express"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1,"unit_price":10.99}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemmoda-express"}}},"required":["line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Moda Express"},"ShipToAddressNext3Pl":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"Phone Number","example":"phone_number"},"email_address":{"type":"string","description":"Email Address","example":"email_address"}},"required":["address1","city","company","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressNext3Pl"},"WmsOrderWriteLineItemnext3pl":{"type":"object","properties":{"sku":{"type":"string","description":"SKU","example":"sku"},"sku_description":{"type":"string","description":"SKU Description","example":"sku_description"},"quantity":{"type":"integer","description":"Quantity","example":0},"unit_price":{"type":"number","description":"Unit Price","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemnext3pl"},"CreatewmsOrder--Next3PL--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressNext3Pl"},"customer_instructions":{"type":"string","description":"Customer Instructions","example":"customer_instructions"},"warehouse_instructions":{"type":"string","description":"Warehouse Instructions","example":"warehouse_instructions"},"freight_instructions":{"type":"string","description":"Freight Instructions","example":"freight_instructions"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"postage_rate":{"type":"number","description":"Postage Rate","example":0.0},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","sku_description":"sku_description","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemnext3pl"}}},"required":["line_items","order_number","reference_id","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"Next3PL"},"ShipToAddressNextsmartship":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","full_name","phone_number","postal_code"],"additionalProperties":false,"title":"ShipToAddressNextsmartship"},"WmsOrderWriteLineItemnextsmartship":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemnextsmartship"},"CreatewmsOrder--NextSmartShip--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressNextsmartship"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemnextsmartship"}},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"note":{"type":"string","description":"","example":"note"}},"required":["line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"NextSmartShip"},"ShipToAddressNFI":{"type":"object","properties":{"full_name":{"type":"string"},"company":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"country":{"type":"string"},"phone_number":{"type":"string","description":"The phone number of the customer.","example":"111-111-1111"}},"additionalProperties":false,"title":"ShipToAddressNFI"},"WmsOrderWriteLineItemnfi":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"country_of_origin":{"type":"string","description":"","example":"country_of_origin"}},"required":["country_of_origin","quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemnfi"},"CreatewmsOrder--NFI--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"invoice_currency_code":{"type":"string","enum":["USD","CAD"],"description":"The currency used for this order. If not provided explicitly, defaults to USD.","example":"USD"},"shipping_method_id":{"type":"string","enum":["LowCost","CanadaZoneSkipExpress","GROUND","Expedited","Xpresspost"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"CanadaZoneSkipExpress"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressNFI"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"country_of_origin":"country_of_origin"}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemnfi"}}},"required":["line_items","reference_id","required_ship_date","ship_to_address"],"additionalProperties":false,"title":"NFI"},"WmsOrderWriteLineItemnimble":{"type":"object","properties":{"sku":{"type":"string","description":"SKU","example":"sku"},"quantity":{"type":"integer","description":"Quantity","example":1}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemnimble"},"ShipToAddressNimble":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code"],"additionalProperties":false,"title":"ShipToAddressNimble"},"CreatewmsOrder--Nimble--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemnimble"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressNimble"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"}},"required":["line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"Nimble"},"ShipToAddressNlrp":{"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressNlrp"},"WmsOrderWriteLineItemnlrp":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"description":{"type":"string","description":"","example":"description"},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemnlrp"},"CreatewmsOrder--NLRP--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressNlrp"},"purchase_order_number":{"type":"string","description":"PO Number","example":"purchase_order_number"},"terms":{"type":"string","description":"Terms","example":"Net 30"},"sales_rep":{"type":"string","description":"Sales Rep","example":"VA"},"ship_date":{"type":"string","format":"date-time","description":"The earliest date the order can ship","example":"2023-03-15T13:45:30Z"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"memo":{"type":"string","description":"","example":"memo"},"total_tax":{"type":"number","description":"The total tax on the order.","example":1.5},"sales_tax_code":{"type":"string","description":"","example":"sales_tax_code"},"sales_tax_item":{"type":"string","description":"","example":"sales_tax_item"},"sales_tax_percentage":{"type":"number","description":"","example":0.0},"other":{"type":"number","description":"","example":0.0},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"description":"description","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemnlrp"}}},"required":["line_items","reference_id","shipping_method_id","terms"],"additionalProperties":false,"title":"NLRP"},"ShipToAddressNpfulfilment":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number of the contact at the ship to address.","example":"0399999999"},"email_address":{"type":"string","description":"The email address of the contact at the ship to address.","example":"customer@example.com"}},"required":["address1","city","country","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressNpfulfilment"},"WmsOrderWriteLineItemnpfulfilment":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_price":{"type":"number","minimum":0.0,"description":"npf requires a sales price per product. Treated as GST-inclusive; npf's per-line GST is sent as 0.","example":0.0},"barcode":{"type":"string","description":"npf's printed barcode for the product, sent on the order line.","example":"barcode"}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemnpfulfilment"},"CreatewmsOrder--NPFulfilment--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"npf's SalesOrderNo. Defaults to `reference_id` if not provided.","example":"order_number"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. npf's dispatch method code, e.g. EP or AP. npf rejects an unrecognized code with its own error.","example":"fedex_ground"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"total_discount":{"type":"number","description":"The total amount discounted from the order.","example":2.5},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressNpfulfilment"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"barcode":"barcode"}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemnpfulfilment"}},"customer_number":{"type":"string","description":"npf's identifier for the customer placing the order.","example":"227232"}},"required":["customer_number","line_items","ship_to_address","shipping_method_id","total_price"],"additionalProperties":false,"title":"NPFulfilment"},"WmsOrderWriteLineItemnri":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemnri"},"ShipToAddressNri":{"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"},"phone_number":{"type":"string","description":"","example":"1234567890"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressNri"},"BillToAddressNri":{"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"},"phone_number":{"type":"string","description":"","example":"1234567890"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"BillToAddressNri"},"CreatewmsOrder--NRI--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemnri"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressNri"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressNri"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"first_ship_date":{"type":"string","format":"date-time","description":"Beginning of shipping window.","example":"2025-01-01T00:00:00Z"},"last_ship_date":{"type":"string","format":"date-time","description":"Last date of shipping window","example":"2025-01-01T00:00:00Z"},"freight_term_code":{"type":"string","enum":["Prepaid","Collect","Third Party","Recipient"],"description":"Who is paying for shipment. Defaults to Prepaid if not provided.","example":"Collect"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Only required if freight_term_code is 'Collect' or 'Third Party'.","example":"fedex"},"carrier_account_number":{"type":"string","description":"Only required if freight_term_code is 'Collect' or 'Third Party'.","example":"carrier_account_number"},"order_type":{"type":"string","description":"The type of order, defaults to Wholesale.","example":"order_type"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"required":["line_items","order_number","reference_id","ship_to_address"],"additionalProperties":false,"title":"NRI"},"ShipToAddressOia-Global":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number of the contact at the ship to address.","example":"555-555-5555"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressOia-Global"},"WmsOrderWriteLineItemoia-global":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemoia-global"},"CreatewmsOrder--OIA__Global--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer. OIA's service level code for the chosen carrier, e.g. G for ground: the service_level under additional_fields of a shipping method from GET /shipping-methods. OIA requires it and the valid codes differ per carrier, so no default is applied.","example":"Standard"},"transportation_mode":{"type":"string","description":"OIA's transportation mode. Defaults to G.","example":"G"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. OIA's carrier_code: the carrier_id of a shipping method from GET /shipping-methods. Defaults to CALL (call for routing), which ships without a tracking number.","example":"fedex"},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressOia-Global"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemoia-global"}},"signature_required":{"type":"boolean","description":"True if the order requires a signature upon delivery.","example":false},"priority":{"type":"integer","minimum":1,"maximum":30,"description":"OIA order priority.","example":15},"freight_terms":{"type":"string","enum":["C","P","T","R","CB"],"description":"Who pays freight for the order.","example":"P"}},"required":["line_items","order_number","reference_id","service_level","ship_to_address"],"additionalProperties":false,"title":"OIA Global"},"WmsOrderWriteLineItemongoing":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemongoing"},"ShipToAddressOngoing":{"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"},"customer_number":{"type":"string","description":"","example":"customer_number"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressOngoing"},"CreatewmsOrder--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"delivery_date":{"type":"string","format":"date-time","description":"Expected delivery date","example":"2023-03-15T13:45:30Z"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemongoing"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressOngoing"}},"required":["delivery_date","line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Ongoing WMS"},"OrderWiseShipToAddressOrderwise":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"address1":{"type":"string","description":"","example":"123 Main St"},"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"},"phone_number":{"type":"string","description":"","example":"01904202255"},"email_address":{"type":"string","description":"","example":"user@example.com"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"OrderWiseShipToAddressOrderwise"},"WmsOrderWriteLineItemorderwise":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":1},"unit_price":{"type":"number","description":"The price of the product in the currency specified by `invoice_currency_code`.","example":10.99}},"additionalProperties":false,"title":"WmsOrderWriteLineItemorderwise"},"CreatewmsOrder--OrderWise--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/OrderWiseShipToAddressOrderwise"},"shipping_method_id":{"type":"string","enum":["N/A: Get your Delivery Method IDs from your OrderWise representative"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1,"unit_price":10.99}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemorderwise"}}},"required":["line_items","order_number","reference_id","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"OrderWise"},"ShipToAddressPackem":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressPackem"},"WmsOrderWriteLineItempackem":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItempackem"},"CreatewmsOrder--PackemWMS--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressPackem"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItempackem"}}},"required":["line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"PackemWMS"},"WmsOrderWriteLineItempackiyo":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItempackiyo"},"ShipToAddressPackiyo":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressPackiyo"},"CreatewmsOrder--Packiyo--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItempackiyo"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressPackiyo"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"}},"required":["line_items","order_number","service_level","ship_to_address"],"additionalProperties":false,"title":"Packiyo"},"addressPattern":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"addressPattern"},"WmsOrderCreateLineItempattern":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItempattern"},"CreatewmsOrder--Pattern--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/addressPattern"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItempattern"}},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Pattern"},"OrderShipToAddressPicqer":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number.","example":"phone_number"},"email_address":{"type":"string","description":"The email address.","example":"email_address"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"OrderShipToAddressPicqer"},"WmsOrderWriteLineItempicqer":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_price":{"type":"number","minimum":0.0,"description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItempicqer"},"CreatewmsOrder--Picqer--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/OrderShipToAddressPicqer"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItempicqer"}}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Picqer"},"shippingAddressPortless":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number.","example":"phone_number"},"email_address":{"type":"string","description":"The email address.","example":"email_address"}},"required":["address1","city","country","full_name"],"additionalProperties":false,"title":"shippingAddressPortless"},"WmsOrderCreateLineItemportless":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"discount_amount":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemportless"},"CreatewmsOrder--Portless--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/shippingAddressPortless"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"discount_amount":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemportless"}},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"custom_fields":{"type":"array","description":"List of the custom fields","example":[{"name":"recipientTaxId","value":"12345678909"}],"items":{"$ref":"#/components/schemas/CustomField"}}},"required":["carrier_id","line_items","order_number","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"Portless"},"ShipToAddressQls":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code"],"additionalProperties":false,"title":"ShipToAddressQls"},"WmsOrderWriteLineItemqls":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemqls"},"CreatewmsOrder--QLS--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressQls"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemqls"}}},"required":["line_items","reference_id","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"QLS"},"QuietOrderAddress":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"address3":{"type":"string","description":"","example":"address3"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","postal_code","state"],"additionalProperties":false,"title":"QuietOrderAddress"},"WmsOrderWriteLineItemquiet":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemquiet"},"CreatewmsOrder--Quiet__Platforms--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"ship_to_address":{"$ref":"#/components/schemas/QuietOrderAddress"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemquiet"}}},"required":["carrier_id","line_items","order_number","ship_to_address","shipping_method_id","warehouse_id"],"additionalProperties":false,"title":"Quiet Platforms"},"CreateOrderShipToAddressSalesupply":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"},"phone_number":{"type":"string","description":"","example":"123-456-7890"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"CreateOrderShipToAddressSalesupply"},"CreateOrderBillToAddressSalesupply":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"},"phone_number":{"type":"string","description":"","example":"123-456-7890"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"CreateOrderBillToAddressSalesupply"},"WmsOrderCreateLineItemsalesupply":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemsalesupply"},"SaleSupplyCreateOrderChannelObject":{"type":"object","properties":{"channel_name":{"type":"string","description":"The name of the channel.","example":"channel_name"}},"required":["channel_name"],"additionalProperties":false,"title":"SaleSupplyCreateOrderChannelObject"},"CreatewmsOrder--Salesupply--":{"type":"object","properties":{"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":{}},"shop_id":{"type":"string","default":"N/A - Connect an account to see options","enum":["N/A - Connect an account to see options"],"description":"Salesupply Shop ID","example":"N/A - Connect an account to see options"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressSalesupply"},"bill_to_address":{"$ref":"#/components/schemas/CreateOrderBillToAddressSalesupply"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemsalesupply"}},"invoice_currency_code":{"type":"string","default":"USD","enum":["USD"],"description":"","example":"USD"},"channel_object":{"$ref":"#/components/schemas/SaleSupplyCreateOrderChannelObject"}},"required":["bill_to_address","line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Salesupply"},"ShipToAddressShipbob":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"},"phone_number":{"type":"string","description":"","example":"123-456-7890"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"ShipToAddressShipbob"},"WmsOrderWriteLineItemshipbob":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemshipbob"},"ShipbobCreateOrderChannelObject":{"type":"object","properties":{"channel_name":{"type":"string","description":"The name of the sales channel. One of: amazon, bigcommerce, ebay, faire, macy, magento, shein, shopify, squarespace, targetplus, temu, tiktok, unleashed, walmart, woocommerce. Case-insensitive.","example":"tiktok"}},"required":["channel_name"],"additionalProperties":false,"title":"ShipbobCreateOrderChannelObject"},"CreatewmsOrder--ShipBob--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Must pass in either shipping_method_id or shipping_method_name.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. Must pass in either shipping_method_id or shipping_method_name.","example":"FedEx Ground"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipbob"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipbob"}},"type":{"type":"string","enum":["b2b","d2c","dropship"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"carrier_type":{"type":"string","enum":["parcel","freight"],"description":"The carrier type for B2B orders.","example":"freight"},"payment_term":{"type":"string","enum":["prepaid","merchant_responsible"],"description":"The payment term for B2B orders.","example":"merchant_responsible"},"purchase_order_number":{"type":"string","description":"Purchase order number for B2B orders.","example":"purchase_order_number"},"tags":{"type":"array","description":"A list of tags to attach to the order, formatted as `key:value`.","example":["category:electronics"],"items":{"type":"string","description":"A tag for the order.","example":"category:electronics"}},"channel_object":{"$ref":"#/components/schemas/ShipbobCreateOrderChannelObject"}},"required":["line_items","reference_id","ship_to_address"],"additionalProperties":false,"title":"ShipBob"},"ShipedgeChannelId":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"ShipedgeChannelId"},"ShipedgeChannelName":{"type":"object","properties":{"channel_name":{"type":"string","description":"The name of the channel.","example":"channel_name"}},"required":["channel_name"],"additionalProperties":false,"title":"ShipedgeChannelName"},"ShipedgeChannelSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/ShipedgeChannelId"},{"$ref":"#/components/schemas/ShipedgeChannelName"}],"discriminator":{"propertyName":"type","mapping":{"id":"#/components/schemas/ShipedgeChannelId","name":"#/components/schemas/ShipedgeChannelName"}},"title":"ShipedgeChannelSchema"},"ShipToAddressShipedge":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressShipedge"},"WmsOrderWriteLineItemshipedge":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemshipedge"},"CreatewmsOrder--Shipedge--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ShipedgeChannelSchema"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipedge"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipedge"}}},"required":["line_items","order_number","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"Shipedge"},"WmsOrderWriteLineItemshipfusion":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemshipfusion"},"ShipToAddressShipfusion":{"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"},"phone_number":{"type":"string","pattern":"\\d{3}-\\d{3}-\\d{4}$","description":"The phone number of the customer.","example":"111-111-1111"},"email_address":{"type":"string","pattern":"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$","description":"The email address of the customer.","example":"johnsmith@gmail.com"}},"required":["address1","city","country","email_address","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressShipfusion"},"ShipfusionCreateOrderChannelObject":{"type":"object","properties":{"channel_id":{"type":"string","pattern":"^\\d+$","description":"Shipfusion's numeric sales channel id.","example":"1234"},"channel_name":{"type":"string","description":"The sales channel name.","example":"tether"}},"additionalProperties":false,"title":"ShipfusionCreateOrderChannelObject"},"CreatewmsOrder--Shipfusion--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipfusion"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipfusion"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"channel_object":{"$ref":"#/components/schemas/ShipfusionCreateOrderChannelObject"},"extra_data":{"type":"object","description":"Free-form fields passed through to Shipfusion's `extraData` as-is.","example":{"Channel_type":"SHOPIFY","shopifyTags":[]},"additionalProperties":{}}},"required":["line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Shipfusion"},"CreateOrderShipToAddressShiphero":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"The email address of the customer","example":"janedoe@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"CreateOrderShipToAddressShiphero"},"CreateOrderBillToAddressShiphero":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"The email address of the customer","example":"janedoe@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"CreateOrderBillToAddressShiphero"},"WmsOrderCreateLineItemshiphero":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"warehouse_id":{"type":"string","description":"Warehouse ID to ship item from","example":"warehouse_id"},"quantity_pending_fulfillment":{"type":"integer","description":"Number of units on this line item still pending fulfillment.","example":0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderCreateLineItemshiphero"},"WholesaleShippingDetails":{"type":"object","properties":{"scac":{"type":"string","description":"","example":"scac"},"bill_of_lading":{"type":"string","description":"","example":"bill_of_lading"},"trailer_number":{"type":"string","description":"","example":"trailer_number"},"pro_number":{"type":"string","description":"","example":"pro_number"},"freighter":{"type":"string","description":"","example":"freighter"},"cost":{"type":"number","description":"","example":0.0},"gs1_company_prefix":{"type":"string","description":"","example":"gs1_company_prefix"},"carrier":{"type":"string","description":"Overrides order-level shipping_carrier when set (per shiphero docs).","example":"carrier"},"shipping_method":{"type":"string","description":"Overrides order-level shipping_method when set (per shiphero docs).","example":"shipping_method"}},"additionalProperties":false,"title":"WholesaleShippingDetails"},"CreatewmsOrder--ShipHero--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressShiphero"},"bill_to_address":{"$ref":"#/components/schemas/CreateOrderBillToAddressShiphero"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"warehouse_id":"warehouse_id","quantity_pending_fulfillment":0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemshiphero"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"packing_note":{"type":"string","description":"Packing note for the order","example":"packing_note"},"gift_note":{"type":"string","description":"Gift note for the order","example":"gift_note"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_price":{"type":"number","description":"Shipping price","example":0.0},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"hold_until_date":{"type":"string","format":"date-time","description":"Date before which shiphero should not fulfill the order. Shiphero reads the time of day in the warehouse account's own timezone, so it comes back shifted by that offset.","example":"2023-03-15T13:45:30Z"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"type":{"type":"string","enum":["d2c","b2b"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"trading_partner_id":{"type":"string","description":"Vendor-specific trading-partner identifier provided by shiphero ops.","example":"trading_partner_id"},"gs1_labels_required":{"type":"boolean","description":"Whether shiphero should generate GS1 labels for this order.","example":true},"store_location_number":{"type":"string","description":"Store location number for retail/EDI orders.","example":"store_location_number"},"shipping_option":{"type":"string","enum":["COURIER","FREIGHT"],"description":"COURIER or FREIGHT \u2014 wholesale shipping mode.","example":"COURIER"},"requested_delivery_date":{"type":"string","format":"date-time","description":"Requested delivery date.","example":"2023-03-15T13:45:30Z"},"ship_not_before_date":{"type":"string","format":"date-time","description":"Earliest acceptable ship date.","example":"2023-03-15T13:45:30Z"},"ship_no_later_than_date":{"type":"string","format":"date-time","description":"Latest acceptable ship date.","example":"2023-03-15T13:45:30Z"},"department":{"type":"string","description":"Department for retail/EDI orders.","example":"department"},"department_number":{"type":"string","description":"Department number for retail/EDI orders.","example":"department_number"},"division":{"type":"string","description":"Division for retail/EDI orders.","example":"division"},"vendor":{"type":"string","description":"Vendor name.","example":"vendor"},"vendor_id":{"type":"string","description":"Vendor identifier.","example":"vendor_id"},"purchase_order_type":{"type":"string","description":"Free-form purchase-order type (e.g. 'New', 'Reorder').","example":"purchase_order_type"},"reference_fields":{"type":"object","description":"Arbitrary key/value passthrough emitted to shiphero's JSONObjectScalar reference_fields.","example":{},"additionalProperties":{"type":"string","description":"","example":"reference_fields"}},"wholesale_shipping_details":{"$ref":"#/components/schemas/WholesaleShippingDetails"}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"ShipHero"},"WmsOrderWriteLineItemshipmonk":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"name":{"type":"string","description":"","example":"name"},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemshipmonk"},"CreateOrderShipToAddressShipmonk":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"The email address of the customer.","example":"johndoe@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"CreateOrderShipToAddressShipmonk"},"ShipmonkOrderCustomData":{"type":"object","properties":{"name":{"type":"string","description":"Key of the custom data entry","example":"name"},"value":{"type":"string","description":"Value of the custom data entry","example":"value"}},"required":["name","value"],"additionalProperties":false,"title":"ShipmonkOrderCustomData"},"CreatewmsOrder--ShipMonk--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"type":{"type":"string","enum":["direct_to_consumer","retail","amazon","transfer","removal_liquidation","disposal","bonded_inventory_clearance","work_order"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"amazon"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"name":"name","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipmonk"}},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressShipmonk"},"customer_notes":{"type":"string","description":"Notes from the buyer (e.g. delivery preferences), stored by ShipMonk on order creation only.","example":"customer_notes"},"internal_notes":{"type":"string","description":"Notes for warehouse staff, not shown to the buyer. Stored by ShipMonk on order creation only.","example":"internal_notes"},"custom_data":{"type":"array","description":"Key/value metadata stored on the ShipMonk order, usable by ShipMonk automation rules.","example":[{"name":"Channel","value":"Wholesale"}],"items":{"$ref":"#/components/schemas/ShipmonkOrderCustomData"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"ShipMonk"},"ShipToAddressShipping-And-Handling":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"address3":{"type":"string","description":"","example":"address3"},"phone":{"type":"string","description":"The shipping address phone number.","example":"phone"},"email":{"type":"string","description":"The shipping address email address.","example":"email"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressShipping-And-Handling"},"WmsOrderWriteLineItemshipping-and-handling":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"name":{"type":"string","description":"","example":"name"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemshipping-and-handling"},"CreatewmsOrder--Shipping__and__Handling--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipping-And-Handling"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","name":"name","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipping-and-handling"}},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"notes":{"type":"string","description":"","example":"notes"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"}},"required":["line_items"],"additionalProperties":false,"title":"Shipping and Handling"},"WmsOrderCreateLineItemshipping-tree":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemshipping-tree"},"ShipToAddressShipping-Tree":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","email_address","full_name","postal_code"],"additionalProperties":false,"title":"ShipToAddressShipping-Tree"},"CreatewmsOrder--ShippingTree--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemshipping-tree"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipping-Tree"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"ShippingTree"},"CreateBillingAddressShipstation":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":["string","null"],"description":"","example":"Company"},"address1":{"type":"string","description":"","example":"123 Main St"},"address2":{"type":["string","null"],"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","postal_code","state"],"additionalProperties":false,"title":"CreateBillingAddressShipstation"},"CreateOrderShipToAddressShipstation":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":["string","null"],"description":"","example":"Company"},"address1":{"type":"string","description":"","example":"123 Main St"},"address2":{"type":["string","null"],"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","postal_code","state"],"additionalProperties":false,"title":"CreateOrderShipToAddressShipstation"},"WmsOrderCreateLineItemshipstation":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity of the item","example":0},"sku":{"type":"string","description":"The SKU of the item","example":"sku"},"unit_price":{"type":"number","description":"The unit price of the item","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemshipstation"},"CreatewmsOrder--ShipStation--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"status":{"type":"string","enum":["awaiting_payment","awaiting_shipment"],"description":"The ShipStation status to create the order with. Orders created as `awaiting_payment` sit in the Awaiting Payment tab and have to be moved before they can ship.","example":"awaiting_shipment"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"bill_to_address":{"$ref":"#/components/schemas/CreateBillingAddressShipstation"},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressShipstation"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"quantity":0,"sku":"sku","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemshipstation"}}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"ShipStation"},"ShipToAddressShipstream":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressShipstream"},"WmsOrderWriteLineItemshipstream":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemshipstream"},"CreatewmsOrder--ShipStream--":{"type":"object","properties":{"custom_fields":{"type":"string","description":"Connect an account to see custom fields.","example":"custom_fields"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelIdSchema"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipstream"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipstream"}},"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":{}}},"required":["custom_fields","line_items","ship_to_address"],"additionalProperties":false,"title":"ShipStream"},"ShipToAddressShipwire":{"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","address2","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressShipwire"},"WmsOrderWriteLineItemshipwire":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemshipwire"},"CreatewmsOrder--Shipwire--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","minLength":1,"maxLength":25,"description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipwire"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipwire"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Shipwire"},"ShipToAddressSkusavvy":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressSkusavvy"},"WmsOrderWriteLineItemskusavvy":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemskusavvy"},"CreatewmsOrder--SKUSavvy--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressSkusavvy"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemskusavvy"}}},"required":["line_items","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"SKUSavvy"},"ShipToAddressSkuvault":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressSkuvault"},"WmsOrderWriteLineItemskuvault":{"type":"object","properties":{"sku":{"type":"string","description":"If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU.","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemskuvault"},"CreatewmsOrder--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressSkuvault"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemskuvault"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"ShipToAddressSmart-Warehousing":{"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"},"phone_number":{"type":"string","pattern":"^[1-9]-\\d{3}-\\d{3}-\\d{4}$","description":"The phone number of the customer.","example":"1-111-111-1111"}},"required":["address1","city","country","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressSmart-Warehousing"},"BillToAddressSmart-Warehousing":{"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"},"phone_number":{"type":"string","pattern":"^[1-9]-\\d{3}-\\d{3}-\\d{4}$","description":"The phone number of the customer.","example":"1-111-111-1111"}},"required":["address1","city","country","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"BillToAddressSmart-Warehousing"},"WmsOrderWriteLineItemsmart-warehousing":{"type":"object","properties":{"sku":{"type":"string","description":"sku","example":"sku"},"quantity":{"type":"integer","description":"quantity","example":2}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemsmart-warehousing"},"CreatewmsOrder--Smart__Warehousing--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressSmart-Warehousing"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressSmart-Warehousing"},"cod_flag":{"type":"boolean","description":"Whether or not the order is COD (cash on delivery).","example":true},"client_tracking":{"type":"string","description":"Pre-defined list of values that Smart Warehousing sets up for you to track orders by deparment, cost center, or sales rep. Use '2' if not specified","example":"client_tracking"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":2}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemsmart-warehousing"}}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Smart Warehousing"},"WmsOrderWriteLineItemsojo":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the product to be ordered.","example":"product_id"},"quantity":{"type":"integer","description":"","example":0}},"required":["product_id","quantity"],"additionalProperties":false,"title":"WmsOrderWriteLineItemsojo"},"ShipToAddressSojo":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"address1":{"type":"string","description":"","example":"123 Main St"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressSojo"},"CreatewmsOrder--Sojo--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"memo":{"type":"string","description":"A note or memo that will be added to the order for internal use","example":"memo"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"expected_ship_date":{"type":"string","format":"date","description":"The date when the shipment is expected to be dispatched.","example":"2023-03-15"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemsojo"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressSojo"}},"required":["expected_ship_date","line_items","memo","reference_id","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Sojo"},"ShipToAddressStar":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"+1234567890"},"email_address":{"type":"string","description":"","example":"user@example.com"}},"required":["address1","city","country","full_name","postal_code"],"additionalProperties":false,"title":"ShipToAddressStar"},"WmsOrderWriteLineItemstar":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemstar"},"CreatewmsOrder--Star__WMS--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressStar"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemstar"}},"shipping_method_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Can also use 'Other'. Make sure that the shipping method's additional_fields corresponds with the warehouse_id specified in this order.","example":"fedex_ground"},"notes":{"type":"string","description":"A note to attach to the order","example":"notes"},"platform_order_number":{"type":"string","description":"The originating sales platform's order number","example":"platform_order_number"},"passthrough_fields":{"type":"object","description":"Use this object to pass fields directly to the underlying API. You will have to read the API's documentation to know what fields are available, and cannot override fields that are managed by Trackstar.","example":{"custom_field_1":"value1","custom_field_2":123},"additionalProperties":{}}},"required":["line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Star WMS"},"StatesShipToAddressStates-Logistics":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"address1":{"type":"string","description":"","example":"123 Main St"},"address2":{"type":["string","null"],"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","postal_code","state"],"additionalProperties":false,"title":"StatesShipToAddressStates-Logistics"},"WmsOrderWriteLineItemstates-logistics":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"lot_id":{"type":"string","description":"The lot ID for the line item.","example":"lot_id"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemstates-logistics"},"CreatewmsOrder--States__Logistics--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/StatesShipToAddressStates-Logistics"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"lot_id":"lot_id"}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemstates-logistics"}},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"States Logistics"},"ShipToAddressStord":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"},"phone_number":{"type":"string","description":"","example":"123-456-7890"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressStord"},"BillToAddressStord":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code"],"additionalProperties":false,"title":"BillToAddressStord"},"WmsOrderWriteLineItemstord":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"lot_id":{"type":"string","description":"","example":"lot_id"},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemstord"},"CreatewmsOrder--Stord--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":["string","null"],"default":null,"description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressStord"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressStord"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"A PREFERRED warehouse that the order will be shipped from.","example":"warehouse_id"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"lot_id":"lot_id","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemstord"}},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":"string","description":"The Standard Carrier Alpha Code (SCAC) for the carrier.","example":"FDXG"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"integration_metadata":{"type":"object","description":"Free-form metadata fields for integration-specific data. See https://developers.stord.com/reference/createsalesorder#body-params for available fields. Passed through to Stord API as-is.","example":{"integration_metadata_order1":"value1","SourceSystem":"Shopify"},"additionalProperties":{}},"shipping_code":{"type":"string","description":"Shipping code for the order","example":"Priority"},"external_posted_at":{"type":"string","format":"date-time","description":"The date and time the order was posted externally.","example":"2023-03-15T13:45:30Z"}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"Stord"},"CreateOrderShipToAddressTlogistics":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","company","country","full_name","postal_code"],"additionalProperties":false,"title":"CreateOrderShipToAddressTlogistics"},"WmsOrderWriteLineItemtlogistics":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","minimum":1,"description":"","example":1},"unit_price":{"type":"number","minimum":0.0,"description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemtlogistics"},"CreatewmsOrder--TLogistics--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","maxLength":20,"description":"A user-friendly identifier for their order.","example":"order_number"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressTlogistics"},"invoice_currency_code":{"type":"string","minLength":3,"maxLength":3,"description":"The currency of the line items' unit_price. Required when any line has a unit_price.","example":"EUR"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemtlogistics"}}},"required":["line_items","order_number","ship_to_address"],"additionalProperties":false,"title":"TLogistics"},"TpsShipToAddressTps":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"address1":{"type":"string","description":"","example":"123 Main St"},"address2":{"type":"string","description":"","example":"Apt 2"},"city":{"type":"string","description":"","example":"San Francisco"},"postal_code":{"type":"string","description":"","example":"94105"},"country":{"type":"string","description":"","example":"United States"},"phone_number":{"type":"string","description":"","example":"+44 20 0000 0000"},"email_address":{"type":"string","description":"","example":"ada@example.com"}},"required":["address1","city","country","full_name"],"additionalProperties":false,"title":"TpsShipToAddressTps"},"WmsOrderCreateLineItemtps":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"SKU-001"},"quantity":{"type":"integer","minimum":1,"description":"","example":2},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemtps"},"CreatewmsOrder--TPS--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"type":{"type":"string","enum":["d2c","b2b"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"invoice_currency_code":{"type":"string","description":"The currency used for this order.","example":"GBP"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"ship_to_address":{"$ref":"#/components/schemas/TpsShipToAddressTps"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"SKU-001","quantity":2,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemtps"}},"note":{"type":"string","description":"","example":"Leave with reception"},"gift_message":{"type":"string","description":"","example":"Enjoy"}},"required":["line_items","reference_id","required_ship_date","ship_to_address","shipping_method_id"],"additionalProperties":false,"title":"TPS"},"ShipToAddressUnis":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressUnis"},"WmsOrderWriteLineItemunis":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemunis"},"CreatewmsOrder--Unis--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"freight_term":{"type":"string","enum":["CC","PP","TP"],"description":"","example":"CC"},"shipping_account_number":{"type":"string","description":"","example":"shipping_account_number"},"shipping_method_id":{"type":"string","enum":["M","L","U","W","NA"],"description":"","example":"L"},"shipping_method":{"type":"string","enum":["M","L","U","W","NA"],"description":"Deprecated - use shipping_method_id instead","example":"L"},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":"string","description":"","example":"scac"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressUnis"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemunis"}}},"required":["freight_term","line_items","reference_id","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Unis"},"ShipToAddressUnleashed":{"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":["country"],"additionalProperties":false,"title":"ShipToAddressUnleashed"},"WmsOrderCreateLineItemunleashed":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateLineItemunleashed"},"CreatewmsOrder--Unleashed--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressUnleashed"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemunleashed"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"customer_code":{"type":"string","description":"","example":"customer_code"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Unleashed"},"ShipToAddressVeeqo":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"ShipToAddressVeeqo"},"WmsOrderWriteLineItemveeqo":{"type":"object","properties":{"product_id":{"type":"string","description":"","example":"product_id"},"unit_price":{"type":"number","description":"","example":0.0},"quantity":{"type":"integer","description":"","example":0}},"required":["product_id","quantity","unit_price"],"additionalProperties":false,"title":"WmsOrderWriteLineItemveeqo"},"CreatewmsOrder--Veeqo--":{"type":"object","properties":{"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":{}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelIdSchema"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressVeeqo"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","unit_price":0.0,"quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemveeqo"}},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"}},"required":["line_items"],"additionalProperties":false,"title":"Veeqo"},"ShipToAddressVeracore":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"address3":{"type":"string","description":"","example":"address3"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressVeracore"},"WmsOrderLineItemveracore":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderLineItemveracore"},"CreatewmsOrder--VeraCore--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_id":{"type":"string","description":"Custom order ID","example":"order_id"},"delivery_date":{"type":"string","format":"date-time","description":"Expected delivery date of the order.","example":"2023-03-15T13:45:30Z"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressVeracore"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderLineItemveracore"}},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"notes":{"type":"string","description":"Notes associated with the inbound shipment.","example":"notes"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"VeraCore"},"OrderShipToAddressWarehance":{"type":"object","properties":{"company":{"type":"string","description":"","example":"Company"},"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"},"first_name":{"type":"string","description":"","example":"first_name"},"last_name":{"type":"string","description":"","example":"last_name"}},"required":["address1","city","country","first_name","last_name","postal_code","state"],"additionalProperties":false,"title":"OrderShipToAddressWarehance"},"WmsOrderWriteLineItemwarehance":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemwarehance"},"WarehanceChannelIdSchema":{"type":"object","properties":{"channel_id":{"type":"string","description":"The ID of the channel.","example":"channel_id"}},"required":["channel_id"],"additionalProperties":false,"title":"WarehanceChannelIdSchema"},"CreatewmsOrder--Warehance--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"service_level":{"type":"string","enum":[],"description":"The type of shipping method requested by the customer.","example":"Standard"},"shipping_method_id":{"type":"string","description":"Use service_level instead.","example":"shipping_method_id"},"shipping_method_name":{"type":"string","description":"Use service_level instead.","example":"shipping_method_name"},"ship_to_address":{"$ref":"#/components/schemas/OrderShipToAddressWarehance"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemwarehance"}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/WarehanceChannelIdSchema"},"required_ship_date":{"type":"string","format":"date-time","description":"The date by which this order must be shipped.","example":"2023-03-15T13:45:30Z"}},"required":["channel_object","line_items","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Warehance"},"ShipToAddressWhiplash":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressWhiplash"},"WmsOrderWriteLineItemwhiplash":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the item.","example":"sku"},"quantity":{"type":"integer","description":"Total quantity of the item.","example":2},"unit_price":{"type":"number","default":0.0,"description":"Price of the item.","example":2}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemwhiplash"},"CreatewmsOrder--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Can pass in either shipping_method_id or shipping_method_name + carrier_id","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. Can pass in either shipping_method_id or shipping_method_name + carrier_id","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Can pass in either shipping_method_id or shipping_method_name + carrier_id","example":"fedex"},"status":{"type":"string","enum":["open","fulfilled","processing"],"description":"The status of the order. See the [order information](info) for more details.","example":"open"},"order_type":{"type":"string","enum":["direct_to_consumer","dropship","retail","transfer","value_added_service","wholesale"],"description":"The type of order.","example":"direct_to_consumer"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressWhiplash"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":2,"unit_price":2}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemwhiplash"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"}},"required":["ship_to_address"],"additionalProperties":false,"title":"Whiplash (Ryder)"},"CreateOrderShipToAddressXorosoft":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email":{"type":"string","description":"","example":"email"}},"required":["address1","city","company","country","full_name","phone_number","postal_code"],"additionalProperties":false,"title":"CreateOrderShipToAddressXorosoft"},"WmsOrderWriteLineItemxorosoft":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"item_quality":{"type":"string","description":"Item quality code that maps to Xorosoft","example":"XYZ-FRST"},"unit_price":{"type":"number","description":"","example":0.0}},"required":["item_quality","quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemxorosoft"},"CreatewmsOrder--Xorosoft--":{"type":"object","properties":{"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":{}},"brand_name":{"type":"string","description":"The brand name associated with this order. Defaults to your 3PL Account Name if not provided.","example":"brand_name"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"cancel_by_date":{"type":"string","format":"date-time","description":"The date an order should be canceled by if not fulfilled. Must be greater than required_ship_date","example":"2021-01-01T12:00:00Z"},"invoice_currency_code":{"type":"string","default":"USD","enum":["USD","CAD","EUR","AUD"],"description":"","example":"USD"},"carrier_name":{"type":"string","default":"RATE SHOP - GROUND","enum":["ABF FREIGHT","ACE Courier Services","AEROPACEX","AEROSTREAM","Apex Motor Express","APPS Express","ARGUS GROUND","ATLAS COURIER","ATS","C&D Logistics","CALYX","Canaan Group","Canada Post","CANADA WEST WAREHOUSING","CANPAR","Carson International","CCT Canada","CENTRAL TRANSPORT","CEVA","CH ROBINSON","CLARKE TRANSPORT","COASTLINE","CONSOLIDATED FASTFRATE","CONWAY","CSA TRANSPORTATION","DAN FOSS","Davidson & Sons","DAY & ROSS","DHL","DIAMOND DELIVERY","DICOM","DIRECTRIGHT CARTAGE 2001 INC","Dynatrans","ESTES EXPRESS","Exmark Transportation Services Ltd","EXPEDITORS","FedEx","FEDEX FREIGHT","FRONTLINE","GALAXY FREIGHT","Globco","GLOBE","GORDON TRUCKING","GREENLIGHT","GUILBAULT LOGISTIQUE","Hi-Way 9 Express","HODGSON FREIGHT","INTERURBAN","J&R HALL","JB HUNT","K & H DISPATCH","KINDERSLEY TRANSPORT LTD","KP TRANSPORT","KWE","LOOMIS","Manatee Logistics","MANITOULIN TRANSPORT","MC FREIGHT","Midland Transport","M-O GROUND","MORNEAU TRANSPORT","MTF","NAT - Rate Shop 2-3 Days","NAT - Rate Shop Air","NAT - Rate Shop Ground","NATIONAL FASTFREIGHT","NATIONAL GROUND","NEW LEGEND","NIJJAR TRUCKING LTD.","NOVEX","Number 8 Freight","OAK HARBOR","OLD DOMINION","Olympia Transportation LTD.","ONTRAC","OVERLAND WEST FREIGHT LINES","P/U Surrey","PCX - PACIFIC COAST EXPRESS","PLAYBOOK LOGISITICS","PRIORITY LOGISTICS","PROWEST","Prudential Transportation LTD","PUROLATOR","PUROLATOR FREIGHT","QAAW","QRC LOGISTICS","QUIKX","RADIUS LOGISTICS","RATE SHOP - 2 DAY","RATE SHOP - 3 DAY","RATE SHOP - AIR","RATE SHOP - GROUND","RATE SHOP - INTERNATIONAL","REDDAWAY","RE-JAY FREIGHT","REMCO","ROADRUNNER","ROLLS RIGHT","ROSEDALE TRANSPORTATION","RR PLETT TRUCKING","S. & S. Forwarding LTD","SAMEDAY","Sarai Express Trucking","SCOTT FREIGHT","SEA TO SKY","Sealion Cargo","Secam","SEE ROUTING GUIDE","SEER","SIMARD WESTLINK","SPEEDEE TRANSPORT","TFORCE","Toppers","TRADEWINDS","TRANS GLOBAL","TRANSX","TRI-AD","TST Overland","TST-CF Express","U.S. XPRESS","Uniuni","UPS","UPS FREIGHT","VAN-KAM FREIGHTWAYS LTD","VITRAN","VK Logistics","WESTERN CANADA","WIZMO","XPO LOGISTICS","YRC FREIGHT","Z&H Freight International"],"description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"shipping_method_name":{"type":"string","default":"RATE SHOP - GROUND","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"service_level":{"type":"string","default":"Delivery (Third Party)","description":"The type of shipping method requested by the customer.","example":"Standard"},"ship_to_address":{"$ref":"#/components/schemas/CreateOrderShipToAddressXorosoft"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"item_quality":"XYZ-FRST","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemxorosoft"}},"type":{"type":"string","enum":["d2c","b2b"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"purchase_order_number":{"type":"string","description":"Customer purchase order number used for identification","example":"1234567"}},"required":["line_items","reference_id","required_ship_date","ship_to_address","type","warehouse_id"],"additionalProperties":false,"title":"Xorosoft"},"ShipToAddressZenventory":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressZenventory"},"WmsOrderWriteLineItemzenventory":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the item.","example":"sku"},"quantity":{"type":"integer","description":"Total quantity of the item.","example":2}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemzenventory"},"CreatewmsOrder--Zenventory--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressZenventory"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":2}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemzenventory"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Zenventory"},"ShipToAddressZoho":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressZoho"},"WmsOrderWriteLineItemzoho":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemzoho"},"CreatewmsOrder--Zoho--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressZoho"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemzoho"}}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Zoho"},"CreatewmsOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreatewmsOrder--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreatewmsOrder--Active__Ants--"},{"$ref":"#/components/schemas/CreatewmsOrder--A.__Duie__Pyle__-_ADP_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Amphora--"},{"$ref":"#/components/schemas/CreatewmsOrder--Amplifier--"},{"$ref":"#/components/schemas/CreatewmsOrder--AMS--"},{"$ref":"#/components/schemas/CreatewmsOrder--Staci__Americas__-_AMWare_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Atomix--"},{"$ref":"#/components/schemas/CreatewmsOrder--Bergen--"},{"$ref":"#/components/schemas/CreatewmsOrder--BEST__Inc.--"},{"$ref":"#/components/schemas/CreatewmsOrder--BlueBox__-_IDrive__Fulfillment_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Boxzooka--"},{"$ref":"#/components/schemas/CreatewmsOrder--Camelot--"},{"$ref":"#/components/schemas/CreatewmsOrder--Capacity--"},{"$ref":"#/components/schemas/CreatewmsOrder--CartonCloud--"},{"$ref":"#/components/schemas/CreatewmsOrder--Clarus--"},{"$ref":"#/components/schemas/CreatewmsOrder--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Darwynn__Fulfillment--"},{"$ref":"#/components/schemas/CreatewmsOrder--DCL--"},{"$ref":"#/components/schemas/CreatewmsOrder--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Delmar--"},{"$ref":"#/components/schemas/CreatewmsOrder--Deposco--"},{"$ref":"#/components/schemas/CreatewmsOrder--Distribution__Management--"},{"$ref":"#/components/schemas/CreatewmsOrder--Dotcom__Distribution--"},{"$ref":"#/components/schemas/CreatewmsOrder--Elite__Ops--"},{"$ref":"#/components/schemas/CreatewmsOrder--eShipping--"},{"$ref":"#/components/schemas/CreatewmsOrder--Evolve--"},{"$ref":"#/components/schemas/CreatewmsOrder--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Amazon--"},{"$ref":"#/components/schemas/CreatewmsOrder--FedEx__Fulfillment--"},{"$ref":"#/components/schemas/CreatewmsOrder--FFE--"},{"$ref":"#/components/schemas/CreatewmsOrder--Finale--"},{"$ref":"#/components/schemas/CreatewmsOrder--Flexport__-_Deliverr_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Flowspace--"},{"$ref":"#/components/schemas/CreatewmsOrder--Fulfillor--"},{"$ref":"#/components/schemas/CreatewmsOrder--fulfilmentcrowd--"},{"$ref":"#/components/schemas/CreatewmsOrder--G__Global--"},{"$ref":"#/components/schemas/CreatewmsOrder--GoBolt--"},{"$ref":"#/components/schemas/CreatewmsOrder--Greenmark__Logistics--"},{"$ref":"#/components/schemas/CreatewmsOrder--I-Fulfilment--"},{"$ref":"#/components/schemas/CreatewmsOrder--Infoplus--"},{"$ref":"#/components/schemas/CreatewmsOrder--JAS--"},{"$ref":"#/components/schemas/CreatewmsOrder--JayGroup--"},{"$ref":"#/components/schemas/CreatewmsOrder--Cart.com__-_Jazz__Central_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Leanafy--"},{"$ref":"#/components/schemas/CreatewmsOrder--Quickbox__-_LogicPod_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Logiwa--"},{"$ref":"#/components/schemas/CreatewmsOrder--Logiwa__IO--"},{"$ref":"#/components/schemas/CreatewmsOrder--Luminous--"},{"$ref":"#/components/schemas/CreatewmsOrder--Luxroutage__LRI--"},{"$ref":"#/components/schemas/CreatewmsOrder--Mabang--"},{"$ref":"#/components/schemas/CreatewmsOrder--Mai__Fulfillment--"},{"$ref":"#/components/schemas/CreatewmsOrder--Mainfreight--"},{"$ref":"#/components/schemas/CreatewmsOrder--MasonHub--"},{"$ref":"#/components/schemas/CreatewmsOrder--Mintsoft--"},{"$ref":"#/components/schemas/CreatewmsOrder--Moda__Express--"},{"$ref":"#/components/schemas/CreatewmsOrder--Next3PL--"},{"$ref":"#/components/schemas/CreatewmsOrder--NextSmartShip--"},{"$ref":"#/components/schemas/CreatewmsOrder--NFI--"},{"$ref":"#/components/schemas/CreatewmsOrder--Nimble--"},{"$ref":"#/components/schemas/CreatewmsOrder--NLRP--"},{"$ref":"#/components/schemas/CreatewmsOrder--NPFulfilment--"},{"$ref":"#/components/schemas/CreatewmsOrder--NRI--"},{"$ref":"#/components/schemas/CreatewmsOrder--OIA__Global--"},{"$ref":"#/components/schemas/CreatewmsOrder--Ongoing__WMS--"},{"$ref":"#/components/schemas/CreatewmsOrder--OrderWise--"},{"$ref":"#/components/schemas/CreatewmsOrder--PackemWMS--"},{"$ref":"#/components/schemas/CreatewmsOrder--Packiyo--"},{"$ref":"#/components/schemas/CreatewmsOrder--Pattern--"},{"$ref":"#/components/schemas/CreatewmsOrder--Picqer--"},{"$ref":"#/components/schemas/CreatewmsOrder--Portless--"},{"$ref":"#/components/schemas/CreatewmsOrder--QLS--"},{"$ref":"#/components/schemas/CreatewmsOrder--Quiet__Platforms--"},{"$ref":"#/components/schemas/CreatewmsOrder--Salesupply--"},{"$ref":"#/components/schemas/CreatewmsOrder--ShipBob--"},{"$ref":"#/components/schemas/CreatewmsOrder--Shipedge--"},{"$ref":"#/components/schemas/CreatewmsOrder--Shipfusion--"},{"$ref":"#/components/schemas/CreatewmsOrder--ShipHero--"},{"$ref":"#/components/schemas/CreatewmsOrder--ShipMonk--"},{"$ref":"#/components/schemas/CreatewmsOrder--Shipping__and__Handling--"},{"$ref":"#/components/schemas/CreatewmsOrder--ShippingTree--"},{"$ref":"#/components/schemas/CreatewmsOrder--ShipStation--"},{"$ref":"#/components/schemas/CreatewmsOrder--ShipStream--"},{"$ref":"#/components/schemas/CreatewmsOrder--Shipwire--"},{"$ref":"#/components/schemas/CreatewmsOrder--SKUSavvy--"},{"$ref":"#/components/schemas/CreatewmsOrder--Linnworks__Core__-_SKUVault_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Smart__Warehousing--"},{"$ref":"#/components/schemas/CreatewmsOrder--Sojo--"},{"$ref":"#/components/schemas/CreatewmsOrder--Star__WMS--"},{"$ref":"#/components/schemas/CreatewmsOrder--States__Logistics--"},{"$ref":"#/components/schemas/CreatewmsOrder--Stord--"},{"$ref":"#/components/schemas/CreatewmsOrder--TLogistics--"},{"$ref":"#/components/schemas/CreatewmsOrder--TPS--"},{"$ref":"#/components/schemas/CreatewmsOrder--Unis--"},{"$ref":"#/components/schemas/CreatewmsOrder--Unleashed--"},{"$ref":"#/components/schemas/CreatewmsOrder--Veeqo--"},{"$ref":"#/components/schemas/CreatewmsOrder--VeraCore--"},{"$ref":"#/components/schemas/CreatewmsOrder--Warehance--"},{"$ref":"#/components/schemas/CreatewmsOrder--Whiplash__-_Ryder_---"},{"$ref":"#/components/schemas/CreatewmsOrder--Xorosoft--"},{"$ref":"#/components/schemas/CreatewmsOrder--Zenventory--"},{"$ref":"#/components/schemas/CreatewmsOrder--Zoho--"}],"title":"CreatewmsOrderInputSchema"},"MagicLink":{"type":"object","properties":{"id":{"type":"string","description":"The magic link ID","example":"c0a4fef52f664ecf9e766c16811c3289"},"url":{"type":"string","description":"The full Magic Link URL to share with your customer","example":"https://link.trackstarhq.com/c0a4fef52f664ecf9e766c16811c3289"},"expires_at":{"type":"string","description":"ISO 8601 timestamp when link expires","example":"2025-09-17T15:01:41Z"},"integration_type":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"description":"Type of integration","example":"wms"},"integration_allow_list":{"type":"array","description":"Allowed integrations","example":["shipbob"],"items":{"type":"string","description":"","example":"integration_allow_list"}},"integration_block_list":{"type":"array","description":"Blocked integrations","example":["extensiv-3pl-central"],"items":{"type":"string","description":"","example":"integration_block_list"}},"integrations_with_endpoints":{"type":"array","description":"Integrations with specific endpoints","example":["get_inventory"],"items":{"type":"string","description":"","example":"integrations_with_endpoints"}},"customer_id":{"type":["string","null"],"description":"Customer identifier","example":"customer-123"}},"required":["customer_id","expires_at","id","integration_allow_list","integration_block_list","integration_type","integrations_with_endpoints","url"],"additionalProperties":false,"title":"MagicLink"},"MagicLinkResponseSchema":{"type":"object","properties":{"magic_link":{"$ref":"#/components/schemas/MagicLink"}},"required":["magic_link"],"additionalProperties":false,"title":"MagicLinkResponseSchema"},"MagicLinkInputSchema":{"type":"object","properties":{"connection_id":{"type":["string","null"],"description":"An optional existing connection ID. If provided, the connection is reinstalled instead of a new connection being created.","example":"connection_id"},"integration_allow_list":{"type":"array","default":[],"description":"Integrations that your users will be allowed to install. Mutually exclusive with `integration_block_list` and `integrations_with_endpoints`.","example":["shipbob"],"items":{"type":"string","description":"","example":"integration_allow_list"}},"integration_block_list":{"type":"array","default":[],"description":"Integrations that your users will not be allowed to install. Mutually exclusive with `integration_allow_list`.","example":["shipbob"],"items":{"type":"string","description":"","example":"integration_block_list"}},"integrations_with_endpoints":{"type":"array","default":[],"description":"Only show integrations that support these endpoints. Mutually exclusive with `integration_allow_list`.","example":["get_inventory","get_products","create_order"],"items":{"type":"string","description":"","example":"integrations_with_endpoints"}},"integration_type":{"type":"string","default":"wms","enum":["wms","freight","cart","carrier","erp"],"description":"The type of integration to filter by.","example":"wms"},"disabled_functions":{"type":"array","default":[],"description":"Endpoints to disable on the connection installed through this link.","example":["get_orders"],"items":{"type":"string","description":"","example":"disabled_functions"}},"enabled_functions":{"type":"array","default":[],"description":"Endpoints to force-enable on the connection installed through this link, overriding your org-level disabled policy (e.g. re-enable returns for this connection).","example":["get_returns"],"items":{"type":"string","description":"","example":"enabled_functions"}},"link_duration":{"type":"integer","default":7,"description":"The number of days you want this magic link to be active.","example":7},"customer_id":{"type":["string","null"],"description":"An identifier for your end customer.","example":"customer_id"}},"additionalProperties":false,"title":"MagicLinkInputSchema"},"MagicLinksResponseSchema":{"type":"object","properties":{"magic_links":{"type":"array","description":"List of magic links","items":{"$ref":"#/components/schemas/MagicLink"}}},"required":["magic_links"],"additionalProperties":false,"title":"MagicLinksResponseSchema"},"SyncSchedule":{"type":"object","properties":{"function_name":{"type":"string","description":"The function that is being synced.","example":"function_name"},"last_crawl_start":{"type":["string","null"],"format":"date-time","description":"The date when Trackstar last started a crawl for this function.","example":"2023-03-15T13:45:30Z"},"last_crawl_end":{"type":["string","null"],"format":"date-time","description":"The date when Trackstar last completed a crawl for this function.","example":"2023-03-15T13:45:30Z"},"latest_data":{"type":["string","null"],"format":"date-time","description":"The date of the most recent data successfully fetched for this function.","example":"2023-03-15T13:45:30Z"},"sync_frequency":{"type":"integer","description":"The frequency of the sync in seconds.","example":0},"sync_status":{"type":["string","null"],"enum":["enabled","disabled","sync_in_progress","first_sync_in_progress","error","stuck"],"description":"The status of the sync.","example":"sync_in_progress"}},"required":["function_name","last_crawl_end","last_crawl_start","latest_data","sync_frequency","sync_status"],"additionalProperties":false,"title":"SyncSchedule"},"AffectedEndpoints":{"type":"object","properties":{"endpoint":{"type":"string","description":"The endpoint that was affected.","example":"GET /wms/inventory"},"preventing_sync":{"type":"boolean","description":"If True, the error is preventing the sync from completing. If False, we are able to sync but there may be data or fields that we are unable to fetch.","example":false}},"required":["endpoint","preventing_sync"],"additionalProperties":false,"title":"AffectedEndpoints"},"ConnectionError":{"type":"object","properties":{"error_message":{"type":"string","description":"The error message.","example":"error_message"},"affected_endpoints":{"type":"array","description":"A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.","example":[{"endpoint":"GET /wms/inventory","preventing_sync":true},{"endpoint":"GET /wms/orders","preventing_sync":false}],"items":{"$ref":"#/components/schemas/AffectedEndpoints"}},"first_seen":{"type":"string","format":"date-time","description":"The date the error was first seen.","example":"2023-03-15T13:45:30Z"},"last_seen":{"type":"string","format":"date-time","description":"The date the error was last seen.","example":"2023-03-15T13:45:30Z"}},"required":["affected_endpoints","error_message","first_seen","last_seen"],"additionalProperties":false,"title":"ConnectionError"},"Connection":{"type":"object","properties":{"connection_id":{"type":"string","description":"The unique ID of the connection.","example":"connection_id"},"integration_name":{"type":"string","description":"The name of the integration associated with the connection.","example":"integration_name"},"integration_display_name":{"type":"string","description":"The human-readable display name of the integration associated with the connection.","example":"ShipBob"},"customer_id":{"type":["string","null"],"description":"An identifier for your end customer.","example":"customer_id"},"created_at":{"type":"string","format":"date-time","description":"The date the connection was created.","example":"2022-01-01T00:00:00Z"},"last_used":{"type":["string","null"],"format":"date-time","description":"The date the connection was last updated.","example":"2022-01-02T05:05:05Z"},"times_used":{"type":["integer","null"],"description":"The number of times the connection has been used in a request to the Trackstar API. Equal to the number of API calls made with this connection.","example":0},"sync_schedules":{"type":"array","description":"A list of sync schedules for the connection.","items":{"$ref":"#/components/schemas/SyncSchedule"}},"errors":{"type":"array","description":"A list of errors for the connection. e.g. missing permissions, invalid credentials, etc.","items":{"$ref":"#/components/schemas/ConnectionError"}},"available_actions":{"type":"array","description":"A list of actions that the integration supports.","items":{"type":"string","description":"Action supported by the integration","example":"available_actions"}},"integration_type":{"type":"string","enum":["wms","freight","cart","carrier","erp"],"description":"The type of the integration.","example":"wms"},"webhooks_disabled":{"type":["boolean","null"],"description":"If True, create & update webhooks for Trackstar objects (e.g. order.created) will not be sent for this connection. Connection specific webhooks (e.g. connection.deleted) will still be sent.","example":false},"paused":{"type":"boolean","description":"If True, every sync schedule for this connection is paused and no data will sync until at least one schedule is resumed.","example":false},"paused_at":{"type":["string","null"],"format":"date-time","description":"The date every sync schedule for this connection was paused. Null if the connection is not currently paused.","example":"2022-01-02T05:05:05Z"},"historical_sync_completed":{"type":"object","description":"Indicates whether the initial historical sync has been completed for each function. If a key is not present or empty, assume the historical sync has not been completed for that function.","example":{"get_bills":true,"get_inbound_shipments":true,"get_inventory":true,"get_orders":true,"get_products":true,"get_returns":true,"get_warehouse_customers":true,"get_warehouse_locations":true,"get_warehouses":true},"additionalProperties":{"type":"boolean","description":"Whether the historical sync has been completed for the function.","example":true}},"me":{"description":"Information that helps identify the connected account. If null, the integration does not provide this information.","example":{"account_id":"account_12345","account_name":"My WMS Account"}}},"required":["available_actions","connection_id","created_at","customer_id","errors","historical_sync_completed","integration_display_name","integration_name","integration_type","last_used","me","paused","paused_at","sync_schedules","times_used","webhooks_disabled"],"additionalProperties":false,"title":"Connection"},"GetConnectionsResponse":{"type":"object","properties":{"data":{"type":"array","description":"A list of connections for your organization.","example":[{"connection_id":"07b344db-0304-4866-9ae1-ac8af5292a28","integration_name":"integration_name","integration_display_name":"ShipBob","customer_id":"customer_id","created_at":"2023-01-01T00:00:00Z","last_used":"2023-01-01T00:00:00Z","times_used":1,"sync_schedules":[{"function_name":"get_inventory","last_crawl_start":"2023-01-01T00:00:00Z","last_crawl_end":"2023-01-01T00:00:00Z","latest_data":"2023-01-01T00:00:00Z","sync_frequency":3600,"sync_status":"enabled"}],"errors":[{"error_message":"error_message","affected_endpoints":[{"endpoint":"GET /connection","preventing_sync":false}],"first_seen":"2023-01-01T00:00:00Z","last_seen":"2023-01-01T00:00:00Z"}],"available_actions":["get_inventory","get_products"],"integration_type":"wms","webhooks_disabled":false,"historical_sync_completed":{"get_bills":true,"get_inbound_shipments":true,"get_inventory":true,"get_orders":true,"get_products":true,"get_returns":true,"get_warehouse_customers":true,"get_warehouse_locations":true,"get_warehouses":true},"me":{"account_id":"account_12345","account_name":"My WMS Account"}}],"items":{"$ref":"#/components/schemas/Connection"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"additionalProperties":false,"title":"GetConnectionsResponse"},"DeleteConnectionResponse":{"type":"object","properties":{"id":{"type":"string","description":"The id of the deleted object.","example":"example-id-123"},"object":{"type":"string","description":"The type of the object that was deleted.","example":"connection"},"deleted":{"type":"boolean","description":"Whether or not the object was deleted.","example":true}},"required":["deleted","id","object"],"additionalProperties":false,"title":"DeleteConnectionResponse"},"UpdateResponseSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the updated object.","example":"example-id-123"},"object":{"type":"string","description":"The type of the object that was updated.","example":"connection"},"updated":{"type":"boolean","description":"Whether or not the object was updated.","example":true}},"required":["id","object","updated"],"additionalProperties":false,"title":"UpdateResponseSchema"},"UpdateConnectionSchema":{"type":"object","properties":{"customer_id":{"type":["string","null"],"description":"An identifier for your end customer.","example":"customer_id"},"webhooks_disabled":{"type":"boolean","description":"","example":true}},"additionalProperties":false,"title":"UpdateConnectionSchema"},"WmsReturnIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsReturnIdsQueryParam"},"WmsReturnCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsReturnCreated_DateQueryParam"},"WmsReturnUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsReturnUpdated_DateQueryParam"},"WmsReturnTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsReturnTrackstar_Created_DateQueryParam"},"WmsReturnTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsReturnTrackstar_Updated_DateQueryParam"},"WmsReturnTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"WmsReturnTrackstar_Tags_FlatQueryParam"},"WmsReturnStatusQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"open"},"neq":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"cancelled"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"cancelled"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"cancelled"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsReturnStatusQueryParam"},"WmsReturnWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsReturnWarehouse_Customer_IdQueryParam"},"WmsReturnOrder_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"order_123"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsReturnOrder_IdQueryParam"},"WmsReturnLineItem":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"How many units are expected to arrive.","example":1},"received_quantity":{"type":"integer","description":"How many units actually arrived.","example":1},"restocked_quantity":{"type":["integer","null"],"description":"The number of returned inventory items that have been restocked.","example":1},"return_reason":{"type":["string","null"],"description":"The reason for the return.","example":"Too Small"}},"required":["expected_quantity","inventory_item_id","received_quantity","restocked_quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnLineItem"},"ShipmentMeasurements":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the shipment.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the shipment.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ShipmentMeasurements"},"ReceivingDetails":{"type":"object","properties":{"quantity":{"type":"integer","description":"How many units were received in this condition and disposition.","example":1},"condition":{"type":["string","null"],"description":"The condition of the item received.","example":"good"},"disposition":{"type":["string","null"],"description":"The disposition of the item received, eg restocked or discarded.","example":"restocked"}},"required":["condition","disposition","quantity"],"additionalProperties":false,"title":"ReceivingDetails"},"ReturnShipmentLineItem":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"How many units were shipped.","example":1},"receiving_details":{"type":"array","description":"Details about received items in the shipment.","example":[{"quantity":1,"condition":"good","disposition":"restocked"}],"items":{"$ref":"#/components/schemas/ReceivingDetails"}}},"required":["inventory_item_id","quantity","receiving_details","sku"],"additionalProperties":false,"title":"ReturnShipmentLineItem"},"ReturnShipment":{"type":"object","properties":{"tracking_number":{"type":["string","null"],"description":"The tracking number of the shipment.","example":"tracking_number"},"shipped_date":{"type":["string","null"],"format":"date-time","description":"The date the shipment was sent.","example":"2023-03-15T13:45:30Z"},"arrived_date":{"type":["string","null"],"format":"date-time","description":"The date the shipment arrived.","example":"2023-03-15T13:45:30Z"},"warehouse_id":{"type":["string","null"],"description":"The ID of the warehouse the shipment was sent to. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier for the shipment.","example":"carrier_id"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier for the shipment.","example":"carrier_name"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code (SCAC) for the shipment.","example":"FDXG"},"shipping_cost":{"type":["number","null"],"description":"The cost of the shipment.","example":0.0},"measurements":{"$ref":"#/components/schemas/ShipmentMeasurements"},"line_items":{"type":"array","description":"List of inventory items items in the shipment.","items":{"$ref":"#/components/schemas/ReturnShipmentLineItem"}}},"required":["arrived_date","carrier_id","carrier_name","line_items","measurements","scac","shipped_date","shipping_cost","tracking_number","warehouse_id"],"additionalProperties":false,"title":"ReturnShipment"},"WmsReturnApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the return.","example":"return_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the return was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the return was last updated.","example":"2022-01-02T05:05:05Z"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"order_id":{"type":["string","null"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"notes":{"type":"array","description":"A list of notes associated with the return.","example":["This is a note"],"items":{"type":"string","description":"This is a note","example":"notes"}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":1,"received_quantity":1,"restocked_quantity":1,"return_reason":"Too Small"}],"items":{"$ref":"#/components/schemas/WmsReturnLineItem"}},"shipments":{"type":"array","description":"List of the shipments associated with the return.","example":[{"tracking_number":"tracking_number","shipped_date":"2023-02-03T02:04:06Z","arrived_date":"2023-02-03T02:04:06Z","warehouse_id":"warehouse_id","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"FDXG","shipping_cost":1.23,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":4,"receiving_details":[{"quantity":1,"condition":"good","disposition":"restocked"},{"quantity":1,"condition":"damaged","disposition":"scrapped"}]}]}],"items":{"$ref":"#/components/schemas/ReturnShipment"}},"external_system_url":{"type":["string","null"],"description":"URL link to the return in the external system (WMS/Freight etc).","example":"https://example.com/return/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","external_system_url","id","line_items","notes","order_id","raw_status","shipments","status","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsReturnApiItemSchema"},"WmsReturnsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsReturnApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsReturnsListEndpoint"},"CreateReturnResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the return.","example":"return_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the return was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the return was last updated.","example":"2022-01-02T05:05:05Z"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"order_id":{"type":["string","null"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"notes":{"type":"array","description":"A list of notes associated with the return.","example":["This is a note"],"items":{"type":"string","description":"This is a note","example":"notes"}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":1,"received_quantity":1,"restocked_quantity":1,"return_reason":"Too Small"}],"items":{"$ref":"#/components/schemas/WmsReturnLineItem"}},"shipments":{"type":"array","description":"List of the shipments associated with the return.","example":[],"items":{"$ref":"#/components/schemas/ReturnShipment"}},"external_system_url":{"type":["string","null"],"description":"URL link to the return in the external system (WMS/Freight etc).","example":"https://example.com/return/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","external_system_url","id","line_items","notes","order_id","raw_status","shipments","status","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"CreateReturnResponseDataSchema"},"wmsCreateReturnResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateReturnResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateReturnResponse"},"WmsReturnWriteLineItemsandbox":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"sku","example":"XS-RED-SHIRT"},"expected_quantity":{"type":"integer","description":"","example":1},"return_reason":{"type":"string","description":"The reason for the return.","example":"damaged"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemsandbox"},"CreatewmsReturn--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"order_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"XS-RED-SHIRT","expected_quantity":1,"return_reason":"damaged"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemsandbox"}}},"required":["line_items","order_id","warehouse_id"],"additionalProperties":false,"title":"WMS Sandbox"},"WmsReturnWriteLineItembergen":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItembergen"},"ReturnFromAddressBergen":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","state"],"additionalProperties":false,"title":"ReturnFromAddressBergen"},"CreatewmsReturn--Bergen--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"customer_po":{"type":"string","description":"The customer PO or order number to store with the return.","example":"customer_po"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItembergen"}},"carrier_id":{"type":"string","description":"The carrier of the return shipment.","example":"UPS"},"tracking_number":{"type":"string","description":"The tracking number of the return shipment.","example":"tracking_number"},"ship_from_address":{"$ref":"#/components/schemas/ReturnFromAddressBergen"}},"required":["carrier_id","line_items","ship_from_address","warehouse_id"],"additionalProperties":false,"title":"Bergen"},"WmsReturnWriteLineItembleckmann":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItembleckmann"},"CreatewmsReturn--Bleckmann--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItembleckmann"}},"tracking_number":{"type":"string","description":"The tracking number for the return.","example":"tracking_number"}},"required":["line_items"],"additionalProperties":false,"title":"Bleckmann"},"WmsReturnWriteLineItembluebox":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"Total quantity expected to be returned.","example":0},"return_reason":{"type":"string","description":"The reason for the return.","example":"return_reason"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItembluebox"},"CreatewmsReturn--BlueBox__-_IDrive__Fulfillment_---":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"The customer order number associated with the return.","example":"order_number"},"reference_id":{"type":"string","description":"The external ID of the return.","example":"reference_id"},"tracking_number":{"type":"string","description":"The tracking number of the return.","example":"tracking_number"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"return_reason"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItembluebox"}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"external_source":{"type":"string","description":"The external source of the return.","example":"external_source"}},"required":["line_items","order_number","reference_id","tracking_number"],"additionalProperties":false,"title":"BlueBox (IDrive Fulfillment)"},"WmsReturnWriteLineItemboxzooka":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":1},"return_reason":{"type":"string","description":"","example":"return_reason"},"condition":{"type":"string","description":"","example":"condition"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemboxzooka"},"CreatewmsReturn--Boxzooka--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":1,"return_reason":"return_reason","condition":"condition"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemboxzooka"}},"tracking_number":{"type":"string","description":"The tracking number of the return shipment.","example":"1Z999AA10123456784"},"carrier":{"type":"string","description":"The carrier for the return shipment.","example":"carrier"}},"required":["line_items","order_id","tracking_number"],"additionalProperties":false,"title":"Boxzooka"},"ReturnShipToAddressCirro":{"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","postal_code","state"],"additionalProperties":false,"title":"ReturnShipToAddressCirro"},"WmsReturnWriteLineItemcirro":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"platform_name":{"type":"string","enum":["AMAZON","SHOPIFY","EBAY","WOOCOMERCE","TIKTOK_SHOP","WALMART","SHEIN","EASYSHIP","IML","LINNWORKS","PRESTASHOP","SKUBANA","ETSY","MINTSOFT","CHANNELADVISOR","SPSCOMMERCE","SHIPSTATION","SPRING","WIX","ECWID","SQUARESPACE","BIGCOMMERCE","MAGENTO","CART.COM","CHORD","XCART","ACENDA","COMMERCETOOLS","VTEX","SELLERACTIVE","WAYFAIR","MIRAKL","HOUZZ","APPARELMAGIC","SALESFORCE","SQUARE"],"description":"The name of the platform from which the sku originates. If provided, will be used to find the Cirro SKU.","example":"SHOPIFY"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemcirro"},"CreatewmsReturn--Cirro--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"carrier_id":{"type":"string","description":"The carrier to use for the return shipment. One of carrier_id or carrier_name is required. Will take precedence over carrier_name if provided.","example":"UPS"},"carrier_name":{"type":"string","description":"The carrier to use for the return shipment","example":"UPS"},"tracking_number":{"type":"string","description":"The tracking number for the return shipment","example":"1Z12345E0205271688"},"reference_number":{"type":"string","description":"The reference number for the return shipment","example":"1234567890"},"ship_to_address":{"$ref":"#/components/schemas/ReturnShipToAddressCirro"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","platform_name":"SHOPIFY","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemcirro"}},"return_reason":{"type":"string","description":"The reason for the return. Damaged, Defective, Incorrect Item, etc.","example":"return_reason"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"}},"required":["line_items","order_id","ship_to_address","tracking_number","warehouse_id"],"additionalProperties":false,"title":"Cirro"},"WmsReturnWriteLineItemcontrolport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"line_item_id":{"type":"string","description":"The specific order line to return against, needed only when a product is on the order more than once.","example":"line_item_id"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","enum":["connect an account to see available return reasons"],"description":"return reason name or id from the return-reason endpoint","example":"Faulty"},"desired_outcome":{"type":"string","description":"what should happen to the returned item","example":"exchange"}},"required":["desired_outcome","expected_quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemcontrolport"},"CreatewmsReturn--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","line_item_id":"line_item_id","expected_quantity":0,"return_reason":"Faulty","desired_outcome":"exchange"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemcontrolport"}},"tracking_number":{"type":"string","description":"The tracking number for the return shipment.","example":"tracking_number"},"carrier_name":{"type":"string","description":"The carrier bringing the return back.","example":"carrier_name"}},"required":["line_items","order_id"],"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"WmsReturnWriteLineItemdcl":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemdcl"},"CreatewmsReturn--DCL--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDcl"},"carrier_id":{"type":"string","description":"The carrier used to ship the return.","example":"UPS"},"shipping_method":{"type":"string","description":"The method used to ship the return.","example":"GROUND"},"warehouse_id":{"type":"string","enum":["FR","LA","LN","KY","YK","EX","EU"],"description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"EU"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemdcl"}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"return_type":{"type":"string","enum":["1: Replace Upon Receipt.","2: Replace Now - No Return.","3: Replace Now - With Return.","11: Refund Upon Receipt.","12: Refund Now - No Return.","13: Refund Now - With Return.","21: Gift Voucher Upon Receipt.","22: Gift Voucher Now - No Return.","23: Gift Voucher Now - With Return.","24: Gift Card Upon Receipt.","25: Gift Card Now - No Return.","26: Gift Card Now - With Return.","31: Upgrade Upon Receipt.","32: Upgrade Now - No Return.","33: Upgrade Now - With Return.","81: Return For Repair.","82: Not For DCL.","99: Review."],"description":"","example":"11: Refund Upon Receipt."},"disposition":{"type":"string","enum":["1: Await Decision.","2: Return To Stock.","3: Scrap.","5: Rework.","10: Test.","18: Return To Vendor."],"description":"","example":"10: Test."}},"required":["disposition","line_items","return_type","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"DCL"},"ReturnShipToAddressDeposco":{"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","postal_code","state"],"additionalProperties":false,"title":"ReturnShipToAddressDeposco"},"WmsReturnWriteLineItemdeposco":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the product to return.","example":"sku"},"inventory_item_id":{"type":"string","description":"Deprecated. Use `sku` instead.","example":"inventory_item_id"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity"],"additionalProperties":false,"title":"WmsReturnWriteLineItemdeposco"},"CreatewmsReturn--Deposco--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"ship_to_address":{"$ref":"#/components/schemas/ReturnShipToAddressDeposco"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","inventory_item_id":"inventory_item_id","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemdeposco"}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"number":{"type":"string","description":"An optional return number to use for the return. If not provided, a unique number will be generated.","example":"RMA123"},"return_reason":{"type":"string","description":"The reason for the return. RTS, Partial Customer Return, Full Customer Return","example":"return_reason"},"customer_order_number":{"type":"string","description":"The customer order number in Deposco","example":"PF#"},"tracking_number":{"type":"string","description":"The tracking number of the return","example":"9434636106023310081309"}},"required":["line_items"],"additionalProperties":false,"title":"Deposco"},"WmsReturnWriteLineItemextensiv-3pl-central":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemextensiv-3pl-central"},"CreatewmsReturn--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"reference_number":{"type":"string","description":"Reference Number","example":"reference_number"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemextensiv-3pl-central"}},"tracking_number":{"type":"string","description":"Tracking Number","example":"tracking_number"}},"required":["line_items","reference_number","warehouse_id"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"WmsReturnWriteLineItemflexport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemflexport"},"ReturnAddressFlexport":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ReturnAddressFlexport"},"CreatewmsReturn--Flexport__-_Deliverr_---":{"type":"object","properties":{"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":{}},"rma":{"type":"string","description":"The RMA of the return, typically generated by the merchant.","example":"rma"},"reference_id":{"type":"string","description":"The unique reference ID of the return.","example":"return_reference_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemflexport"}},"ship_from_address":{"$ref":"#/components/schemas/ReturnAddressFlexport"}},"required":["line_items","reference_id","rma","ship_from_address"],"additionalProperties":false,"title":"Flexport (Deliverr)"},"WmsReturnWriteLineItemfulfil":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"id":{"type":"string","description":"The specific order line to return against, needed only when a SKU appears on the order more than once.","example":"id"},"return_reason":{"type":"string","description":"The reason for the return.","example":"return_reason"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemfulfil"},"CreatewmsReturn--Fulfil--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"id":"id","return_reason":"return_reason"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemfulfil"}}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Fulfil"},"WmsReturnCreateLineItemi-fulfilment":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the item.","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"The expected quantity to return.","example":0},"quantity":{"type":"integer","minimum":1,"description":"Use `expected_quantity` instead.","example":0},"action":{"type":"string","enum":["refund","exchange","stock"],"description":"The return action.","example":"exchange"},"return_reason":{"type":"string","enum":["Size and fit - too large","Size and fit - too small","Size and fit - doesn't fit well","Design - colour","Quality - faulty","Quality - poor quality","Ordering - multi purchase for size trial","Ordering - wrong item delivered","Ordering - no longer required","Other - please specify"],"description":"The reason for the return.","example":"Design - colour"},"description":{"type":"string","description":"The description of why the return is being created.","example":"description"}},"required":["action","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnCreateLineItemi-fulfilment"},"CreatewmsReturn--I-Fulfilment--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"The order reference.","example":"reference_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"quantity":0,"action":"exchange","return_reason":"Design - colour","description":"description"}],"items":{"$ref":"#/components/schemas/WmsReturnCreateLineItemi-fulfilment"}}},"required":["line_items","reference_id"],"additionalProperties":false,"title":"I-Fulfilment"},"SupplierId":{"type":"object","properties":{"supplier_id":{"type":"string","description":"The ID of the supplier.","example":"supplier_id"}},"required":["supplier_id"],"additionalProperties":false,"title":"SupplierId"},"WriteSupplierName":{"type":"object","properties":{"supplier_name":{"type":"string","description":"The name of the supplier. If supplier ID is provided, that will take precedence over this.","example":"supplier_name"}},"required":["supplier_name"],"additionalProperties":false,"title":"WriteSupplierName"},"WriteSupplierSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/SupplierId"},{"$ref":"#/components/schemas/WriteSupplierName"}],"discriminator":{"propertyName":"type","mapping":{"id":"#/components/schemas/SupplierId","name":"#/components/schemas/WriteSupplierName"}},"title":"WriteSupplierSchema"},"WmsReturnWriteLineIteminfoplus":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineIteminfoplus"},"CreatewmsReturn--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"return_type":{"type":"string","enum":["Job","Kit","Normal","Transfer","Blind"],"description":"Type of return","example":"Blind"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineIteminfoplus"}}},"required":["line_items","order_id","return_type","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Infoplus"},"WmsReturnWriteLineItemjazz-central":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"return_reason"}},"required":["expected_quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemjazz-central"},"CreatewmsReturn--Cart.com__-_Jazz__Central_---":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"return_reason"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemjazz-central"}}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Cart.com (Jazz Central)"},"ExchangeItemSchema":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the item to exchange for","example":"sku"},"quantity":{"type":"integer","description":"Quantity of the item to exchange for","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"ExchangeItemSchema"},"WmsReturnWriteLineItemlinnworks":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","description":"","example":"return_reason"},"exchange_items":{"type":"array","description":"A list of items to exchange for this line item","example":[{"sku":"sku123","quantity":1}],"items":{"$ref":"#/components/schemas/ExchangeItemSchema"}}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemlinnworks"},"CreatewmsReturn--Linnworks--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"return_reason","exchange_items":[{"sku":"sku123","quantity":1}]}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemlinnworks"}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Linnworks"},"WmsReturnWriteLineItemlogiwa":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemlogiwa"},"CreatewmsReturn--Logiwa--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemlogiwa"}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Logiwa"},"WmsReturnWriteLineItemlogiwa-io":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemlogiwa-io"},"CreatewmsReturn--Logiwa__IO--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"rma_number":{"type":"string","description":"An optional RMA number. If not provided, a random one will be generated.","example":"rma_number"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemlogiwa-io"}},"tracking_number":{"type":"string","description":"The tracking number of the return.","example":"tracking_number"}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Logiwa IO"},"WmsReturnWriteLineItemluminous":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":1}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemluminous"},"CreatewmsReturn--Luminous--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":1}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemluminous"}}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Luminous"},"ShipFromAddressMasonhub":{"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","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressMasonhub"},"WmsReturnWriteLineItemmasonhub":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","enum":["tooBig","tooSmall","damaged","wrongItem","other"],"description":"Customer supplied reason code for this return","example":"damaged"},"return_inventory_status":{"type":"string","default":"qc","enum":["available","qc","damaged","quarantine"],"description":"The inventory status to return the units into.","example":"qc"}},"required":["expected_quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemmasonhub"},"CreatewmsReturn--MasonHub--":{"type":"object","properties":{"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":{}},"return_type":{"type":"string","enum":["returned_to_sender","rma_submitted_by_customer","rma_created_by_distribution_center"],"description":"The type of return.","example":"returned_to_sender"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressMasonhub"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"damaged","return_inventory_status":"qc"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemmasonhub"}},"order_id":{"type":"string","description":"The ID of the original order.","example":"order_id"}},"required":["line_items","return_type","ship_from_address"],"additionalProperties":false,"title":"MasonHub"},"WmsReturnWriteLineItemmintsoft":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","description":"The reason for the return.","example":"Faulty or Damaged"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemmintsoft"},"CreatewmsReturn--Mintsoft--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"Faulty or Damaged"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemmintsoft"}}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Mintsoft"},"WmsReturnWriteLineItemmoda-express":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"description":"Item identifier as it appears in the Datex material master.","example":"SKU123"},"expected_quantity":{"type":"integer","minimum":1,"description":"Quantity expected for this line.","example":1}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemmoda-express"},"CreatewmsReturn--Moda__Express--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"SKU123","expected_quantity":1}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemmoda-express"}}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Moda Express"},"WmsReturnWriteLineItemnimble":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemnimble"},"CreatewmsReturn--Nimble--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemnimble"}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"destination_location_name":{"type":"string","description":"Destination location name","example":"Warehouse"},"supplier_first_name":{"type":"string","description":"Supplier first name","example":"John"},"supplier_last_name":{"type":"string","description":"Supplier last name","example":"Doe"},"tracking_number":{"type":"string","description":"Tracking number","example":"123456789"},"shopify_order_name":{"type":"string","description":"Shopify order name","example":"#1234"},"return_platform_name":{"type":"string","enum":["NIMBLE","LOOP","HAPPY_RETURNS","REDO"],"description":"Return platform name","example":"HAPPY_RETURNS"},"return_platform_id":{"type":"string","description":"Return platform ID","example":"return_platform_id"},"loop_status":{"type":"string","enum":["OPEN","CLOSED","CANCELLED","EXPIRED","REVIEW"],"description":"Loop status","example":"CANCELLED"},"loop_return_id":{"type":"string","description":"Loop return ID","example":"123456"},"return_reason":{"type":"string","description":"Return reason","example":"Defective item"},"carrier_id":{"type":"string","description":"Shipping carrier","example":"UPS"},"shipping_method_id":{"type":"string","description":"Shipping service","example":"Ground"}},"required":["line_items","return_reason","warehouse_id"],"additionalProperties":false,"title":"Nimble"},"WmsReturnWriteLineItemnri":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","description":"The NRI reason code for the return line. Client-configured in NRI (e.g. 'RR').","example":"return_reason"},"ra_line_action_code":{"type":"string","description":"The NRI line action code. Client-configured in NRI (e.g. 'UN').","example":"ra_line_action_code"}},"required":["expected_quantity","ra_line_action_code","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemnri"},"CreatewmsReturn--NRI--":{"type":"object","properties":{"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":{}},"id":{"type":"string","description":"The return authorization number. Used as the primary reference ID for the return.","example":"id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"client_reference_number_2":{"type":"string","description":"Optional secondary reference number for the return.","example":"client_reference_number_2"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"return_reason","ra_line_action_code":"ra_line_action_code"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemnri"}}},"required":["id","line_items"],"additionalProperties":false,"title":"NRI"},"WmsReturnWriteLineItemoia-global":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":1}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemoia-global"},"ReturnShipFromAddressOia-Global":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ReturnShipFromAddressOia-Global"},"CreatewmsReturn--OIA__Global--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":1}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemoia-global"}},"ship_from_address":{"$ref":"#/components/schemas/ReturnShipFromAddressOia-Global"}},"required":["line_items"],"additionalProperties":false,"title":"OIA Global"},"ReturnCause":{"type":"object","properties":{"code":{"type":"string","enum":["N/A"],"description":"The reason code for this return.","example":"code"},"return_reason":{"type":["string","null"],"enum":["Connect an account to get return causes."],"description":"The reason description for this return.","example":"return_reason"}},"required":["code"],"additionalProperties":false,"title":"ReturnCause"},"WmsReturnWriteLineItemongoing":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_cause":{"$ref":"#/components/schemas/ReturnCause"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemongoing"},"CreatewmsReturn--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"return_number":{"type":"string","description":"Return number","example":"return_number"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_cause":null}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemongoing"}},"tracking_number":{"type":"string","description":"","example":"tracking_number"},"tracking_url":{"type":"string","description":"","example":"tracking_url"}},"required":["line_items","order_id","return_number"],"additionalProperties":false,"title":"Ongoing WMS"},"WmsReturnWriteLineItemquiet":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","default":"No reason provided","description":"","example":"No reason provided"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemquiet"},"CreatewmsReturn--Quiet__Platforms--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"return_number":{"type":"string","description":"Client assigned RMA number","example":"return_number"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"No reason provided"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemquiet"}},"tracking_number":{"type":"string","description":"","example":"tracking_number"}},"required":["line_items","order_id","return_number","warehouse_id"],"additionalProperties":false,"title":"Quiet Platforms"},"WmsReturnWriteLineItemreturn-helper":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the returned product.","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"description":{"type":"string","description":"A description of one unit, shown on the label.","example":"description"},"unit_weight":{"type":"number","description":"The weight of one unit, in the unit given in measurements.weight_unit.","example":0.0},"unit_value":{"type":"number","minimum":0.0,"description":"The declared value of one unit, in the currency given in currency.","example":0.0}},"required":["description","expected_quantity","sku","unit_value","unit_weight"],"additionalProperties":false,"title":"WmsReturnWriteLineItemreturn-helper"},"CreateReturnMeasurementsReturnHelper":{"type":"object","properties":{"length":{"type":"number","description":"","example":0.0},"width":{"type":"number","description":"","example":0.0},"height":{"type":"number","description":"","example":0.0},"unit":{"type":"string","enum":["cm","in"],"description":"The unit for length, width and height.","example":"cm"},"weight":{"type":"number","description":"","example":0.0},"weight_unit":{"type":"string","enum":["g","kg","lb","oz"],"description":"The unit for the parcel weight and each unit weight.","example":"g"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"CreateReturnMeasurementsReturnHelper"},"ShipFromAddressReturn-Helper":{"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"},"email_address":{"type":"string","description":"The email address of the person shipping the return.","example":"email_address"},"phone_number":{"type":"string","description":"The phone number of the person shipping the return.","example":"5555550100"}},"required":["address1","city","country","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressReturn-Helper"},"CreatewmsReturn--Return__Helper--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"order_title":{"type":"string","description":"The title Return Helper shows for the return and its label. Free text, not an order reference.","example":"Return Label Title"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"description":"description","unit_weight":0.0,"unit_value":0.0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemreturn-helper"}},"shipping_method":{"type":"string","description":"The return label service code, for example fedex_ground. It comes from the return service list for the sender's country and the receiving warehouse, not from the shipping methods endpoint.","example":"fedex_ground"},"currency":{"type":"string","minLength":3,"maxLength":3,"description":"The ISO 4217 currency code of the declared values.","example":"usd"},"measurements":{"$ref":"#/components/schemas/CreateReturnMeasurementsReturnHelper"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressReturn-Helper"}},"required":["currency","line_items","measurements","order_title","ship_from_address","shipping_method","warehouse_id"],"additionalProperties":false,"title":"Return Helper"},"WmsReturnWriteLineItemshipbob":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"","example":"inventory_item_id"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","inventory_item_id"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipbob"},"CreatewmsReturn--ShipBob--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"reference_id":{"type":"string","description":"External unique identifier for the return order.","example":"reference_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"inventory_item_id","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipbob"}},"tracking_number":{"type":"string","description":"Tracking number of the return.","example":"tracking_number"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"}},"required":["line_items","reference_id","warehouse_id"],"additionalProperties":false,"title":"ShipBob"},"WmsReturnWriteLineItemshipedge":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipedge"},"CreatewmsReturn--Shipedge--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipedge"}}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Shipedge"},"WmsReturnWriteLineItemshipfusion":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipfusion"},"ShipFromAddressShipfusion":{"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"},"email_address":{"type":"string","pattern":"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$","description":"The email address of the person shipping the return.","example":"johnsmith@gmail.com"}},"required":["address1","city","country","email_address","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressShipfusion"},"CreatewmsReturn--Shipfusion--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipfusion"}},"return_reason":{"type":"string","description":"The reason for the return.","example":"damaged"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressShipfusion"}},"required":["line_items","ship_from_address","warehouse_id"],"additionalProperties":false,"title":"Shipfusion"},"FromAddressShiphero":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"address1":{"type":"string","description":"","example":"123 Main St"},"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","postal_code","state"],"additionalProperties":false,"title":"FromAddressShiphero"},"WmsReturnWriteLineItemshiphero":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","description":"","example":"return_reason"}},"required":["expected_quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshiphero"},"Dimensions":{"type":"object","properties":{"length":{"type":"integer","description":"","example":0},"width":{"type":"integer","description":"","example":0},"height":{"type":"integer","description":"","example":0},"unit":{"type":"string","enum":["cm","in"],"description":"The unit of measurement for the size of the return.","example":"in"},"weight":{"type":"number","description":"","example":0.0},"weight_unit":{"type":"string","enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the return.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"Dimensions"},"CreatewmsReturn--ShipHero--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"return_reason":{"type":"string","description":"Reason for return.","example":"return_reason"},"order_id":{"type":"string","description":"Order associated with this return.","example":"order_id"},"label_type":{"type":"string","enum":["FREE","PAID","SELF_RETURN","FLAT_RATE"],"description":"Return label type.","example":"FLAT_RATE"},"shipping_method":{"type":"string","description":"The shipping_method used to return the item.","example":"shipping_method"},"carrier_id":{"type":"string","description":"The carrier used to return the item.","example":"carrier_id"},"label_cost":{"type":"number","description":"Cost of the return label.","example":0.0},"ship_from_address":{"$ref":"#/components/schemas/FromAddressShiphero"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"return_reason"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshiphero"}},"measurements":{"$ref":"#/components/schemas/Dimensions"},"tracking_number":{"type":"string","description":"","example":"tracking_number"}},"required":["carrier_id","label_cost","label_type","line_items","measurements","order_id","return_reason","ship_from_address","shipping_method","warehouse_id"],"additionalProperties":false,"title":"ShipHero"},"WmsReturnWriteLineItemshipmonk":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"desired_action":{"type":"string","enum":["received_back_into_inventory","damaged_not_resellable"],"description":"Desired action for the returned item.","example":"damaged_not_resellable"}},"required":["desired_action","expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipmonk"},"CreatewmsReturn--ShipMonk--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"return_reason":{"type":"string","enum":["reason_exchange","reason_changed_mind","reason_undeliverable","reason_unknown","reason_incorrect_product"],"description":"Reason for the return.","example":"reason_changed_mind"},"tracking_number":{"type":"string","description":"The tracking number for the return.","example":"123456789"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"desired_action":"damaged_not_resellable"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipmonk"}}},"required":["line_items","order_id","return_reason","warehouse_id"],"additionalProperties":false,"title":"ShipMonk"},"WmsReturnWriteLineItemshippingbo":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshippingbo"},"CreatewmsReturn--Shippingbo--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshippingbo"}}},"required":["line_items","order_id"],"additionalProperties":false,"title":"Shippingbo"},"WmsReturnWriteLineItemshipstream":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipstream"},"CreatewmsReturn--ShipStream--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipstream"}},"carrier_id":{"type":"string","description":"Carrier ID. Will take precedence over carrier_name if passed.","example":"carrier_id"},"carrier_name":{"type":"string","description":"Carrier name.","example":"carrier_name"},"carrier_tracking_number":{"type":"string","description":"Carrier tracking number","example":"carrier_tracking_number"},"customer_name":{"type":"string","description":"Customer name","example":"customer_name"},"merchant_order_number":{"type":"string","description":"Merchant order number","example":"merchant_order_number"},"tracking_numbers":{"type":"array","description":"List of tracking numbers","items":{"type":"string","description":"","example":"tracking_numbers"}},"merchant_rma_number":{"type":"integer","description":"Merchant RMA number","example":0},"expected_arrival_date":{"type":"string","format":"date","description":"Expected arrival date","example":"2023-03-15"},"notes":{"type":"string","description":"Notes","example":"notes"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"ShipStream"},"WmsReturnWriteLineItemshipwire":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipwire"},"CreatewmsReturn--Shipwire--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipwire"}}},"required":["line_items","order_id","warehouse_id"],"additionalProperties":false,"title":"Shipwire"},"WmsReturnWriteLineItemsmart-warehousing":{"type":"object","properties":{"sku":{"type":"string","description":"sku","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemsmart-warehousing"},"CreatewmsReturn--Smart__Warehousing--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"Customer defined reference associated with the receipt.","example":"reference_id"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemsmart-warehousing"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["expected_arrival_date","line_items","reference_id"],"additionalProperties":false,"title":"Smart Warehousing"},"WmsReturnWriteLineItem":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","description":"","example":"return_reason"}},"required":["quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItem"},"ShipFromAddressStord":{"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","address2","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressStord"},"CreatewmsReturn--Stord--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","quantity":0,"return_reason":"return_reason"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItem"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressStord"},"external_tracking_number":{"type":"string","description":"Tracking number from an externally-generated return label. Requires carrier_name and warehouse_id.","example":"1Z999AA10123456784"},"carrier_name":{"type":"string","description":"Carrier for an externally-generated return label. Required when external_tracking_number is set.","example":"UPS"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"external_return_id":{"type":"string","description":"External identifier for the return; must be unique within the network.","example":"external-return-123"}},"required":["line_items","order_id","ship_from_address"],"additionalProperties":false,"title":"Stord"},"WmsReturnWriteLineItemwhiplash":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"return_reason":{"type":"string","enum":["Did not fit","Defective","Ordered wrong item","Wrong item sent","Unexpected/Additional Item","Item not as expected","Unclaimed/Undeliverable","Other"],"description":"","example":"Defective"},"return_action":{"type":"string","enum":["requires_attention","exchange","refund","credit","unknown","no_action_required"],"description":"","example":"credit"}},"required":["expected_quantity","return_action","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemwhiplash"},"CreatewmsReturn--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"requires_label":{"type":"boolean","description":"Whether or not a label is required.","example":true},"carrier_id":{"type":"string","default":"Whiplash","description":"The carrier for the return. Defaults to 'Whiplash'.","example":"Whiplash"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"Defective","return_action":"credit"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemwhiplash"}},"tracking_number":{"type":"string","description":"","example":"tracking_number"},"notes":{"type":"array","description":"List of notes associated with the return.","example":["note_1","note_2"],"items":{"type":"string","description":"A note associated with the return.","example":"note"}},"reference":{"type":"string","description":"Purchase order number or other human readable token to another system","example":"reference"},"sender":{"type":"string","description":"The customer's name","example":"sender"}},"required":["requires_label"],"additionalProperties":false,"title":"Whiplash (Ryder)"},"CreatewmsReturnInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreatewmsReturn--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreatewmsReturn--Bergen--"},{"$ref":"#/components/schemas/CreatewmsReturn--Bleckmann--"},{"$ref":"#/components/schemas/CreatewmsReturn--BlueBox__-_IDrive__Fulfillment_---"},{"$ref":"#/components/schemas/CreatewmsReturn--Boxzooka--"},{"$ref":"#/components/schemas/CreatewmsReturn--Cirro--"},{"$ref":"#/components/schemas/CreatewmsReturn--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/CreatewmsReturn--DCL--"},{"$ref":"#/components/schemas/CreatewmsReturn--Deposco--"},{"$ref":"#/components/schemas/CreatewmsReturn--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/CreatewmsReturn--Flexport__-_Deliverr_---"},{"$ref":"#/components/schemas/CreatewmsReturn--Fulfil--"},{"$ref":"#/components/schemas/CreatewmsReturn--I-Fulfilment--"},{"$ref":"#/components/schemas/CreatewmsReturn--Infoplus--"},{"$ref":"#/components/schemas/CreatewmsReturn--Cart.com__-_Jazz__Central_---"},{"$ref":"#/components/schemas/CreatewmsReturn--Linnworks--"},{"$ref":"#/components/schemas/CreatewmsReturn--Logiwa--"},{"$ref":"#/components/schemas/CreatewmsReturn--Logiwa__IO--"},{"$ref":"#/components/schemas/CreatewmsReturn--Luminous--"},{"$ref":"#/components/schemas/CreatewmsReturn--MasonHub--"},{"$ref":"#/components/schemas/CreatewmsReturn--Mintsoft--"},{"$ref":"#/components/schemas/CreatewmsReturn--Moda__Express--"},{"$ref":"#/components/schemas/CreatewmsReturn--Nimble--"},{"$ref":"#/components/schemas/CreatewmsReturn--NRI--"},{"$ref":"#/components/schemas/CreatewmsReturn--OIA__Global--"},{"$ref":"#/components/schemas/CreatewmsReturn--Ongoing__WMS--"},{"$ref":"#/components/schemas/CreatewmsReturn--Quiet__Platforms--"},{"$ref":"#/components/schemas/CreatewmsReturn--Return__Helper--"},{"$ref":"#/components/schemas/CreatewmsReturn--ShipBob--"},{"$ref":"#/components/schemas/CreatewmsReturn--Shipedge--"},{"$ref":"#/components/schemas/CreatewmsReturn--Shipfusion--"},{"$ref":"#/components/schemas/CreatewmsReturn--ShipHero--"},{"$ref":"#/components/schemas/CreatewmsReturn--ShipMonk--"},{"$ref":"#/components/schemas/CreatewmsReturn--Shippingbo--"},{"$ref":"#/components/schemas/CreatewmsReturn--ShipStream--"},{"$ref":"#/components/schemas/CreatewmsReturn--Shipwire--"},{"$ref":"#/components/schemas/CreatewmsReturn--Smart__Warehousing--"},{"$ref":"#/components/schemas/CreatewmsReturn--Stord--"},{"$ref":"#/components/schemas/CreatewmsReturn--Whiplash__-_Ryder_---"}],"title":"CreatewmsReturnInputSchema"},"WmsBillIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsBillIdsQueryParam"},"WmsBillCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsBillCreated_DateQueryParam"},"WmsBillUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsBillUpdated_DateQueryParam"},"WmsBillTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsBillTrackstar_Created_DateQueryParam"},"WmsBillTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsBillTrackstar_Updated_DateQueryParam"},"WmsBillWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsBillWarehouse_Customer_IdQueryParam"},"WmsBillApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the bill.","example":"bill_id_1"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the bill. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the bill was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the bill was last updated.","example":"2022-01-02T05:05:05Z"},"object_id":{"type":["string","null"],"description":"The ID of the object that incurred a charge.","example":"object_id"},"object_type":{"type":["string","null"],"description":"The type of object that incurred a charge.","example":"order"},"charge_type":{"type":"string","description":"The reason for the charge.","example":"shipping"},"amount":{"type":"number","description":"The amount charged.","example":10.5},"currency_code":{"type":"string","description":"The currency of the charge. Defaults to USD.","example":"USD"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","amount","charge_type","created_date","currency_code","id","object_id","object_type","trackstar_created_date","trackstar_updated_date","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsBillApiItemSchema"},"WmsBillsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsBillApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsBillsListEndpoint"},"CartOrderIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"CartOrderIdsQueryParam"},"CartOrderCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartOrderCreated_DateQueryParam"},"CartOrderUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartOrderUpdated_DateQueryParam"},"CartOrderTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartOrderTrackstar_Created_DateQueryParam"},"CartOrderTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartOrderTrackstar_Updated_DateQueryParam"},"CartOrderTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"CartOrderTrackstar_Tags_FlatQueryParam"},"CartOrderStatusQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["open","confirmed","processing","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"open"},"neq":{"type":"string","enum":["open","confirmed","processing","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"backordered"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","confirmed","processing","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"backordered"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","confirmed","processing","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"","example":"backordered"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"CartOrderStatusQueryParam"},"CartOrderOrder_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"order_num"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"CartOrderOrder_NumberQueryParam"},"CartOrderTagsQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"CartOrderTagsQueryParam"},"CartOrderSkusQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"sku_1,sku_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"CartOrderSkusQueryParam"},"CartOrderWarehouse_IdsQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"warehouse_id_1,warehouse_id_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"CartOrderWarehouse_IdsQueryParam"},"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.","example":"product_id"},"product_sku":{"type":["string","null"],"description":"","example":"product_sku"},"parent_product_id":{"type":["string","null"],"description":"The ID of the product's parent.","example":"parent_product_id"},"parent_product_sku":{"type":["string","null"],"description":"","example":"parent_product_sku"},"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"},"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.","example":"product_id"},"product_sku":{"type":["string","null"],"description":"","example":"product_sku"},"parent_product_id":{"type":["string","null"],"description":"The ID of the product's parent.","example":"parent_product_id"},"quantity":{"type":"integer","description":"","example":0}},"required":["line_item_id","parent_product_id","product_id","product_sku","quantity"],"additionalProperties":false,"title":"CartOrderShipmentGroupLineItem"},"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"},"CartOrderShipmentLineItem":{"type":"object","properties":{"shipment_line_item_id":{"type":"string","description":"The ID of the line item in the shipment.","example":"shipment_line_item_id"},"product_id":{"type":"string","description":"The ID of the product.","example":"product_id"},"product_sku":{"type":["string","null"],"description":"","example":"product_sku"},"parent_product_id":{"type":["string","null"],"description":"The ID of the product's parent.","example":"parent_product_id"},"parent_product_sku":{"type":["string","null"],"description":"","example":"parent_product_sku"},"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"},"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.","example":"tracking_number"},"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.","example":"shipping_groups"}},"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"},"CartOrderApiItemSchema":{"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":"open"},"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":"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"}],"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"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":"CartOrderApiItemSchema"},"CartOrdersListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/CartOrderApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"CartOrdersListEndpoint"},"ErpVendorIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpVendorIdsQueryParam"},"ErpVendorCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpVendorCreated_DateQueryParam"},"ErpVendorUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpVendorUpdated_DateQueryParam"},"ErpVendorTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpVendorTrackstar_Created_DateQueryParam"},"ErpVendorTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpVendorTrackstar_Updated_DateQueryParam"},"ErpVendorTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpVendorTrackstar_Tags_FlatQueryParam"},"ErpVendorVendor_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"V0001"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpVendorVendor_NumberQueryParam"},"ErpVendorNameQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"Acme Supply Co."},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpVendorNameQueryParam"},"ErpVendorEmailQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"ap@acme-supply.com"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpVendorEmailQueryParam"},"ErpVendorCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpVendorCustomFieldEntry"},"ErpVendorApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the vendor in the ERP.","example":"vend_1"},"created_date":{"type":"string","format":"date-time","description":"The date the vendor was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the vendor was last updated.","example":"2022-01-02T05:05:05Z"},"vendor_number":{"type":["string","null"],"description":"The user-facing identifier of the vendor as assigned by the ERP.","example":"V0001"},"name":{"type":"string","description":"Display name of the vendor (company name for businesses, full name for individuals).","example":"Acme Supply Co."},"email":{"type":["string","null"],"description":"Primary email address recorded on the vendor.","example":"ap@acme-supply.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the vendor.","example":"415-555-0193"},"is_individual":{"type":["boolean","null"],"description":"Whether the vendor is a person rather than a company.","example":false},"active":{"type":["boolean","null"],"description":"Whether the vendor is active in the ERP.","example":true},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the vendor. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpVendorCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the vendor in the external system (WMS/Freight etc).","example":"https://example.com/vendor/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","created_date","custom_fields","email","external_system_url","id","is_individual","name","phone","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","vendor_number"],"additionalProperties":false,"title":"ErpVendorApiItemSchema"},"ErpVendorsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpVendorApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpVendorsListEndpoint"},"WmsProductIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsProductIdsQueryParam"},"WmsProductCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsProductCreated_DateQueryParam"},"WmsProductUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsProductUpdated_DateQueryParam"},"WmsProductTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsProductTrackstar_Created_DateQueryParam"},"WmsProductTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsProductTrackstar_Updated_DateQueryParam"},"WmsProductTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"WmsProductTrackstar_Tags_FlatQueryParam"},"WmsProductWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsProductWarehouse_Customer_IdQueryParam"},"WmsProductSkuQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"sku"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"},"is_null":{"type":"boolean","description":"Filter by whether the field is null.","example":true}},"additionalProperties":false,"title":"WmsProductSkuQueryParam"},"WmsProductApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":["number","null"],"description":"The price of the product.","example":10.99},"inventory_items":{"type":"array","description":"A list of inventory items associated with the product.","example":[{"inventory_item_id":"id1","sku":"sku1","unit_quantity":1},{"inventory_item_id":"id2","sku":"sku2","unit_quantity":1}],"items":{"$ref":"#/components/schemas/ProductInventoryItems"}},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/ProductSupplier"},{"type":"null"}]},"country_of_origin":{"type":["string","null"],"description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":["string","null"],"description":"The harmonized HS code of the product.","example":"123456"},"supplier_products":{"type":"array","description":"A list of supplier products associated with the product.","example":[{"supplier_id":"id1","supplier_name":"name1","external_id":"ext_id1","unit_cost":1.0},{"supplier_id":"id2","supplier_name":"name2","external_id":"ext_id2","unit_cost":2.5}],"items":{"$ref":"#/components/schemas/ProductSupplierProducts"}},"categories":{"type":"array","description":"A list of category names associated with the product.","example":["Electronics","Accessories"],"items":{"type":"string","description":"","example":"categories"}},"image_urls":{"type":"array","description":"A list of image URLs associated with the product.","example":["https://example.com/image1.jpg"],"items":{"type":"string","description":"","example":"image_urls"}},"external_system_url":{"type":["string","null"],"description":"URL link to the product in the external system (WMS/Freight etc).","example":"https://example.com/product/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","categories","country_of_origin","created_date","external_system_url","gtin","harmonized_code","id","image_urls","inventory_items","is_kit","name","sku","supplier_object","supplier_products","trackstar_created_date","trackstar_tags","trackstar_updated_date","unit_price","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsProductApiItemSchema"},"WmsProductsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsProductApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsProductsListEndpoint"},"wmsCreateProductResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsProductApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateProductResponse"},"ProductMeasurements":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurements"},"CreatewmsProduct--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"XS-RED-SHIRT"},"name":{"type":"string","description":"name","example":"XS Red Shirt"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"012345678905"},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"}},"required":["name","sku"],"additionalProperties":false,"title":"WMS Sandbox"},"ProductMeasurementsbest-inc":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsbest-inc"},"CreatewmsProduct--BEST__Inc.--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsbest-inc"}},"required":["measurements","name","sku"],"additionalProperties":false,"title":"BEST Inc."},"ProductMeasurementsbluebox":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsbluebox"},"CreatewmsProduct--BlueBox__-_IDrive__Fulfillment_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsbluebox"},"price":{"type":"number","description":"Price of the product","example":0.0}},"required":["gtin","name","sku"],"additionalProperties":false,"title":"BlueBox (IDrive Fulfillment)"},"ProductMeasurementsboxzooka":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsboxzooka"},"CreatewmsProduct--Boxzooka--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsboxzooka"},{"type":"null"}]},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"}},"required":["name","sku"],"additionalProperties":false,"title":"Boxzooka"},"CreatewmsProduct--CartonCloud--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"type":{"type":"string","description":"Product type defined per tenant (e.g. 'FROZEN', 'DRY GOODS')","example":"type"},"barcode":{"type":"string","description":"Product barcode","example":"barcode"},"description":{"type":"string","description":"Full product description","example":"description"},"length":{"type":"number","description":"Product length","example":0.0},"width":{"type":"number","description":"Product width","example":0.0},"height":{"type":"number","description":"Product height","example":0.0},"country_of_origin":{"type":"string","description":"Country of origin","example":"country_of_origin"}},"required":["name","sku","type"],"additionalProperties":false,"title":"CartonCloud"},"CreatewmsProduct--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"customs_description":{"type":"string","description":"Customs description matching the harmonized code.","example":"Perfumes and toilet waters"},"cost":{"type":"number","description":"The production cost price of the product.","example":30.5}},"required":["cost","country_of_origin","customs_description","harmonized_code","name","sku","unit_price"],"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"ProductMeasurementsdear-systems":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsdear-systems"},"CreatewmsProduct--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsdear-systems"},{"type":"null"}]},"costing_method":{"type":"string","enum":["FIFO","Special - Batch","Special - Serial Number","FIFO - Serial Number","FIFO - Batch","FEFO - Batch","FEFO - Serial Number"],"description":"Costing method for the product.","example":"FEFO - Batch"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"required":["costing_method","gtin","name","sku"],"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"ProductMeasurementsdeposco":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsdeposco"},"CreatewmsProduct--Deposco--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsdeposco"},{"type":"null"}]},"active":{"type":"boolean","default":true,"description":"Whether the product is active, defaults to True.","example":true}},"required":["name","sku"],"additionalProperties":false,"title":"Deposco"},"CreatewmsProduct--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"}},"required":["name","sku"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"ProductMeasurementsflexport":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsflexport"},"CreatewmsProduct--Flexport__-_Deliverr_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","maxLength":255,"description":"name","example":"name"},"sku":{"type":"string","maxLength":255,"description":"sku","example":"sku"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsflexport"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","pattern":"^[0-9]{10}$","description":"The harmonized HS code of the product.","example":"0101210000"},"customs_value":{"type":"number","description":"The customs value of the product in USD. Required when providing customs information.","example":0.0},"customs_description":{"type":"string","maxLength":255,"description":"The customs description of the product. Required when providing customs information.","example":"customs_description"}},"required":["name","sku"],"additionalProperties":false,"title":"Flexport (Deliverr)"},"ProductMeasurementsi-fulfilment":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsi-fulfilment"},"CreatewmsProduct--I-Fulfilment--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","pattern":"^\\d{3,20}$","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"012345678905"},"brand_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The brand for the product.","example":"brand_id"},"channel_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The channel for the product.","example":"channel_id"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsi-fulfilment"},"quantity":{"type":"integer","default":1,"description":"DOQ quantity.","example":0},"shippable":{"type":"boolean","default":true,"description":"Whether this DOQ is shippable.","example":true},"perishable":{"type":"boolean","default":false,"description":"Whether the product is perishable.","example":true},"organic":{"type":"boolean","default":false,"description":"Whether the product is organic.","example":true},"dangerous":{"type":"boolean","default":false,"description":"Whether the product is dangerous.","example":true},"dutiable":{"type":"boolean","default":false,"description":"Whether the product is dutiable.","example":true},"hygiene":{"type":"boolean","default":false,"description":"Whether the product is for hygiene.","example":true},"battery":{"type":"boolean","default":false,"description":"Whether the product contains a battery.","example":true},"fragile":{"type":"boolean","default":false,"description":"Whether the product is fragile.","example":true},"what_is_it":{"type":"string","description":"A description of what the product is.","example":"what_is_it"},"made_of":{"type":"string","description":"What the product is made of.","example":"made_of"},"used_for":{"type":"string","description":"What the product is used for.","example":"used_for"},"country_of_origin":{"type":"string","default":"US","description":"The country of origin of the product.","example":"USA"},"customs_code_id":{"type":"integer","description":"The ID of the customs code for the product.","example":0}},"required":["brand_id","channel_id","customs_code_id","gtin","made_of","measurements","name","sku","used_for","what_is_it"],"additionalProperties":false,"title":"I-Fulfilment"},"ProductMeasurementsinfoplus":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsinfoplus"},"CreatewmsProduct--Infoplus--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"warehouse_customer_id":{"type":"string","description":"ID of the warehouse customer that owns this product","example":"warehouse_customer_id"},"name":{"type":"string","description":"name","example":"name"},"status":{"type":"string","enum":["Active","Deplete","Blocked","Placeholder","Outside Vendor","Print on Demand"],"description":"Status of the product","example":"Active"},"lot_mixing_rule":{"type":"string","default":"SKU","enum":["Item Receipt","Inventory Properties","SKU"],"description":"Controls how an item can be mixed in a lot. (e.g. items in a location all have to have come from the same production lot,\n items in a location have to have the same SKU but can have different inventory properties).","example":"SKU"},"item_mixing_rule":{"type":"string","default":"Single","enum":["Single","Multi"],"description":"Controls if items can be mixed with other items in a location.","example":"Single"},"allocation_rule":{"type":"string","default":"Strict","enum":["Strict","Weak","Labor Optimized"],"description":"Rule for allocating inventory to orders. Strict and Weak require a lot mixing rule of Item Receipt","example":"Strict"},"backorder":{"type":"boolean","default":false,"description":"Backorders created for this item when it is out of stock","example":true},"major_group_id":{"type":"integer","description":"ID of the major group this item belongs to. Must exist in Infoplus","example":0},"subgroup_id":{"type":"integer","description":"ID of the subgroup this item belongs to. Must exist in Infoplus","example":0},"hazmat":{"type":"boolean","default":false,"description":"Whether this item is hazardous","example":true},"secure":{"type":"boolean","default":false,"description":"Control if item must be stored in a secure warehouse","example":true},"seasonal_item":{"type":"boolean","default":false,"description":"Whether this item expereinces significant differences in usage based on time of year","example":true},"receiving_criteria_scheme_id":{"type":"integer","description":"ID of the receiving criteria scheme this item belongs to. Must exist in Infoplus","example":0},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsinfoplus"},"price":{"type":"number","description":"Price of the product","example":0.0}},"required":["major_group_id","name","receiving_criteria_scheme_id","sku","status","subgroup_id","warehouse_customer_id"],"additionalProperties":false,"title":"Infoplus"},"CreatewmsProduct--Cart.com__-_Jazz__Central_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"price":{"type":"number","description":"The price of the product.","example":1.0}},"required":["gtin","price","sku"],"additionalProperties":false,"title":"Cart.com (Jazz Central)"},"ExtendedPropertySchema":{"type":"object","properties":{"name":{"type":"string","description":"Property name","example":"name"},"value":{"type":"string","description":"Property value","example":"value"},"type":{"type":"string","enum":["Attribute","Channel","Compatibility","Condition","Fulfilment SKU","Other","Shipping","StockItem Label"],"description":"Property type","example":"Attribute"}},"required":["name","type","value"],"additionalProperties":false,"title":"ExtendedPropertySchema"},"ProductMeasurementslinnworks":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementslinnworks"},"CreatewmsProduct--Linnworks--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"extended_properties":{"type":"array","description":"Custom properties to attach to the product","example":[{"name":"Color","value":"Red","type":"Attribute"}],"items":{"$ref":"#/components/schemas/ExtendedPropertySchema"}},"measurements":{"$ref":"#/components/schemas/ProductMeasurementslinnworks"}},"required":["name","sku"],"additionalProperties":false,"title":"Linnworks"},"ProductMeasurementslogicpod":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementslogicpod"},"CreatewmsProduct--Quickbox__-_LogicPod_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementslogicpod"},{"type":"null"}]}},"required":["name","sku"],"additionalProperties":false,"title":"Quickbox (LogicPod)"},"CreatewmsProduct--Logiwa__IO--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"description":{"type":"string","description":"","example":"description"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"required":["description","name","sku","warehouse_customer_id"],"additionalProperties":false,"title":"Logiwa IO"},"ProductMeasurementsluminous":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsluminous"},"CreatewmsProduct--Luminous--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsluminous"},"category_id":{"type":"integer","minimum":1,"description":"The ID of the Luminous category the product belongs to.","example":1}},"required":["category_id","name","sku"],"additionalProperties":false,"title":"Luminous"},"CreatewmsProduct--MasonHub--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsmasonhub"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"description":{"type":"string","description":"Description of the product.","example":"description"},"customer_bar_code":{"type":"string","description":"Customer provided bar code for this sku.","example":"customer_bar_code"},"brand_name":{"type":"string","description":"Brand name for this sku and product.","example":"brand_name"},"category":{"type":"string","description":"Product category for this sku.","example":"category"},"sub_category":{"type":"string","description":"Product sub category for this sku.","example":"sub_category"},"vendor_brand_code":{"type":"string","description":"Vendor provided brand code for identifying this sku.","example":"vendor_brand_code"},"customer_brand_code":{"type":"string","description":"Customer provided brand code for identifying this sku. Used on packing lists.","example":"customer_brand_code"},"vendor_style":{"type":"string","description":"Vendor style code for item identification.","example":"vendor_style"}},"required":["brand_name","category","customer_bar_code","customer_brand_code","description","measurements","name","sku","sub_category","vendor_brand_code","vendor_style"],"additionalProperties":false,"title":"MasonHub"},"CreatewmsProduct--Moda__Express--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","maxLength":128,"description":"sku","example":"sku"},"name":{"type":"string","maxLength":128,"description":"name","example":"name"},"gtin":{"type":"string","maxLength":512,"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"unit_price":{"type":"number","minimum":0.0,"description":"The price of the product.","example":10.99}},"required":["gtin","measurements","name","sku"],"additionalProperties":false,"title":"Moda Express"},"ProductMeasurementsnextsmartship":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsnextsmartship"},"NextsmartshipProductDeclaredValue":{"type":"object","properties":{"country":{"type":"string","description":"Destination country code, or OTHER for the rest-of-world value.","example":"US"},"amount":{"type":"number","description":"Declared customs value.","example":8.0},"currency":{"type":"string","enum":["USD"],"description":"ISO 4217 currency code.","example":"USD"}},"required":["amount","country","currency"],"additionalProperties":false,"title":"NextsmartshipProductDeclaredValue"},"NextsmartshipProductCustoms":{"type":"object","properties":{"name_en":{"type":"string","description":"English product name for the customs declaration.","example":"Cotton T-Shirt"},"name_zh":{"type":"string","description":"Chinese product name for the customs declaration.","example":"\u68c9\u8d28T\u6064"},"purpose":{"type":"string","description":"The product's end use, for customs.","example":"Apparel"},"material":{"type":"string","description":"The product's primary material, for customs.","example":"Cotton"},"declared_values":{"type":"array","description":"Declared customs value of the product, one entry per destination country plus an OTHER catch-all.","example":[{"country":"US","amount":8,"currency":"USD"}],"items":{"$ref":"#/components/schemas/NextsmartshipProductDeclaredValue"}}},"required":["declared_values","name_en","name_zh"],"additionalProperties":false,"title":"NextsmartshipProductCustoms"},"CreatewmsProduct--NextSmartShip--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsnextsmartship"},{"type":"null"}]},"attribute":{"type":"string","enum":["GENERAL_CARGO","BATTERY_INCLUDED","BATTERY_ONLY","MAGNETIC","SPECIAL"],"description":"NextSmartShip cargo classification, used for shipping and customs compliance.","example":"GENERAL_CARGO"},"packaging":{"type":"string","enum":["pre-packaged","sales-packaged","bare-packaged"],"description":"Physical packaging state the product arrives at the warehouse in.","example":"pre-packaged"},"customs":{"$ref":"#/components/schemas/NextsmartshipProductCustoms"},"sales_url":{"type":"string","description":"Public storefront URL for the product.","example":"https://shop.example.com/products/abc-001"},"images":{"type":"array","description":"Product image URLs.","example":["https://cdn.example.com/abc-001.jpg"],"items":{"type":"string","description":"","example":"images"}}},"required":["attribute","customs","harmonized_code","name","packaging","sku"],"additionalProperties":false,"title":"NextSmartShip"},"NimbleProductMeasurements":{"type":"object","properties":{"length":{"type":"number","description":"Length of the product.","example":1},"width":{"type":"number","description":"Width of the product.","example":1},"height":{"type":"number","description":"Height of the product.","example":1},"weight":{"type":"number","description":"Weight of the product.","example":1},"unit":{"type":"string","enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight_unit":{"type":"string","enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["unit","weight_unit"],"additionalProperties":false,"title":"NimbleProductMeasurements"},"CreatewmsProduct--Nimble--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"Required.","example":"123456789"},"vendor_sku":{"type":"string","description":"An external vendor SKU","example":"123456789"},"description":{"type":"string","description":"Description of the product","example":"Description"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/NimbleProductMeasurements"}},"required":["description","gtin","measurements"],"additionalProperties":false,"title":"Nimble"},"CreatewmsProduct--NPFulfilment--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","maxLength":30,"description":"sku","example":"sku"},"name":{"type":"string","maxLength":100,"description":"name","example":"name"},"gtin":{"type":"string","maxLength":50,"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"},"country_of_origin":{"type":"string","maxLength":50,"description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","maxLength":50,"description":"The harmonized HS code of the product.","example":"123456"},"unit_price":{"type":"number","minimum":0.0,"description":"The price of the product.","example":10.99}},"required":["gtin","measurements","name","sku"],"additionalProperties":false,"title":"NPFulfilment"},"CreatewmsProduct--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"required":["gtin","name","sku"],"additionalProperties":false,"title":"Ongoing WMS"},"ProductMeasurementsportless":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsportless"},"CreatewmsProduct--Portless--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsportless"}},"required":["name","sku"],"additionalProperties":false,"title":"Portless"},"ProductMeasurementsshipbob":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsshipbob"},"CreatewmsProduct--ShipBob--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshipbob"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"barcodes":{"type":"array","description":"Barcodes to scan the product by","example":["012345678905"],"items":{"type":"string","description":"Barcode","example":"012345678905"}},"is_lot":{"type":"boolean","description":"Whether shipbob tracks the product by lot","example":true},"minimum_shelf_life_days":{"type":"integer","minimum":0,"description":"Days of shelf life a lot must have left for shipbob to ship it. Shipbob only accepts this when is_lot is true.","example":30},"packaging_requirement":{"type":"string","description":"How the product must be packed. Any shipbob packaging requirement name, e.g. 'No Requirements', 'Fragile', 'Foldable', 'Media', 'Book', 'Poster', 'Apparel', 'Packaging Material', 'Ships In Own Container'.","example":"Foldable"},"packaging_material":{"type":"string","description":"What the product is packed in. Any shipbob packaging material name, e.g. 'Box', 'Bubble Mailer', 'Poly Mailer', 'Poster Tube', 'Custom Box', 'Bookfold', 'Ship In Own Container', 'Custom Bubble Mailer', 'Custom Poly Mailer'. Shipbob only allows certain materials with each requirement.","example":"Custom Poly Mailer"},"return_preference_primary_action":{"type":"string","enum":["Restock","Quarantine","Dispose"],"description":"What shipbob should do with the product when it is returned. Shipbob rejects Restock on a lot product.","example":"Restock"},"return_preference_backup_action":{"type":"string","enum":["Restock","Quarantine","Dispose"],"description":"What shipbob should do with the returned product when the primary action is not possible. Shipbob only accepts a backup action when the primary one is Restock.","example":"Dispose"},"return_to_sender_primary_action":{"type":"string","enum":["Restock","Quarantine","Dispose"],"description":"What shipbob should do with the product when a shipment is returned to sender. Shipbob rejects Restock on a lot product.","example":"Restock"},"return_to_sender_backup_action":{"type":"string","enum":["Restock","Quarantine","Dispose"],"description":"What shipbob should do with a product returned to sender when the primary action is not possible. Shipbob only accepts a backup action when the primary one is Restock.","example":"Quarantine"}},"required":["name","sku"],"additionalProperties":false,"title":"ShipBob"},"SupplierName":{"type":"object","properties":{"supplier_name":{"type":"string","description":"The name of the supplier.","example":"supplier_name"}},"required":["supplier_name"],"additionalProperties":false,"title":"SupplierName"},"SupplierSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/SupplierId"},{"$ref":"#/components/schemas/SupplierName"}],"discriminator":{"propertyName":"type","mapping":{"id":"#/components/schemas/SupplierId","name":"#/components/schemas/SupplierName"}},"title":"SupplierSchema"},"CreatewmsProduct--Shipedge--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"supplier_object":{"description":"The supplier of the product.","$ref":"#/components/schemas/SupplierSchema"}},"required":["measurements","name","sku","unit_price"],"additionalProperties":false,"title":"Shipedge"},"ProductMeasurementsshipfusion":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsshipfusion"},"CreatewmsProduct--Shipfusion--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsshipfusion"},{"type":"null"}]},"price":{"type":"number","description":"The retail price of the product","example":0.0}},"required":["name","sku"],"additionalProperties":false,"title":"Shipfusion"},"ProductMeasurementsshiphero":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsshiphero"},"CreatewmsProduct--ShipHero--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"warehouse_id":{"type":"string","description":"Warehouse ID where the product is stored. ShipHero creates a WarehouseProduct here alongside the new general Product. Use warehouse_ids to seed several warehouses in one call.","example":"warehouse_id"},"warehouse_ids":{"type":"array","description":"Warehouse IDs to seed the product into (one WarehouseProduct each, 0 on hand). Use instead of warehouse_id to create the product in multiple warehouses in a single call.","example":["warehouse_id_1","warehouse_id_2"],"items":{"type":"string","description":"","example":"warehouse_ids"}},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshiphero"}},"required":["name","sku"],"additionalProperties":false,"title":"ShipHero"},"ProductMeasurementsshipmonk":{"type":"object","properties":{"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["weight","weight_unit"],"additionalProperties":false,"title":"ProductMeasurementsshipmonk"},"CreatewmsProduct--ShipMonk--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"required_packaging":{"type":"string","enum":["poly_mailer","bubble_mailer","box","slap_a_label","custom"],"description":"Required level of packaging for the product.","example":"box"},"fragile":{"type":"boolean","description":"","example":true},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshipmonk"},"replacement_cost":{"type":"number","description":"","example":0.0},"customs_declaration_value":{"type":"number","description":"","example":0.0},"country_of_origin":{"type":"string","description":"ISO 3166-1 alpha-2 country code. i.e. US","example":"country_of_origin"}},"required":["country_of_origin","customs_declaration_value","fragile","gtin","measurements","name","replacement_cost","required_packaging","sku"],"additionalProperties":false,"title":"ShipMonk"},"ProductMeasurementsshipstream":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsshipstream"},"CreatewmsProduct--ShipStream--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshipstream"}},"required":["measurements","name","sku"],"additionalProperties":false,"title":"ShipStream"},"CreatewmsProduct--Shipwire--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","minLength":1,"maxLength":26,"description":"sku","example":"sku"},"category":{"type":"string","default":"OTHER","enum":["OTHER","APPAREL","TOYS_SPORTS_HOBBIES"],"description":"The product category","example":"OTHER"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","minLength":12,"maxLength":12,"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"012345678905"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshipwire"},"cost_value":{"type":"number","description":"The cost of the product","example":0.0},"retail_value":{"type":"number","description":"The retail value of the product","example":0.0},"battery_configuration":{"type":"string","default":"NOBATTERY","enum":["NOBATTERY","ISBATTERY","HASBATTERY","HASLOOSEBATTERY"],"description":"The battery configuration of the product","example":"NOBATTERY"}},"required":["cost_value","measurements","name","retail_value","sku"],"additionalProperties":false,"title":"Shipwire"},"ProductMeasurementsskusavvy":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsskusavvy"},"CreatewmsProduct--SKUSavvy--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsskusavvy"},"price":{"type":"number","description":"Price of the product","example":0.0},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"required":["gtin","measurements","name","price","sku"],"additionalProperties":false,"title":"SKUSavvy"},"ProductMeasurementsskuvault":{"type":"object","properties":{"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["weight","weight_unit"],"additionalProperties":false,"title":"ProductMeasurementsskuvault"},"CreatewmsProduct--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"classification":{"type":"string","description":"Classification of the product. Defaults to 'General'","example":"classification"},"supplier_object":{"description":"The supplier of the product.","$ref":"#/components/schemas/SupplierSchema"},"brand":{"type":"string","description":"Brand name. Defaults to 'Generic'","example":"brand"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsskuvault"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"}},"required":["measurements","sku"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"CreatewmsProduct--Star__WMS--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"declared_name_cn":{"type":"string","description":"Customs declared name of the product, in Chinese.","example":"\u6d4b\u8bd5\u4ea7\u54c1"},"declared_name_en":{"type":"string","description":"Customs declared name of the product, in English.","example":"Test Product"},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"},"dangerous_cargo":{"type":"integer","minimum":1,"maximum":8,"description":"Hazmat classification of the product. 1 = normal/non-hazardous.","example":1}},"required":["country_of_origin","dangerous_cargo","declared_name_cn","declared_name_en","gtin","harmonized_code","measurements","name","sku","unit_price"],"additionalProperties":false,"title":"Star WMS"},"ProductMeasurementstlogistics":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementstlogistics"},"CreatewmsProduct--TLogistics--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","maxLength":50,"description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementstlogistics"},{"type":"null"}]},"batch_required":{"type":"boolean","enum":[true],"description":"Whether tlogistics registers a batch code for the product when it is received. Only true is accepted.","example":true},"expiry_required":{"type":"boolean","description":"Whether tlogistics registers an expiry date for the product when it is received","example":true}},"required":["name","sku"],"additionalProperties":false,"title":"TLogistics"},"ProductMeasurementsunleashed":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the product.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the product.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ProductMeasurementsunleashed"},"CreatewmsProduct--Unleashed--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsunleashed"}},"required":["name","sku"],"additionalProperties":false,"title":"Unleashed"},"CreatewmsProduct--VeraCore--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"client_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The owner of the product.","example":"client_id"},"product_type":{"type":"string","default":"Regular","enum":["Regular","Regular Valuable","Bulky Valuable","Requires Safe","Refrigerated","Food","Pharmaceutical","Ink","Hazardous Material","Fragile","Frozen","OTC Medications","Clean","Medical","Special Handling"],"description":"","example":"Regular"}},"required":["client_id","name","sku"],"additionalProperties":false,"title":"VeraCore"},"CreatewmsProduct--Warehance--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"weight":{"type":"number","description":"Weight in ounces (oz).","example":8.0},"length":{"type":"number","description":"Length in inches (in).","example":10.0},"width":{"type":"number","description":"Width in inches (in).","example":5.0},"height":{"type":"number","description":"Height in inches (in).","example":3.0}},"required":["name","sku","warehouse_customer_id"],"additionalProperties":false,"title":"Warehance"},"CreatewmsProduct--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"required":["gtin","sku"],"additionalProperties":false,"title":"Whiplash (Ryder)"},"CreatewmsProductInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreatewmsProduct--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreatewmsProduct--BEST__Inc.--"},{"$ref":"#/components/schemas/CreatewmsProduct--BlueBox__-_IDrive__Fulfillment_---"},{"$ref":"#/components/schemas/CreatewmsProduct--Boxzooka--"},{"$ref":"#/components/schemas/CreatewmsProduct--CartonCloud--"},{"$ref":"#/components/schemas/CreatewmsProduct--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/CreatewmsProduct--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/CreatewmsProduct--Deposco--"},{"$ref":"#/components/schemas/CreatewmsProduct--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/CreatewmsProduct--Flexport__-_Deliverr_---"},{"$ref":"#/components/schemas/CreatewmsProduct--I-Fulfilment--"},{"$ref":"#/components/schemas/CreatewmsProduct--Infoplus--"},{"$ref":"#/components/schemas/CreatewmsProduct--Cart.com__-_Jazz__Central_---"},{"$ref":"#/components/schemas/CreatewmsProduct--Linnworks--"},{"$ref":"#/components/schemas/CreatewmsProduct--Quickbox__-_LogicPod_---"},{"$ref":"#/components/schemas/CreatewmsProduct--Logiwa__IO--"},{"$ref":"#/components/schemas/CreatewmsProduct--Luminous--"},{"$ref":"#/components/schemas/CreatewmsProduct--MasonHub--"},{"$ref":"#/components/schemas/CreatewmsProduct--Moda__Express--"},{"$ref":"#/components/schemas/CreatewmsProduct--NextSmartShip--"},{"$ref":"#/components/schemas/CreatewmsProduct--Nimble--"},{"$ref":"#/components/schemas/CreatewmsProduct--NPFulfilment--"},{"$ref":"#/components/schemas/CreatewmsProduct--Ongoing__WMS--"},{"$ref":"#/components/schemas/CreatewmsProduct--Portless--"},{"$ref":"#/components/schemas/CreatewmsProduct--ShipBob--"},{"$ref":"#/components/schemas/CreatewmsProduct--Shipedge--"},{"$ref":"#/components/schemas/CreatewmsProduct--Shipfusion--"},{"$ref":"#/components/schemas/CreatewmsProduct--ShipHero--"},{"$ref":"#/components/schemas/CreatewmsProduct--ShipMonk--"},{"$ref":"#/components/schemas/CreatewmsProduct--ShipStream--"},{"$ref":"#/components/schemas/CreatewmsProduct--Shipwire--"},{"$ref":"#/components/schemas/CreatewmsProduct--SKUSavvy--"},{"$ref":"#/components/schemas/CreatewmsProduct--Linnworks__Core__-_SKUVault_---"},{"$ref":"#/components/schemas/CreatewmsProduct--Star__WMS--"},{"$ref":"#/components/schemas/CreatewmsProduct--TLogistics--"},{"$ref":"#/components/schemas/CreatewmsProduct--Unleashed--"},{"$ref":"#/components/schemas/CreatewmsProduct--VeraCore--"},{"$ref":"#/components/schemas/CreatewmsProduct--Warehance--"},{"$ref":"#/components/schemas/CreatewmsProduct--Whiplash__-_Ryder_---"}],"title":"CreatewmsProductInputSchema"},"ExchangeResponseShipbob":{"type":"object","properties":{"access_token":{"type":"string","description":"The permanent access token for the integration used to make requests to the Trackstar API.","example":"your_permanent_access_token"},"connection_id":{"type":"string","description":"A unique connection ID for the integration.","example":"unique_connection_id"},"integration_name":{"type":"string","description":"The name of the integration that was installed.","example":"shipbob"},"customer_id":{"type":["string","null"],"description":"An identifier for your end customer.","example":"customer_id"},"available_actions":{"type":"array","description":"A list of actions that the integration supports.","example":["get_inventory","get_products"],"items":{"type":"string","description":"Actions supported by the integration","example":"available_actions"}},"me":{"type":["object","null"],"description":"Information that helps identify the connected account. If null, the integration does not provide this information.","example":{"account_id":"account_12345","account_name":"My WMS Account"},"additionalProperties":{"description":"Field value. Structure varies based on integration."}}},"required":["access_token","available_actions","connection_id","customer_id","integration_name","me"],"additionalProperties":false,"title":"ExchangeResponseShipbob"},"ExchangeInputSchema":{"type":"object","properties":{"auth_code":{"type":"string","description":"The authorization code returned from the frontend after a user installs an integration.","example":"auth_code"},"customer_id":{"type":["string","null"],"description":"An identifier for your end customer.","example":"customer_id"}},"required":["auth_code"],"additionalProperties":false,"title":"ExchangeInputSchema"},"WmsInventoryItemIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsInventoryItemIdsQueryParam"},"WmsInventoryItemCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryItemCreated_DateQueryParam"},"WmsInventoryItemUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryItemUpdated_DateQueryParam"},"WmsInventoryItemTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryItemTrackstar_Created_DateQueryParam"},"WmsInventoryItemTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryItemTrackstar_Updated_DateQueryParam"},"WmsInventoryItemTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"WmsInventoryItemTrackstar_Tags_FlatQueryParam"},"WmsInventoryItemWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInventoryItemWarehouse_Customer_IdQueryParam"},"WmsInventoryItemSkuQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"sku"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"},"is_null":{"type":"boolean","description":"Filter by whether the field is null.","example":true}},"additionalProperties":false,"title":"WmsInventoryItemSkuQueryParam"},"InventoryInWarehouse":{"type":"object","properties":{"awaiting":{"type":["integer","null"],"description":"","example":0},"onhand":{"type":"integer","description":"","example":0},"committed":{"type":["integer","null"],"description":"","example":0},"unfulfillable":{"type":["integer","null"],"description":"","example":0},"fulfillable":{"type":["integer","null"],"description":"","example":0},"sellable":{"type":["integer","null"],"description":"","example":0}},"required":["awaiting","committed","fulfillable","onhand","sellable","unfulfillable"],"additionalProperties":false,"title":"InventoryInWarehouse"},"Lot":{"type":"object","properties":{"lot_id":{"type":"string","description":"Lot ID.","example":"lot_id"},"onhand":{"type":"integer","description":"The total amount of inventory in the lot.","example":0},"expiration_date":{"type":["string","null"],"format":"date-time","description":"The date that the lot expires.","example":"2023-03-15T13:45:30Z"},"warehouse_id":{"type":["string","null"],"description":"ID of the warehouse that the lot is kept in. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"required":["expiration_date","lot_id","onhand","warehouse_id"],"additionalProperties":false,"title":"Lot"},"InventoryItemMeasurements":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the inventory item.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the inventory item.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"InventoryItemMeasurements"},"Location":{"type":"object","properties":{"location_id":{"type":"string","description":"Location ID.","example":"location_id"},"quantity":{"type":"integer","description":"The total amount of inventory stored in the location.","example":0},"warehouse_id":{"type":"string","description":"ID of the warehouse that contains the location. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"required":["location_id","quantity","warehouse_id"],"additionalProperties":false,"title":"Location"},"WmsInventoryItemApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item.","example":"inv_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"unit_cost":{"type":["number","null"],"description":"The cost of a single unit of the inventory item.","example":1.0},"active":{"type":"boolean","description":"Whether the inventory item is active.","example":true},"awaiting":{"type":"integer","description":"Inventory that the warehouse is awaiting delivery of.","example":0},"onhand":{"type":"integer","description":"The total amount of inventory in the warehouse.","example":5},"committed":{"type":"integer","description":"Inventory that is already assigned to orders.","example":1},"unfulfillable":{"type":"integer","description":"Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).","example":0},"fulfillable":{"type":"integer","description":"Inventory that can be fulfilled for orders.","example":4},"sellable":{"type":"integer","description":"Inventory that is available in sales channels.","example":2},"substitute_skus":{"type":"array","description":"A list of inventory item SKUs that can replace this item if it runs out of stock.","example":["sub_sku_1","sub_sku_2"],"items":{"type":"string","description":"sub_sku","example":"substitute_skus"}},"inventory_by_warehouse_id":{"type":"object","description":"Inventory broken down by warehouse.","example":{"warehouse_id_1":{"onhand":4,"committed":1,"unfulfillable":0,"fulfillable":3,"sellable":2,"awaiting":0},"warehouse_id_2":{"onhand":1,"committed":0,"unfulfillable":0,"fulfillable":1,"sellable":1,"awaiting":0}},"additionalProperties":{"$ref":"#/components/schemas/InventoryInWarehouse"}},"lots":{"type":"array","description":"A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.","example":[{"lot_id":"lot_id_1","onhand":2,"expiration_date":"2022-01-01T00:00:00Z","warehouse_id":"warehouse_id1"},{"lot_id":"lot_id_2","onhand":1,"expiration_date":"2022-01-03T00:00:00Z","warehouse_id":"warehouse_id2"}],"items":{"$ref":"#/components/schemas/Lot"}},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurements"},"locations":{"type":"array","description":"A list of locations within a warehouse where the inventory item is stored.","example":[{"location_id":"location_id_1","quantity":2,"warehouse_id":"warehouse_id1"},{"location_id":"location_id_2","quantity":1,"warehouse_id":"warehouse_id2"}],"items":{"$ref":"#/components/schemas/Location"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inventory item in the external system (WMS/Freight etc).","example":"https://example.com/inventoryitem/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","awaiting","committed","created_date","external_system_url","fulfillable","id","inventory_by_warehouse_id","locations","lots","measurements","name","onhand","sellable","sku","substitute_skus","trackstar_created_date","trackstar_tags","trackstar_updated_date","unfulfillable","unit_cost","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsInventoryItemApiItemSchema"},"WmsInventoryListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsInventoryItemApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsInventoryListEndpoint"},"CreateInventoryItemResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item.","example":"inv_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"unit_cost":{"type":["number","null"],"description":"The cost of a single unit of the inventory item.","example":1.0},"active":{"type":"boolean","description":"Whether the inventory item is active.","example":true},"awaiting":{"type":"integer","description":"Inventory that the warehouse is awaiting delivery of.","example":0},"onhand":{"type":"integer","description":"The total amount of inventory in the warehouse.","example":5},"committed":{"type":"integer","description":"Inventory that is already assigned to orders.","example":1},"unfulfillable":{"type":"integer","description":"Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).","example":0},"fulfillable":{"type":"integer","description":"Inventory that can be fulfilled for orders.","example":4},"sellable":{"type":"integer","description":"Inventory that is available in sales channels.","example":2},"substitute_skus":{"type":"array","description":"A list of inventory item SKUs that can replace this item if it runs out of stock.","example":[],"items":{"type":"string","description":"sub_sku","example":"substitute_skus"}},"inventory_by_warehouse_id":{"type":"object","description":"Inventory broken down by warehouse.","example":{},"additionalProperties":{"$ref":"#/components/schemas/InventoryInWarehouse"}},"lots":{"type":"array","description":"A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.","example":[],"items":{"$ref":"#/components/schemas/Lot"}},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurements"},"locations":{"type":"array","description":"A list of locations within a warehouse where the inventory item is stored.","example":[],"items":{"$ref":"#/components/schemas/Location"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inventory item in the external system (WMS/Freight etc).","example":"https://example.com/inventoryitem/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","awaiting","committed","created_date","external_system_url","fulfillable","id","inventory_by_warehouse_id","locations","lots","measurements","name","onhand","sellable","sku","substitute_skus","trackstar_created_date","trackstar_tags","trackstar_updated_date","unfulfillable","unit_cost","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"CreateInventoryItemResponseDataSchema"},"wmsCreateInventoryItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateInventoryItemResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateInventoryItemResponse"},"CreatewmsInventoryItem--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"XS Red Shirt"},"sku":{"type":"string","description":"sku","example":"XS-RED-SHIRT"},"unit_cost":{"type":"number","description":"The cost of a single unit of the inventory item.","example":1.0},"awaiting":{"type":"integer","description":"Inventory that the warehouse is awaiting delivery of.","example":0},"onhand":{"type":"integer","description":"The total amount of inventory in the warehouse.","example":5},"committed":{"type":"integer","description":"Inventory that is already assigned to orders.","example":1},"unfulfillable":{"type":"integer","description":"Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).","example":0},"fulfillable":{"type":"integer","description":"Inventory that can be fulfilled for orders.","example":4},"sellable":{"type":"integer","description":"Inventory that is available in sales channels.","example":2},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurements"}},"required":["awaiting","committed","fulfillable","measurements","name","onhand","sellable","sku","unfulfillable","unit_cost"],"additionalProperties":false,"title":"WMS Sandbox"},"CreatewmsInventoryItemInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreatewmsInventoryItem--WMS__Sandbox--"}],"title":"CreatewmsInventoryItemInputSchema"},"CarrierFileIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"CarrierFileIdsQueryParam"},"CarrierFileCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierFileCreated_DateQueryParam"},"CarrierFileUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierFileUpdated_DateQueryParam"},"CarrierFileTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierFileTrackstar_Created_DateQueryParam"},"CarrierFileTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierFileTrackstar_Updated_DateQueryParam"},"CarrierFileFile_NameQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"invoice.csv"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"CarrierFileFile_NameQueryParam"},"CarrierFileFile_TypeQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"csv"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"CarrierFileFile_TypeQueryParam"},"CarrierFileWithUrlSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the file.","example":"2025-11-15T00:00:00/crawl_id/invoice.csv"},"created_date":{"type":"string","format":"date-time","description":"The date the file was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the file was last updated.","example":"2022-01-02T05:05:05Z"},"file_name":{"type":"string","description":"The file name.","example":"invoice.csv"},"file_type":{"type":["string","null"],"description":"The file extension.","example":"csv"},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"download_url":{"type":"string","description":"Presigned download URL (valid for 20 minutes).","example":"https://s3.amazonaws.com/..."},"download_url_expires_at":{"type":"string","format":"date-time","description":"Expiration timestamp for the download URL.","example":"2025-01-15T10:50:00Z"}},"required":["created_date","download_url","download_url_expires_at","file_name","file_type","id","trackstar_created_date","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"CarrierFileWithUrlSchema"},"CarrierFilesListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/CarrierFileWithUrlSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"CarrierFilesListEndpoint"},"CartProductIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"CartProductIdsQueryParam"},"CartProductCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartProductCreated_DateQueryParam"},"CartProductUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartProductUpdated_DateQueryParam"},"CartProductTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartProductTrackstar_Created_DateQueryParam"},"CartProductTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartProductTrackstar_Updated_DateQueryParam"},"CartProductTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"CartProductTrackstar_Tags_FlatQueryParam"},"CartProductSkuQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"sku"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"},"is_null":{"type":"boolean","description":"Filter by whether the field is null.","example":true}},"additionalProperties":false,"title":"CartProductSkuQueryParam"},"CartProductApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"created_date":{"type":"string","format":"date-time","description":"The date the cart product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the cart product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the product.","example":"product_name"},"sku":{"type":["string","null"],"description":"The SKU of the product.","example":"sku"},"gtin":{"type":["string","null"],"description":"The GTIN of the product.","example":"gtin"},"parent_product_id":{"type":"string","description":"If this is a variant, the ID of the parent product. If this is a parent product, this field should be the same as ID.","example":"parent_product_id"},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"image_url":{"type":["string","null"],"description":"The URL of the product's image.","example":"https://example.com/image.jpg"},"price":{"type":["number","null"],"description":"The price of the product if it is a variant. Not the source of truth for parent products.","example":10.0},"unit_cost":{"type":["number","null"],"description":"The unit cost of the product if it is a variant. Not the source of truth for parent products.","example":10.0},"inventory":{"type":["integer","null"],"description":"The inventory of the product if it is a variant. Not the source of truth for parent products.","example":10},"inventory_by_warehouse_id":{"type":"object","description":"Inventory broken down by warehouse.","example":{"warehouse_id_1":6,"warehouse_id_2":4},"additionalProperties":{"type":"integer","description":"Inventory for that warehouse.","example":5}},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"},"tags":{"type":"array","description":"A list of tags associated with the product. Tags that are represented as key-value pairs in the underlying system will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the product.","example":"tag_0"}},"categories":{"type":"array","description":"A list of category names the product belongs to. For platforms with a hierarchical category tree, each level is a separate element with the leaf last (e.g. [\"Apparel\", \"Shoes\", \"Running\"]). For platforms with a single scalar product type, a single-element list.","example":["Apparel","Shoes","Running"],"items":{"type":"string","description":"A category name.","example":"Apparel"}},"external_system_url":{"type":["string","null"],"description":"URL link to the cart product in the external system (WMS/Freight etc).","example":"https://example.com/cartproduct/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","categories","created_date","external_system_url","gtin","id","image_url","inventory","inventory_by_warehouse_id","is_kit","measurements","name","parent_product_id","price","sku","tags","trackstar_created_date","trackstar_tags","trackstar_updated_date","unit_cost","updated_date"],"additionalProperties":false,"title":"CartProductApiItemSchema"},"CartProductsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/CartProductApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"CartProductsListEndpoint"},"ErpInventoryItemIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpInventoryItemIdsQueryParam"},"ErpInventoryItemCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpInventoryItemCreated_DateQueryParam"},"ErpInventoryItemUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpInventoryItemUpdated_DateQueryParam"},"ErpInventoryItemTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpInventoryItemTrackstar_Created_DateQueryParam"},"ErpInventoryItemTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpInventoryItemTrackstar_Updated_DateQueryParam"},"ErpInventoryItemTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpInventoryItemTrackstar_Tags_FlatQueryParam"},"ErpInventoryItemSkuQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"sku"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"},"is_null":{"type":"boolean","description":"Filter by whether the field is null.","example":true}},"additionalProperties":false,"title":"ErpInventoryItemSkuQueryParam"},"ErpInventoryAtLocation":{"type":"object","properties":{"onhand":{"type":"number","description":"Physical on-hand quantity at the location.","example":0.0},"committed":{"type":["number","null"],"description":"Quantity committed / reserved against orders at the location.","example":0.0},"available":{"type":["number","null"],"description":"Quantity available to sell at the location (typically onhand minus committed).","example":0.0}},"required":["available","committed","onhand"],"additionalProperties":false,"title":"ErpInventoryAtLocation"},"ErpItemVendor":{"type":"object","properties":{"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vendor_id"},"vendor_name":{"type":["string","null"],"description":"Display name of the vendor.","example":"vendor_name"}},"required":["vendor_id","vendor_name"],"additionalProperties":false,"title":"ErpItemVendor"},"ErpLot":{"type":"object","properties":{"lot_id":{"type":"string","description":"Lot ID.","example":"lot_id"},"lot_name":{"type":["string","null"],"description":"Human-readable lot name as shown in the source ERP (e.g. 'LOT-20260418-A').","example":"lot_name"},"onhand":{"type":"number","description":"Quantity on hand for this lot at this location.","example":0.0},"expiration_date":{"type":["string","null"],"format":"date-time","description":"The date that the lot expires.","example":"2023-03-15T13:45:30Z"},"location_id":{"type":"string","description":"ID of the location the lot is stored at. Same identifier as in /erp/locations and inventory_by_location_id keys.","example":"location_id"}},"required":["expiration_date","location_id","lot_id","lot_name","onhand"],"additionalProperties":false,"title":"ErpLot"},"ErpBin":{"type":"object","properties":{"bin_id":{"type":"string","description":"Bin ID.","example":"bin_id"},"bin_name":{"type":["string","null"],"description":"Human-readable bin name as shown in the source ERP (e.g. 'C-03-L3-P2').","example":"bin_name"},"onhand":{"type":"number","description":"Quantity on hand in this bin (for the optionally-paired lot, when the item is also lot-tracked).","example":0.0},"location_id":{"type":"string","description":"ID of the location the bin is in. Same identifier as in /erp/locations and inventory_by_location_id keys.","example":"location_id"},"lot_id":{"type":["string","null"],"description":"If the item is both lot-tracked and bin-tracked, the lot occupying this bin. Null when the item is bin-tracked but not lot-tracked.","example":"lot_id"}},"required":["bin_id","bin_name","location_id","lot_id","onhand"],"additionalProperties":false,"title":"ErpBin"},"ErpInventoryItemCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpInventoryItemCustomFieldEntry"},"InventoryItemMeasurementsErp":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the inventory item.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the inventory item.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"InventoryItemMeasurementsErp"},"ErpInventoryItemApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item in the ERP.","example":"inv_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The display name of the inventory item.","example":"Apple - Fuji"},"sku":{"type":["string","null"],"description":"The SKU / item number of the inventory item.","example":"10000"},"upc":{"type":["string","null"],"description":"UPC / GTIN barcode for the item.","example":"012345678905"},"active":{"type":"boolean","description":"Whether the inventory item is active.","example":true},"description":{"type":["string","null"],"description":"A long-form description of the inventory item.","example":"Fuji apple, loose"},"unit_cost":{"type":["number","null"],"description":"Cost of a single unit of the inventory item, expressed in the ERP's base currency. The accounting meaning (e.g., standard, average, FIFO/LIFO) depends on `costing_method`.","example":1.0},"costing_method":{"type":["string","null"],"description":"How the ERP values this item for inventory accounting (e.g., Standard, Average, FIFO, LIFO).","example":"Standard"},"stock_unit":{"type":["string","null"],"description":"Unit of measure for on-hand quantities (e.g., EA, LB, CS).","example":"EA"},"onhand":{"type":["number","null"],"description":"Total physical on-hand quantity across all locations.","example":42.5},"committed":{"type":["number","null"],"description":"Total quantity committed / reserved against orders across all locations.","example":2.5},"available":{"type":["number","null"],"description":"Total quantity available to sell across all locations (typically onhand minus committed).","example":40.0},"inventory_by_location_id":{"type":"object","description":"Inventory broken down by location. A location can be a warehouse, retail store, production line, or consignment site depending on how the ERP is configured.","example":{"location_id_1":{"onhand":42.5,"committed":2.5,"available":40.0},"location_id_2":{"onhand":0.0,"committed":0.0,"available":0.0}},"additionalProperties":{"$ref":"#/components/schemas/ErpInventoryAtLocation"}},"vendors":{"type":"array","description":"Vendors from whom this item is purchased.","example":[{"vendor_id":"vendor_1","vendor_name":"Acme Produce Co."}],"items":{"$ref":"#/components/schemas/ErpItemVendor"}},"lots":{"type":"array","description":"A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.","example":[{"lot_id":"9821","lot_name":"LOT-20260418-A","onhand":240.0,"expiration_date":"2026-05-09T00:00:00Z","location_id":"114"}],"items":{"$ref":"#/components/schemas/ErpLot"}},"bins":{"type":"array","description":"Bins are physical storage slots within a location. For items also tracked by lot, each entry is a (lot, bin) pair \u2014 the same bin can appear across multiple entries (holding different lots) and the same lot can appear across multiple bins.","example":[{"bin_id":"157","bin_name":"C-03-L3-P2","onhand":240.0,"location_id":"114","lot_id":"9821"}],"items":{"$ref":"#/components/schemas/ErpBin"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the inventory item. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpInventoryItemCustomFieldEntry"}},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurementsErp"},"external_system_url":{"type":["string","null"],"description":"URL link to the inventory item in the external system (WMS/Freight etc).","example":"https://example.com/inventoryitem/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","available","bins","committed","costing_method","created_date","custom_fields","description","external_system_url","id","inventory_by_location_id","lots","measurements","name","onhand","sku","stock_unit","trackstar_created_date","trackstar_tags","trackstar_updated_date","unit_cost","upc","updated_date","vendors"],"additionalProperties":false,"title":"ErpInventoryItemApiItemSchema"},"ErpInventoryListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpInventoryItemApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpInventoryListEndpoint"},"ErpLocationIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpLocationIdsQueryParam"},"ErpLocationCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpLocationCreated_DateQueryParam"},"ErpLocationUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpLocationUpdated_DateQueryParam"},"ErpLocationTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpLocationTrackstar_Created_DateQueryParam"},"ErpLocationTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpLocationTrackstar_Updated_DateQueryParam"},"ErpLocationTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpLocationTrackstar_Tags_FlatQueryParam"},"ErpLocationNameQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"Fresno DC"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpLocationNameQueryParam"},"ErpLocationCodeQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"FRE"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpLocationCodeQueryParam"},"ErpLocationCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpLocationCustomFieldEntry"},"ErpLocationApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the location in the ERP.","example":"loc_1"},"created_date":{"type":"string","format":"date-time","description":"The date the location was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the location was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the location as shown in the ERP.","example":"Fresno DC"},"code":{"type":["string","null"],"description":"A short user-facing code for the location. Many ERPs do not distinguish a code from the name.","example":"FRE"},"active":{"type":["boolean","null"],"description":"Whether the location is active in the ERP.","example":true},"location_type":{"type":["string","null"],"description":"The ERP's classification for the location (e.g., Warehouse, Store, Office).","example":"Warehouse"},"full_path":{"type":["string","null"],"description":"The hierarchical path of the location (e.g., 'North America : West : Fresno DC'). Populated when the ERP nests locations under parents.","example":"North America : West : Fresno DC"},"parent_location_id":{"type":["string","null"],"description":"ID of the parent location in the ERP's location hierarchy.","example":"loc_parent_1"},"parent_location_name":{"type":["string","null"],"description":"Display name of the parent referenced by parent_location_id.","example":"West"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the location. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpLocationCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the location in the external system (WMS/Freight etc).","example":"https://example.com/location/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","address","code","created_date","custom_fields","external_system_url","full_path","id","location_type","name","parent_location_id","parent_location_name","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"ErpLocationApiItemSchema"},"ErpLocationsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpLocationApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpLocationsListEndpoint"},"ErpCustomerIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpCustomerIdsQueryParam"},"ErpCustomerCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpCustomerCreated_DateQueryParam"},"ErpCustomerUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpCustomerUpdated_DateQueryParam"},"ErpCustomerTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpCustomerTrackstar_Created_DateQueryParam"},"ErpCustomerTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpCustomerTrackstar_Updated_DateQueryParam"},"ErpCustomerTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpCustomerTrackstar_Tags_FlatQueryParam"},"ErpCustomerCustomer_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"CUS0001"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpCustomerCustomer_NumberQueryParam"},"ErpCustomerNameQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"Acme Co."},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpCustomerNameQueryParam"},"ErpCustomerEmailQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"buyer@example.com"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpCustomerEmailQueryParam"},"ErpCustomerCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpCustomerCustomFieldEntry"},"ErpCustomerApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the customer in the ERP.","example":"cust_1"},"created_date":{"type":"string","format":"date-time","description":"The date the customer was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the customer was last updated.","example":"2022-01-02T05:05:05Z"},"customer_number":{"type":["string","null"],"description":"The user-facing identifier of the customer as assigned by the ERP.","example":"CUS0001"},"name":{"type":"string","description":"Display name of the customer (company name for businesses, full name for individuals).","example":"Acme Co."},"email":{"type":["string","null"],"description":"Primary email address recorded on the customer.","example":"buyer@example.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the customer.","example":"415-555-0142"},"is_individual":{"type":["boolean","null"],"description":"Whether the customer is a person (B2C) rather than a company (B2B).","example":false},"active":{"type":["boolean","null"],"description":"Whether the customer is active in the ERP.","example":true},"billing_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_address":{"$ref":"#/components/schemas/ShipToAddress"},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the customer. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpCustomerCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the customer in the external system (WMS/Freight etc).","example":"https://example.com/customer/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","billing_address","created_date","custom_fields","customer_number","email","external_system_url","id","is_individual","name","phone","shipping_address","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"ErpCustomerApiItemSchema"},"ErpCustomersListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpCustomerApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpCustomersListEndpoint"},"ErpEmployeeIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpEmployeeIdsQueryParam"},"ErpEmployeeCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpEmployeeCreated_DateQueryParam"},"ErpEmployeeUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpEmployeeUpdated_DateQueryParam"},"ErpEmployeeTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpEmployeeTrackstar_Created_DateQueryParam"},"ErpEmployeeTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpEmployeeTrackstar_Updated_DateQueryParam"},"ErpEmployeeTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpEmployeeTrackstar_Tags_FlatQueryParam"},"ErpEmployeeEmployee_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"E0001"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpEmployeeEmployee_NumberQueryParam"},"ErpEmployeeCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpEmployeeCustomFieldEntry"},"ErpEmployeeApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the employee in the ERP.","example":"emp_1"},"created_date":{"type":"string","format":"date-time","description":"The date the employee was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the employee was last updated.","example":"2022-01-02T05:05:05Z"},"employee_number":{"type":["string","null"],"description":"The user-facing identifier of the employee as assigned by the ERP.","example":"E0001"},"name":{"type":"string","description":"Display name of the employee (firstname + lastname, or entityid fallback).","example":"Jane Smith"},"first_name":{"type":["string","null"],"description":"Employee's first name.","example":"Jane"},"last_name":{"type":["string","null"],"description":"Employee's last name.","example":"Smith"},"email":{"type":["string","null"],"description":"Primary email address recorded on the employee.","example":"jane.smith@example.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the employee.","example":"415-555-0193"},"title":{"type":["string","null"],"description":"Job title of the employee.","example":"Warehouse Manager"},"active":{"type":["boolean","null"],"description":"Whether the employee is active in the ERP.","example":true},"supervisor_id":{"type":["string","null"],"description":"Internal ID of the employee's supervisor.","example":"42"},"approver_id":{"type":["string","null"],"description":"Internal ID of the employee's general approver.","example":"43"},"location_id":{"type":["string","null"],"description":"Internal ID of the employee's primary location.","example":"309"},"subsidiary_id":{"type":["string","null"],"description":"Internal ID of the employee's subsidiary.","example":"1"},"purchase_order_limit":{"type":["number","null"],"description":"Maximum purchase order amount this employee can author. Units vary by account configuration.","example":10.0},"purchase_order_approver_id":{"type":["string","null"],"description":"Internal ID of the employee who approves this employee's purchase orders.","example":"44"},"purchase_order_approval_limit":{"type":["number","null"],"description":"Maximum purchase order amount this employee can approve for others. Units vary by account configuration.","example":10.0},"expense_limit":{"type":["number","null"],"description":"Maximum expense report amount for this employee. Units vary by account configuration.","example":500.0},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the employee. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpEmployeeCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the employee in the external system (WMS/Freight etc).","example":"https://example.com/employee/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["active","additional_fields","approver_id","created_date","custom_fields","email","employee_number","expense_limit","external_system_url","first_name","id","last_name","location_id","name","phone","purchase_order_approval_limit","purchase_order_approver_id","purchase_order_limit","subsidiary_id","supervisor_id","title","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"ErpEmployeeApiItemSchema"},"ErpEmployeesListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpEmployeeApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpEmployeesListEndpoint"},"WmsWarehouseIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsWarehouseIdsQueryParam"},"WmsWarehouseCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseCreated_DateQueryParam"},"WmsWarehouseUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseUpdated_DateQueryParam"},"WmsWarehouseTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseTrackstar_Created_DateQueryParam"},"WmsWarehouseTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseTrackstar_Updated_DateQueryParam"},"WmsWarehouseTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"WmsWarehouseTrackstar_Tags_FlatQueryParam"},"WmsWarehouseNameQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"Bethlehem (PA)"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsWarehouseNameQueryParam"},"WmsWarehouseCodeQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"ABE-1"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsWarehouseCodeQueryParam"},"WmsWarehouseApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse.","example":"warehouse_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","address","code","created_date","id","name","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"WmsWarehouseApiItemSchema"},"WmsWarehousesListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsWarehouseApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsWarehousesListEndpoint"},"wmsCreateWarehouseResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsWarehouseApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateWarehouseResponse"},"SandboxCreateWarehouseAddress":{"type":"object","properties":{"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","postal_code"],"additionalProperties":false,"title":"SandboxCreateWarehouseAddress"},"CreatewmsWarehouse--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/SandboxCreateWarehouseAddress"}},"required":["address","code","name"],"additionalProperties":false,"title":"WMS Sandbox"},"CreatewmsWarehouse--Luminous--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"}},"required":["address","code","name"],"additionalProperties":false,"title":"Luminous"},"CreatewmsWarehouseInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreatewmsWarehouse--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreatewmsWarehouse--Luminous--"}],"title":"CreatewmsWarehouseInputSchema"},"APILogFacets":{"type":"object","properties":{"connection_id":{"type":"array","description":"The distinct connections your requests were made against.","example":["abc123def456abc123def456abc123de"],"items":{"type":"string","description":"","example":"connection_id"}},"integration_name":{"type":"array","description":"The distinct integrations your requests were made against.","example":["example_wms"],"items":{"type":"string","description":"","example":"integration_name"}},"request_path":{"type":"array","description":"The distinct endpoints your requests were made to. Path parameters are replaced with ``.","example":["/wms/orders/"],"items":{"type":"string","description":"","example":"request_path"}},"status_code":{"type":"array","description":"The distinct HTTP status codes your requests returned.","example":[200,404],"items":{"type":"integer","description":"","example":0}}},"required":["connection_id","integration_name","request_path","status_code"],"additionalProperties":false,"title":"APILogFacets"},"APILogFacetsResponseSchema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/APILogFacets"}},"required":["data"],"additionalProperties":false,"title":"APILogFacetsResponseSchema"},"PassthroughResponseSchema":{"type":"object","properties":{"status_code":{"type":"integer","description":"The HTTP status code returned by the integration.","example":200},"headers":{"type":"object","description":"Response headers from the integration.","example":{"content-type":"application/json"},"additionalProperties":{}},"body":{"description":"The raw response body from the integration."}},"required":["body","headers","status_code"],"additionalProperties":false,"title":"PassthroughResponseSchema"},"PassthroughRequestSchema":{"type":"object","properties":{"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"description":"The HTTP method to use for the request.","example":"POST"},"path":{"type":"string","description":"The integration-specific endpoint path.","example":"/graphql"},"data":{"description":"The request body to send to the integration. For GraphQL, this would be the query."},"headers":{"type":"object","description":"Optional additional headers to send with the request.","example":{"Content-Type":"application/json"},"additionalProperties":{"type":"string","description":"","example":"headers"}},"params":{"type":"object","description":"Optional query parameters to append to the request URL.","example":{"page":"1","limit":"100"},"additionalProperties":{"type":"string","description":"","example":"params"}}},"required":["method","path"],"additionalProperties":false,"title":"PassthroughRequestSchema"},"CartWarehouseIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"CartWarehouseIdsQueryParam"},"CartWarehouseCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartWarehouseCreated_DateQueryParam"},"CartWarehouseUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartWarehouseUpdated_DateQueryParam"},"CartWarehouseTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartWarehouseTrackstar_Created_DateQueryParam"},"CartWarehouseTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CartWarehouseTrackstar_Updated_DateQueryParam"},"CartWarehouseTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"CartWarehouseTrackstar_Tags_FlatQueryParam"},"CartWarehouseApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse.","example":"warehouse_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"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":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["address","code","created_date","id","name","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"CartWarehouseApiItemSchema"},"CartWarehousesListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/CartWarehouseApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"CartWarehousesListEndpoint"},"SyncConnectionResponseSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the connection synced.","example":"07b344db-0304-4866-9ae1-ac8af5292a28"},"syncing":{"type":"boolean","description":"Whether or not the connection is syncing.","example":true},"functions_to_sync":{"type":"array","description":"The functions that are being synced. Returns empty if all are being synced.","example":["get_inventory","get_orders"],"items":{"type":"string","description":"","example":"functions_to_sync"}}},"required":["functions_to_sync","id","syncing"],"additionalProperties":false,"title":"SyncConnectionResponseSchema"},"ConnectionResourceSyncSchema":{"type":"object","properties":{"functions_to_sync":{"type":"array","description":"The specific functions to force sync. Make sure to use one compatible with the connection's type.","example":["get_inventory","get_orders"],"items":{"type":"string","enum":["get_inventory","get_products","get_inbound_shipments","get_orders","get_warehouses","get_shipping_methods","get_returns","get_bills","get_warehouse_customers","get_warehouse_locations","get_inventory_ledger","populate_customer_order_trackstar_tags","get_shipments","redact_cart_orders","get_invoice_line_items","get_files","get_sales_orders","get_sales_order_shipments","get_locations","get_items","get_customers","get_vendors","get_employees","get_purchase_orders","get_purchase_order_receipts"],"description":"Function to sync","example":"get_bills"}}},"additionalProperties":false,"title":"ConnectionResourceSyncSchema"},"ErpSalesOrderIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpSalesOrderIdsQueryParam"},"ErpSalesOrderCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderCreated_DateQueryParam"},"ErpSalesOrderUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderUpdated_DateQueryParam"},"ErpSalesOrderTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderTrackstar_Created_DateQueryParam"},"ErpSalesOrderTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderTrackstar_Updated_DateQueryParam"},"ErpSalesOrderTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpSalesOrderTrackstar_Tags_FlatQueryParam"},"ErpSalesOrderStatusQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"","example":"pending_approval"},"neq":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"","example":"cancelled"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"","example":"cancelled"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"","example":"cancelled"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpSalesOrderStatusQueryParam"},"ErpSalesOrderOrder_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"SO1001"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpSalesOrderOrder_NumberQueryParam"},"ErpSalesOrderReference_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"PO-9921"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpSalesOrderReference_IdQueryParam"},"ErpSalesOrderOrder_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2024-05-01T00:00:00Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderOrder_DateQueryParam"},"ErpSalesOrderKitComponent":{"type":"object","properties":{"line_item_id":{"type":"string","description":"Line-unique ID of the component within the order.","example":"line_item_id"},"item_id":{"type":"string","description":"ID of the component item.","example":"item_id"},"sku":{"type":"string","description":"SKU / item number of the component item.","example":"sku"},"quantity":{"type":"number","description":"Quantity of this component ordered on this kit line.","example":0.0}},"required":["item_id","line_item_id","quantity","sku"],"additionalProperties":false,"title":"ErpSalesOrderKitComponent"},"ErpSalesOrderLineItem":{"type":"object","properties":{"line_item_id":{"type":"string","description":"Line-unique ID within the order.","example":"line_item_id"},"item_id":{"type":"string","description":"ID of the item sold on this line.","example":"item_id"},"sku":{"type":"string","description":"SKU / item number of the item.","example":"sku"},"quantity":{"type":"number","description":"Quantity ordered on this line.","example":0.0},"unit_price":{"type":"number","description":"Per-unit price in the order currency.","example":0.0},"is_kit":{"type":"boolean","description":"Whether this line is a kit. A kit ships as a unit, so its components are not listed as separate lines here; they are nested under `kit_components`.","example":false},"kit_components":{"type":"array","description":"The items inside this kit line, at the quantities this line ordered. Empty unless the line is a kit. Each entry has its own line_item_id, which is what you reference when supplying lot or bin information at fulfillment.","example":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0}],"items":{"$ref":"#/components/schemas/ErpSalesOrderKitComponent"}},"location_id":{"type":["string","null"],"description":"ID of the location the line ships from. Set per-line when an order splits items across multiple origins; otherwise inherits the order-level `location_id`.","example":"location_id"}},"required":["is_kit","item_id","kit_components","line_item_id","location_id","quantity","sku","unit_price"],"additionalProperties":false,"title":"ErpSalesOrderLineItem"},"ErpSalesOrderCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpSalesOrderCustomFieldEntry"},"ErpSalesOrderApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sales order in the ERP.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"status":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"The status of the sales order. See the [sales order information](info) for more details.","example":"pending_approval"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Fulfillment', 'Partially Fulfilled').","example":"Pending Fulfillment"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"subtotal":{"type":["number","null"],"description":"Sum of item line amounts before tax, shipping, and discount, in the order currency.","example":100.0},"total_tax":{"type":["number","null"],"description":"Total tax charged on the order, in the order currency.","example":8.5},"total_shipping":{"type":["number","null"],"description":"Total shipping charged on the order, in the order currency.","example":12.0},"total_discount":{"type":["number","null"],"description":"Total discount applied to the order, in the order currency.","example":5.0},"total_price":{"type":["number","null"],"description":"Grand total the customer will be billed for the order, in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_method_id":{"type":["string","null"],"description":"ID of the shipping method on the order.","example":"sm_1"},"shipping_method_name":{"type":["string","null"],"description":"Display name of the shipping method.","example":"UPS Ground"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0}],"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order in the external system (WMS/Freight etc).","example":"https://example.com/salesorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","customer_id","expected_ship_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","shipping_method_id","shipping_method_name","status","subtotal","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"ErpSalesOrderApiItemSchema"},"ErpSalesOrdersListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpSalesOrderApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpSalesOrdersListEndpoint"},"CreateErpSalesOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sales order in the ERP.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"status":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"The status of the sales order. See the [sales order information](info) for more details.","example":"pending_approval"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Fulfillment', 'Partially Fulfilled').","example":"Pending Fulfillment"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"subtotal":{"type":["number","null"],"description":"Sum of item line amounts before tax, shipping, and discount, in the order currency.","example":100.0},"total_tax":{"type":["number","null"],"description":"Total tax charged on the order, in the order currency.","example":8.5},"total_shipping":{"type":["number","null"],"description":"Total shipping charged on the order, in the order currency.","example":12.0},"total_discount":{"type":["number","null"],"description":"Total discount applied to the order, in the order currency.","example":5.0},"total_price":{"type":["number","null"],"description":"Grand total the customer will be billed for the order, in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_method_id":{"type":["string","null"],"description":"ID of the shipping method on the order.","example":"sm_1"},"shipping_method_name":{"type":["string","null"],"description":"Display name of the shipping method.","example":"UPS Ground"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0}],"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order in the external system (WMS/Freight etc).","example":"https://example.com/salesorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","customer_id","expected_ship_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","shipping_method_id","shipping_method_name","status","subtotal","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"CreateErpSalesOrderResponseDataSchema"},"erpCreateSalesOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateErpSalesOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpCreateSalesOrderResponse"},"ErpSalesOrderShipToAddressNetsuite":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"additionalProperties":false,"title":"ErpSalesOrderShipToAddressNetsuite"},"ErpSalesOrderBillToAddressNetsuite":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"ErpSalesOrderBillToAddressNetsuite"},"ErpSalesOrderWriteLineItemnetsuite":{"type":"object","properties":{"item_id":{"type":"string","description":"","example":"item_id"},"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"number","description":"","example":0.0},"unit_price":{"type":"number","description":"","example":0.0},"location_id":{"type":"string","description":"","example":"location_id"}},"required":["item_id","quantity"],"additionalProperties":false,"title":"ErpSalesOrderWriteLineItemnetsuite"},"CreateerpSalesOrder--NetSuite--":{"type":"object","properties":{"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":{}},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"reference_id":{"type":"string","description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":"string","format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"location_id":{"type":"string","description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"ship_to_address":{"$ref":"#/components/schemas/ErpSalesOrderShipToAddressNetsuite"},"bill_to_address":{"$ref":"#/components/schemas/ErpSalesOrderBillToAddressNetsuite"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderWriteLineItemnetsuite"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}}},"required":["customer_id","line_items"],"additionalProperties":false,"title":"NetSuite"},"CreateerpSalesOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreateerpSalesOrder--NetSuite--"}],"title":"CreateerpSalesOrderInputSchema"},"FreightShipmentIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"FreightShipmentIdsQueryParam"},"FreightShipmentCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"FreightShipmentCreated_DateQueryParam"},"FreightShipmentUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"FreightShipmentUpdated_DateQueryParam"},"FreightShipmentTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"FreightShipmentTrackstar_Created_DateQueryParam"},"FreightShipmentTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"FreightShipmentTrackstar_Updated_DateQueryParam"},"FreightShipmentApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the shipment.","example":"shipment_id"},"eta_date":{"type":["string","null"],"format":"date-time","description":"The estimated arrival date of the shipment.","example":"2021-01-01T00:00:00Z"},"created_date":{"type":"string","format":"date-time","description":"The date the freight shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the freight shipment was last updated.","example":"2022-01-02T05:05:05Z"},"cost":{"type":["number","null"],"description":"The cost of the shipment.","example":1.0},"shipment_date":{"type":["string","null"],"format":"date-time","description":"The date the shipment was sent from its origin.","example":"2021-01-01T00:00:00Z"},"arrival_date":{"type":["string","null"],"format":"date-time","description":"The actual date the shipment arrived at its destination.","example":"2021-01-01T00:00:00Z"},"raw_status":{"type":["string","null"],"description":"The raw status of the shipment from the freight forwarder.","example":"status"},"status":{"type":"string","enum":["pre_transit","in_transit","arrival_port","en_route_to_destination","final_destination"],"description":"The status of the freight shipment. See the [freight shipment information](info) for more details.","example":"pre_transit"},"shipment_method":{"type":"string","description":"The mode by which the shipment was transported (e.g. air, ocean)","example":"shipment_method"},"external_system_url":{"type":["string","null"],"description":"URL link to the freight shipment in the external system (WMS/Freight etc).","example":"https://example.com/freightshipment/123"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","arrival_date","cost","created_date","eta_date","external_system_url","id","raw_status","shipment_date","shipment_method","status","trackstar_created_date","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"FreightShipmentApiItemSchema"},"FreightShipmentsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/FreightShipmentApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"FreightShipmentsListEndpoint"},"WmsOrderChannelIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsOrderChannelIdsQueryParam"},"WmsOrderChannelCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderChannelCreated_DateQueryParam"},"WmsOrderChannelUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderChannelUpdated_DateQueryParam"},"WmsOrderChannelTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderChannelTrackstar_Created_DateQueryParam"},"WmsOrderChannelTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsOrderChannelTrackstar_Updated_DateQueryParam"},"WmsOrderChannelWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsOrderChannelWarehouse_Customer_IdQueryParam"},"WmsOrderChannelApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique id of the channel.","example":"order_channel_id"},"name":{"type":["string","null"],"description":"The name of the channel.","example":"order_channel_name"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the order channel was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the order channel was last updated.","example":"2022-01-02T05:05:05Z"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","id","name","trackstar_created_date","trackstar_updated_date","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsOrderChannelApiItemSchema"},"WmsOrderChannelsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsOrderChannelApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsOrderChannelsListEndpoint"},"ErpPurchaseOrderIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpPurchaseOrderIdsQueryParam"},"ErpPurchaseOrderCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderCreated_DateQueryParam"},"ErpPurchaseOrderUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderUpdated_DateQueryParam"},"ErpPurchaseOrderTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderTrackstar_Created_DateQueryParam"},"ErpPurchaseOrderTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderTrackstar_Updated_DateQueryParam"},"ErpPurchaseOrderTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpPurchaseOrderTrackstar_Tags_FlatQueryParam"},"ErpPurchaseOrderStatusQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"","example":"pending_approval"},"neq":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"","example":"cancelled"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"","example":"cancelled"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"","example":"cancelled"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpPurchaseOrderStatusQueryParam"},"ErpPurchaseOrderOrder_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"PO1001"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpPurchaseOrderOrder_NumberQueryParam"},"ErpPurchaseOrderReference_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"QTE-7741"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpPurchaseOrderReference_IdQueryParam"},"ErpPurchaseOrderOrder_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2024-05-01T00:00:00Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderOrder_DateQueryParam"},"ErpPurchaseOrderLineItem":{"type":"object","properties":{"id":{"type":"string","description":"Line-unique ID within the order.","example":"id"},"item_id":{"type":"string","description":"ID of the item purchased on this line.","example":"item_id"},"sku":{"type":"string","description":"SKU / item number of the item.","example":"sku"},"quantity":{"type":"number","description":"Quantity ordered on this line.","example":0.0},"unit_price":{"type":"number","description":"Per-unit price in the order currency.","example":0.0},"location_id":{"type":["string","null"],"description":"ID of the location the line will be received into. Set per-line when an order splits items across multiple destinations; otherwise inherits the order-level `location_id`.","example":"location_id"}},"required":["id","item_id","location_id","quantity","sku","unit_price"],"additionalProperties":false,"title":"ErpPurchaseOrderLineItem"},"ErpPurchaseOrderCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpPurchaseOrderCustomFieldEntry"},"ErpPurchaseOrderApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the purchase order in the ERP.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"status":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"The status of the purchase order. See the [purchase order information](info) for more details.","example":"pending_approval"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Receipt', 'Partially Received').","example":"Pending Receipt"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":["string","null"],"description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"total_price":{"type":["number","null"],"description":"Grand total the supplier will be paid for the order (item subtotal plus tax and shipping minus discount), in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"id":"id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","employee_id","expected_arrival_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","status","total_price","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","vendor_id"],"additionalProperties":false,"title":"ErpPurchaseOrderApiItemSchema"},"ErpPurchaseOrdersListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpPurchaseOrderApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpPurchaseOrdersListEndpoint"},"CreateErpPurchaseOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the purchase order in the ERP.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"status":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"The status of the purchase order. See the [purchase order information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Receipt', 'Partially Received').","example":"Pending Receipt"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":["string","null"],"description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"total_price":{"type":["number","null"],"description":"Grand total the supplier will be paid for the order (item subtotal plus tax and shipping minus discount), in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"id":"id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","employee_id","expected_arrival_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","status","total_price","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","vendor_id"],"additionalProperties":false,"title":"CreateErpPurchaseOrderResponseDataSchema"},"erpCreatePurchaseOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateErpPurchaseOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpCreatePurchaseOrderResponse"},"ErpPurchaseOrderShipToAddressNetsuite":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"additionalProperties":false,"title":"ErpPurchaseOrderShipToAddressNetsuite"},"ErpPurchaseOrderBillToAddressNetsuite":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"ErpPurchaseOrderBillToAddressNetsuite"},"ErpPurchaseOrderWriteLineItemnetsuite":{"type":"object","properties":{"item_id":{"type":"string","description":"","example":"item_id"},"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"number","description":"","example":0.0},"unit_price":{"type":"number","description":"","example":0.0},"location_id":{"type":"string","description":"","example":"location_id"}},"required":["item_id","quantity"],"additionalProperties":false,"title":"ErpPurchaseOrderWriteLineItemnetsuite"},"CreateerpPurchaseOrder--NetSuite--":{"type":"object","properties":{"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":{}},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":"string","description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"reference_id":{"type":"string","description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":"string","format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"location_id":{"type":"string","description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"ship_to_address":{"$ref":"#/components/schemas/ErpPurchaseOrderShipToAddressNetsuite"},"bill_to_address":{"$ref":"#/components/schemas/ErpPurchaseOrderBillToAddressNetsuite"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderWriteLineItemnetsuite"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}}},"required":["line_items","vendor_id"],"additionalProperties":false,"title":"NetSuite"},"CreateerpPurchaseOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreateerpPurchaseOrder--NetSuite--"}],"title":"CreateerpPurchaseOrderInputSchema"},"ToggleScheduleSchema":{"type":"object","properties":{"paused":{"type":"boolean","description":"Whether the schedule is paused.","example":true}},"required":["paused"],"additionalProperties":false,"title":"ToggleScheduleSchema"},"IntegrationRequestResponseSchema":{"type":"object","properties":{"success":{"type":"boolean","description":"","example":true}},"required":["success"],"additionalProperties":false,"title":"IntegrationRequestResponseSchema"},"IntegrationRequestBodySchema":{"type":"object","properties":{"integration_type":{"type":"string","enum":["wms","cart","carrier"],"description":"","example":"carrier"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_contact_email":{"type":["string","null"],"description":"","example":"integration_contact_email"},"brand_name":{"type":["string","null"],"description":"","example":"brand_name"},"brand_contact_email":{"type":["string","null"],"description":"","example":"brand_contact_email"},"api_docs_url":{"type":["string","null"],"description":"","example":"api_docs_url"},"api_docs_via_email":{"type":"boolean","description":"","example":true},"flows":{"type":"array","minItems":1,"description":"The flows you need from this integration. For wms, one of: read_inventory, read_products, read_orders, read_inbounds, read_returns, read_warehouses, create_order, cancel_order, create_product, create_inbound, create_return. For cart and carrier, the action names that type supports. Pass \"not_sure\" if you do not know yet, and we will follow up. Call GET /integration-requests/flows for the current list.","example":["read_orders","read_inventory"],"items":{"type":"string","description":"","example":"flows"}},"prod_creds_url":{"type":["string","null"],"description":"","example":"prod_creds_url"},"sandbox_creds_url":{"type":["string","null"],"description":"","example":"sandbox_creds_url"},"notes":{"type":["string","null"],"description":"","example":"notes"}},"required":["flows","integration_name","integration_type"],"additionalProperties":false,"title":"IntegrationRequestBodySchema"},"WmsInventoryLedgerIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsInventoryLedgerIdsQueryParam"},"WmsInventoryLedgerCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryLedgerCreated_DateQueryParam"},"WmsInventoryLedgerUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryLedgerUpdated_DateQueryParam"},"WmsInventoryLedgerTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryLedgerTrackstar_Created_DateQueryParam"},"WmsInventoryLedgerTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryLedgerTrackstar_Updated_DateQueryParam"},"WmsInventoryLedgerWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInventoryLedgerWarehouse_Customer_IdQueryParam"},"WmsInventoryLedgerEvent_TypeQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["adjustment","return_receipt","inbound_receipt","order_shipment","supplier_return","movement","other"],"description":"","example":"inbound_receipt"},"neq":{"type":"string","enum":["adjustment","return_receipt","inbound_receipt","order_shipment","supplier_return","movement","other"],"description":"","example":"adjustment"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["adjustment","return_receipt","inbound_receipt","order_shipment","supplier_return","movement","other"],"description":"","example":"adjustment"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["adjustment","return_receipt","inbound_receipt","order_shipment","supplier_return","movement","other"],"description":"","example":"adjustment"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInventoryLedgerEvent_TypeQueryParam"},"WmsInventoryLedgerEntry_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2025-01-01T00:00:00Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInventoryLedgerEntry_DateQueryParam"},"WmsInventoryLedgerApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item.","example":"inv_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"entry_date":{"type":"string","format":"date-time","description":"The timestamp of the inventory ledger entry.","example":"2025-01-01T00:00:00Z"},"inventory_item_id":{"type":"string","description":"The unique ID of the inventory item.","example":"inventory_item_id"},"sku":{"type":"string","description":"The SKU of the inventory item.","example":"sku"},"quantity":{"type":"integer","description":"The quantity of the inventory item being added or removed.","example":1},"raw_event_type":{"type":["string","null"],"description":"The raw event that occurred resulting in the inventory ledger entry.","example":"receipt_into_system"},"event_type":{"type":"string","enum":["adjustment","return_receipt","inbound_receipt","order_shipment","supplier_return","movement","other"],"description":"The event that occurred resulting in the inventory ledger entry.","example":"inbound_receipt"},"reason":{"type":["string","null"],"description":"The reason for the inventory ledger entry.","example":"reason"},"object_id":{"type":["string","null"],"description":"The unique ID of the object that caused the inventory ledger entry.","example":"inbound_shipment_id"},"object_type":{"type":["string","null"],"enum":["order","inbound_shipment","return"],"description":"The type of object that caused the inventory ledger entry.","example":"inbound_shipment"},"warehouse_id":{"type":["string","null"],"description":"The unique ID of the source warehouse.","example":"source_warehouse_id"},"location_id":{"type":["string","null"],"description":"The unique ID of the source location.","example":"source_location_id"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","entry_date","event_type","id","inventory_item_id","location_id","object_id","object_type","quantity","raw_event_type","reason","sku","trackstar_created_date","trackstar_updated_date","updated_date","warehouse_id"],"additionalProperties":false,"title":"WmsInventoryLedgerApiItemSchema"},"WmsInventoryLedgerListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsInventoryLedgerApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsInventoryLedgerListEndpoint"},"WmsShippingMethodIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsShippingMethodIdsQueryParam"},"WmsShippingMethodCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsShippingMethodCreated_DateQueryParam"},"WmsShippingMethodUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsShippingMethodUpdated_DateQueryParam"},"WmsShippingMethodTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsShippingMethodTrackstar_Created_DateQueryParam"},"WmsShippingMethodTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsShippingMethodTrackstar_Updated_DateQueryParam"},"WmsShippingMethodApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the shipping method.","example":"shipping_method_id"},"created_date":{"type":"string","format":"date-time","description":"The date the shipping method was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the shipping method was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the shipping method.","example":"Priority Overnight"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier for the shipping method.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier for the shipping method.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code (SCAC) for the shipping method.","example":"FDXG"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","carrier_id","carrier_name","created_date","id","name","scac","trackstar_created_date","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"WmsShippingMethodApiItemSchema"},"WmsShippingMethodsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsShippingMethodApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsShippingMethodsListEndpoint"},"WmsInboundShipmentIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsInboundShipmentIdsQueryParam"},"WmsInboundShipmentCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentCreated_DateQueryParam"},"WmsInboundShipmentUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentUpdated_DateQueryParam"},"WmsInboundShipmentTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentTrackstar_Created_DateQueryParam"},"WmsInboundShipmentTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentTrackstar_Updated_DateQueryParam"},"WmsInboundShipmentTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"WmsInboundShipmentTrackstar_Tags_FlatQueryParam"},"WmsInboundShipmentStatusQueryParam":{"type":"object","properties":{"eq":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"open"},"neq":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"cancelled"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"cancelled"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"","example":"cancelled"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInboundShipmentStatusQueryParam"},"WmsInboundShipmentWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInboundShipmentWarehouse_Customer_IdQueryParam"},"WmsInboundShipmentWarehouse_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_id_1"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInboundShipmentWarehouse_IdQueryParam"},"WmsInboundShipmentExpected_Arrival_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2022-10-10T01:02:03Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentExpected_Arrival_DateQueryParam"},"WmsInboundShipmentPurchase_Order_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"PO123"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInboundShipmentPurchase_Order_NumberQueryParam"},"InboundShipmentSupplier":{"type":"object","properties":{"supplier_id":{"type":"string","description":"The ID of the supplier.","example":"supplier_id"},"supplier_name":{"type":["string","null"],"description":"The name of the supplier.","example":"supplier_name"}},"required":["supplier_id","supplier_name"],"additionalProperties":false,"title":"InboundShipmentSupplier"},"WmsInboundShipmentLineItem":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"Total quantity of the item expected to be received.","example":2},"received_quantity":{"type":"integer","description":"Total quantity of the item that has been received.","example":1},"unit_cost":{"type":["number","null"],"description":"The cost per product that is charged by the manufacturer.","example":1.0},"external_id":{"type":["string","null"],"description":"An identifier from an external system. e.g. vendor sku, external id, reference number, etc..","example":"external_sku"}},"required":["expected_quantity","external_id","inventory_item_id","received_quantity","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentLineItem"},"InboundReceiptLineItem":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"Total quantity of the item that has been received.","example":1},"lot_id":{"type":["string","null"],"description":"The ID of the lot the items belong to.","example":"lot_id"},"expiration_date":{"type":["string","null"],"format":"date-time","description":"The expiration date of the lot the items belong to.","example":"2022-10-10T01:02:03Z"}},"required":["expiration_date","inventory_item_id","lot_id","quantity","sku"],"additionalProperties":false,"title":"InboundReceiptLineItem"},"InboundReceipt":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the receiving event.","example":"receipt_id"},"arrived_date":{"type":"string","format":"date-time","description":"Date the items arrived.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the receiving event.","example":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-10-10T01:02:03Z"}],"items":{"$ref":"#/components/schemas/InboundReceiptLineItem"}}},"required":["arrived_date","id","line_items"],"additionalProperties":false,"title":"InboundReceipt"},"WmsInboundShipmentApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inbound shipment.","example":"inbound_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was last updated.","example":"2022-01-02T05:05:05Z"},"purchase_order_number":{"type":["string","null"],"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentSupplier"},{"type":"null"}]},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":["string","null"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":2,"received_quantity":1,"unit_cost":1.0,"external_id":"external_sku"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentLineItem"}},"receipts":{"type":"array","description":"List of receiving events associated with the inbound shipment.","example":[{"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"}]}],"items":{"$ref":"#/components/schemas/InboundReceipt"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddress"},"tracking_numbers":{"type":"array","description":"List of tracking numbers associated with the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inbound shipment in the external system (WMS/Freight etc).","example":"https://example.com/inboundshipment/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","expected_arrival_date","external_system_url","id","line_items","notes","purchase_order_number","raw_status","receipts","ship_from_address","status","supplier_object","tracking_numbers","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"WmsInboundShipmentApiItemSchema"},"WmsInboundShipmentsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsInboundShipmentApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsInboundShipmentsListEndpoint"},"CreateInboundShipmentResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inbound shipment.","example":"inbound_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was last updated.","example":"2022-01-02T05:05:05Z"},"purchase_order_number":{"type":["string","null"],"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentSupplier"},{"type":"null"}]},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":["string","null"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":2,"received_quantity":1,"unit_cost":1.0,"external_id":"external_sku"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentLineItem"}},"receipts":{"type":"array","description":"List of receiving events associated with the inbound shipment.","example":[],"items":{"$ref":"#/components/schemas/InboundReceipt"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddress"},"tracking_numbers":{"type":"array","description":"List of tracking numbers associated with the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inbound shipment in the external system (WMS/Freight etc).","example":"https://example.com/inboundshipment/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","expected_arrival_date","external_system_url","id","line_items","notes","purchase_order_number","raw_status","receipts","ship_from_address","status","supplier_object","tracking_numbers","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"CreateInboundShipmentResponseDataSchema"},"wmsCreateInboundShipmentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateInboundShipmentResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateInboundShipmentResponse"},"SupplierIdSchema":{"type":"object","properties":{"supplier_id":{"type":"string","description":"The ID of the supplier.","example":"supplier_id"}},"required":["supplier_id"],"additionalProperties":false,"title":"SupplierIdSchema"},"WmsInboundShipmentWriteLineItemsandbox":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":1}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemsandbox"},"CreatewmsInboundShipment--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_50601"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":1}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemsandbox"}}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","tracking_number","warehouse_id"],"additionalProperties":false,"title":"WMS Sandbox"},"WmsInboundShipmentWriteLineItemactive-ants":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemactive-ants"},"CreatewmsInboundShipment--Active__Ants--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemactive-ants"}}},"required":["expected_arrival_date","line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Active Ants"},"ShipFromAddressAdp":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"ShipFromAddressAdp"},"WmsInboundShipmentCreateLineItemadp":{"type":"object","properties":{"sku":{"type":"string","maxLength":48,"description":"SKU or product code","example":"sku"},"expected_quantity":{"type":"integer","description":"Expected quantity","example":0},"uom":{"type":"string","maxLength":3,"description":"Unit of measure","example":"CT"}},"required":["expected_quantity","sku","uom"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemadp"},"CreatewmsInboundShipment--A.__Duie__Pyle__-_ADP_---":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","maxLength":22,"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressAdp"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"carrier":{"type":"string","maxLength":30,"description":"Carrier name","example":"carrier"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"uom":"CT"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemadp"}}},"required":["line_items","purchase_order_number"],"additionalProperties":false,"title":"A. Duie Pyle (ADP)"},"WmsInboundShipmentCreateLineItemamphora":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemamphora"},"CreatewmsInboundShipment--Amphora--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemamphora"}}},"required":["expected_arrival_date","line_items","warehouse_id"],"additionalProperties":false,"title":"Amphora"},"WmsInboundShipmentCreateLineItemamplifier":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemamplifier"},"CreatewmsInboundShipment--Amplifier--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"account_user_id":{"type":"string","description":"GUID","example":"account_user_id"},"creating_user_id":{"type":"string","description":"GUID. May be the same as account_user_id.","example":"creating_user_id"},"supplier_user_id":{"type":"string","description":"GUID","example":"supplier_user_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemamplifier"}}},"required":["account_user_id","creating_user_id","expected_arrival_date","line_items","supplier_object","supplier_user_id"],"additionalProperties":false,"title":"Amplifier"},"WmsInboundShipmentWriteLineItemams":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemams"},"CreatewmsInboundShipment--AMS--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"container_number":{"type":"string","description":"The container number of incoming inventory.","example":"container_number"},"email":{"type":"string","description":"The email address to receive any errors and updates.","example":"receiving@client.com"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemams"}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number"},"client_code":{"type":"string","description":"The AMS-assigned client code the order should be created under.","example":"AB"}},"required":["client_code","container_number","expected_arrival_date","line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"AMS"},"WmsInboundShipmentWriteLineItembergen":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItembergen"},"ShipFromAddressBergen":{"type":"object","properties":{"company":{"type":"string","description":"","example":"Company"},"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","company","country","state"],"additionalProperties":false,"title":"ShipFromAddressBergen"},"CreatewmsInboundShipment--Bergen--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItembergen"}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"carrier_id":{"type":"string","description":"The carrier of the inbound shipment.","example":"UPS"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressBergen"}},"required":["carrier_id","line_items","ship_from_address","warehouse_id"],"additionalProperties":false,"title":"Bergen"},"WmsInboundShipmentCreateLineItembest-inc":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItembest-inc"},"CreatewmsInboundShipment--BEST__Inc.--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItembest-inc"}}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"BEST Inc."},"WmsInboundShipmentCreateLineItembigblue":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItembigblue"},"CreatewmsInboundShipment--Bigblue--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"carrier_name":{"type":"string","description":"Name of the carrier","example":"carrier"},"expected_box_count":{"type":"integer","description":"Number of boxes expected in the shipment","example":1},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItembigblue"}}},"required":["carrier_name","expected_arrival_date","expected_box_count","line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Bigblue"},"ShipFromAddressBluebox":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressBluebox"},"WmsInboundShipmentCreateLineItembluebox":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"The cost per product that is charged by the manufacturer","example":1.0}},"required":["expected_quantity","gtin","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItembluebox"},"CreatewmsInboundShipment--BlueBox__-_IDrive__Fulfillment_---":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressBluebox"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","gtin":"gtin","expected_quantity":0,"unit_cost":1.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItembluebox"}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"carton_count":{"type":"integer","description":"The number of cartons that are being shipped in the shipment","example":1}},"required":["line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"BlueBox (IDrive Fulfillment)"},"WmsInboundShipmentCreateLineItemboxzooka":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"external_id":{"type":"string","description":"","example":"external_id"},"lot_id":{"type":"string","description":"","example":"lot_id"},"expiration_date":{"type":"string","format":"date","description":"","example":"2023-03-15"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemboxzooka"},"CreatewmsInboundShipment--Boxzooka--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","pattern":"^[^/]*$","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"external_id":"external_id","lot_id":"lot_id","expiration_date":"2023-03-15"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemboxzooka"}}},"required":["line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Boxzooka"},"ShipFromAddressCamelot":{"type":"object","properties":{"full_name":{"type":"string","maxLength":30,"description":"","example":"John Doe"},"address1":{"type":"string","maxLength":30,"description":"","example":"123 Main St"},"address2":{"type":"string","maxLength":30,"description":"","example":"Apt 2"},"city":{"type":"string","maxLength":30,"description":"","example":"San Francisco"},"state":{"type":"string","maxLength":30,"description":"","example":"CA"},"postal_code":{"type":"string","maxLength":30,"description":"","example":"94105"},"country":{"type":"string","maxLength":30,"description":"","example":"United States"}},"required":["address1","city","country","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressCamelot"},"WmsInboundShipmentWriteLineItemcamelot":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemcamelot"},"CreatewmsInboundShipment--Camelot--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","maxLength":30,"description":"","example":"purchase_order_number"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressCamelot"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemcamelot"}}},"required":["line_items","purchase_order_number","ship_from_address"],"additionalProperties":false,"title":"Camelot"},"WmsInboundShipmentWriteLineItemcanary":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemcanary"},"CreatewmsInboundShipment--Canary7--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemcanary"}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_customer_id":{"type":["string","null"],"default":"N/A - Connect an account to see options","enum":["N/A - Connect an account to see options"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Canary7"},"WmsInboundShipmentWriteLineItemcapacity":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemcapacity"},"CreatewmsInboundShipment--Capacity--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemcapacity"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"Capacity"},"WmsInboundShipmentCreateLineItemcarton-cloud":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemcarton-cloud"},"CreatewmsInboundShipment--CartonCloud--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Expected arrival date (YYYY-MM-DD)","example":"2023-03-15T13:45:30Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemcarton-cloud"}}},"required":["line_items","purchase_order_number","warehouse_customer_id"],"additionalProperties":false,"title":"CartonCloud"},"WmsInboundShipmentCreateLineItemclarus":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"The Clarus product id. Use this or `sku`.","example":"108"},"sku":{"type":"string","description":"The product SKU. Use this or `inventory_item_id`. Must match exactly one Clarus product.","example":"40116"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"lot":{"type":"string","description":"","example":"lot"},"storage_unit_quantity":{"type":"integer","minimum":1,"description":"","example":0}},"required":["expected_quantity"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemclarus"},"CreatewmsInboundShipment--Clarus--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"warehouse_location_id":{"type":"string","description":"ID of the receiving warehouse location.","example":"warehouse_location_id"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"108","sku":"40116","expected_quantity":0,"lot":"lot","storage_unit_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemclarus"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"required":["line_items","purchase_order_number","warehouse_id","warehouse_location_id"],"additionalProperties":false,"title":"Clarus"},"WmsInboundShipmentWriteLineItemcontrolport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemcontrolport"},"CreatewmsInboundShipment--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemcontrolport"}}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"WmsInboundShipmentWriteLineItemdcl":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemdcl"},"CreatewmsInboundShipment--DCL--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","enum":["FR","LA","LN","YK","EX","EU","KY"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"EU"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemdcl"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"DCL"},"WmsInboundShipmentCreateLineItemdear-systems":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemdear-systems"},"CreatewmsInboundShipment--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"approach":{"type":"string","enum":["STOCK","INVOICE"],"description":"How you want to process the incoming order. Either authorize the stock first, or pay the invoice first.","example":"INVOICE"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemdear-systems"}}},"required":["approach","line_items","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"WmsInboundShipmentCreateLineItemdeposco":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"received_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0},"inbound_lpn":{"type":"string","description":"","example":"inbound_lpn"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemdeposco"},"CreatewmsInboundShipment--Deposco--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"received_quantity":0,"unit_cost":0.0,"inbound_lpn":"inbound_lpn"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemdeposco"}},"order_source":{"type":"string","description":"Name of the external system from which the inbound originated.","example":"my_system"},"custom_attribute_1":{"type":"string","description":"Custom attribute 1","example":"Custom attribute 1"}},"required":["line_items","purchase_order_number"],"additionalProperties":false,"title":"Deposco"},"WmsInboundShipmentWriteLineItemdistribution-management":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemdistribution-management"},"CreatewmsInboundShipment--Distribution__Management--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemdistribution-management"}}},"required":["line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Distribution Management"},"WmsInboundShipmentWriteLineItemdotcom-distribution":{"type":"object","properties":{"sku":{"type":"string","maxLength":20,"description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemdotcom-distribution"},"CreatewmsInboundShipment--Dotcom__Distribution--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","maxLength":20,"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemdotcom-distribution"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"Dotcom Distribution"},"WmsInboundShipmentCreateLineItemeshipping":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"lot_number":{"type":["string","null"],"description":"","example":"lot_number"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemeshipping"},"CreatewmsInboundShipment--eShipping--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"Facility code to receive into","example":"warehouse_id"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"lot_number":"lot_number"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemeshipping"}},"reference":{"type":"string","description":"Reference number for the inbound shipment.","example":"reference"}},"required":["line_items","purchase_order_number","reference","warehouse_id"],"additionalProperties":false,"title":"eShipping"},"WmsInboundShipmentCreateLineItemevolve":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemevolve"},"CreatewmsInboundShipment--Evolve--":{"type":"object","properties":{"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":{}},"container":{"type":"string","description":"Container identifier.","example":"CONT-98765"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemevolve"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"Evolve"},"WmsInboundShipmentCreateLineItemextensiv-3pl-central":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"external_id":{"type":["string","null"],"description":"","example":"external_id"},"warehouse_location_id":{"type":["string","null"],"description":"","example":"warehouse_location_id"},"lot_number":{"type":["string","null"],"description":"","example":"lot_number"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemextensiv-3pl-central"},"CreatewmsInboundShipment--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"external_id":"external_id","warehouse_location_id":"warehouse_location_id","lot_number":"lot_number"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemextensiv-3pl-central"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"required":["line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"WmsInboundShipmentCreateLineItemfinale":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemfinale"},"CreatewmsInboundShipment--Finale--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemfinale"}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Finale"},"ShipFromAddressFlexport":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressFlexport"},"WmsInboundShipmentWriteLineItemflexport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemflexport"},"CreatewmsInboundShipment--Flexport__-_Deliverr_---":{"type":"object","properties":{"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":{}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressFlexport"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemflexport"}}},"required":["line_items","ship_from_address"],"additionalProperties":false,"title":"Flexport (Deliverr)"},"ShipFromAddressFlowspace":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","company","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressFlowspace"},"WmsInboundShipmentCreateLineItemflowspace":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemflowspace"},"CreatewmsInboundShipment--Flowspace--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressFlowspace"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemflowspace"}},"tracking_numbers":{"type":"array","description":"Tracking numbers for the inbound parcels","example":["tracking_number_1"],"items":{"type":"string","description":"Tracking number","example":"tracking_numbers"}},"needs_transportation":{"type":"string","description":"Whether Flowspace should arrange transportation (default: false)","example":"needs_transportation"},"product_arrival_type":{"type":"string","enum":["palletized","parcel_shipment","20_ft_container","40_ft_container","40_ft_hc_container","45_ft_hc_container"],"description":"How the product is arriving at the warehouse. Defaults to parcel_shipment","example":"20_ft_container"},"carrier_id":{"type":"string","description":"Carrier performing the delivery (required if needs_transportation is true)","example":"carrier_id"}},"required":["line_items","purchase_order_number","ship_from_address","warehouse_id"],"additionalProperties":false,"title":"Flowspace"},"FulfillorInboundShipFromAddressFulfillor":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"+14045551212"}},"required":["address1","city","country","phone_number","postal_code","state"],"additionalProperties":false,"title":"FulfillorInboundShipFromAddressFulfillor"},"WmsInboundShipmentWriteLineItemfulfillor":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemfulfillor"},"CreatewmsInboundShipment--Fulfillor--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"carrier_id":{"type":"string","description":"Shipping carrier code (e.g. OTHER, FEDEX, UPS).","example":"OTHER"},"shipping_method_id":{"type":"string","description":"Shipping method code (e.g. ShMthFTL, ShMthGround).","example":"ShMthFTL"},"ship_from_address":{"$ref":"#/components/schemas/FulfillorInboundShipFromAddressFulfillor"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemfulfillor"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["carrier_id","line_items","purchase_order_number","ship_from_address","shipping_method_id","warehouse_id"],"additionalProperties":false,"title":"Fulfillor"},"WmsInboundShipmentWriteLineItemfulfilmentcrowd":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemfulfilmentcrowd"},"CreatewmsInboundShipment--fulfilmentcrowd--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"currency_code":{"type":"string","default":"USD","enum":["USD"],"description":"The currency used for this inbound shipment. If not provided explicitly, defaults to USD.","example":"USD"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemfulfilmentcrowd"}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"fulfilmentcrowd"},"WmsInboundShipmentWriteLineItemg-global":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemg-global"},"CreatewmsInboundShipment--G__Global--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemg-global"}},"transportation_document":{"type":"string","description":"transportation_document","example":"transportation_document"},"ship_date":{"type":"string","format":"date-time","description":"ship_date","example":"2022-10-10T01:02:03Z"},"container":{"type":"string","description":"container","example":"container"},"custom_fields":{"type":"array","description":"List of the custom fields","example":[{"name":"CustomField","value":"CustomValue"}],"items":{"$ref":"#/components/schemas/CustomField"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"G Global"},"WmsInboundShipmentCreateLineItemgobolt":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemgobolt"},"CreatewmsInboundShipment--GoBolt--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"shipment_type":{"type":"string","default":"parcel","enum":["parcel","pallet","floor_loaded","container","drop_off"],"description":"The shipment type for your inbound, defaults to parcel","example":"parcel"},"box_packing_option":{"type":"string","default":"multiple_sku_per_box","enum":["one_sku_per_box","multiple_sku_per_box"],"description":"Box packing option, defaults to multiple_sku_per_box","example":"multiple_sku_per_box"},"box_expected_quantity":{"type":"integer","default":1,"description":"Expected number of boxes, defaults to 1","example":0},"pallet_packing_option":{"type":"string","default":"multiple_sku_per_pallet","enum":["one_sku_per_pallet","multiple_sku_per_pallet"],"description":"Pallet packing option, defaults to multiple_sku_per_pallet if shipment_type is pallet","example":"multiple_sku_per_pallet"},"container_size":{"type":"string","enum":["20_ft","40_ft"],"description":"Container size, required for container shipments","example":"20_ft"},"pallet_expected_quantity":{"type":"integer","default":1,"description":"Expected number of pallets, defaults to 1 if shipment_type is pallet","example":0},"reference_number":{"type":"string","description":"","example":"reference_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemgobolt"}}},"required":["expected_arrival_date","line_items","warehouse_id"],"additionalProperties":false,"title":"GoBolt"},"ShipFromAddressGreenmark":{"type":"object","properties":{"address1":{"type":"string","description":"","example":"123 Main St"},"city":{"type":"string","description":"","example":"San Francisco"},"postal_code":{"type":"string","description":"","example":"94105"},"country":{"type":"string","description":"","example":"United States"}},"required":["address1","city","country","postal_code"],"additionalProperties":false,"title":"ShipFromAddressGreenmark"},"WmsInboundShipmentWriteLineItemgreenmark":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemgreenmark"},"CreatewmsInboundShipment--Greenmark__Logistics--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressGreenmark"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemgreenmark"}}},"required":["expected_arrival_date","line_items","purchase_order_number","ship_from_address","supplier_object"],"additionalProperties":false,"title":"Greenmark Logistics"},"WmsInboundShipmentCreateLineItemhelm-wms":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemhelm-wms"},"CreatewmsInboundShipment--Helm__WMS--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemhelm-wms"}}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"Helm WMS"},"WmsInboundShipmentCreateLineItemhive":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"","example":"inventory_item_id"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","inventory_item_id"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemhive"},"CreatewmsInboundShipment--Hive--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"delivery_option":{"type":"string","enum":["courier","dropoff","hive_freight","postal"],"description":"Delivery method for the shipment","example":"courier"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"inventory_item_id","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemhive"}}},"required":["delivery_option","expected_arrival_date","line_items","warehouse_id"],"additionalProperties":false,"title":"Hive"},"WmsInboundShipmentCreateLineItemi-fulfilment":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemi-fulfilment"},"CreatewmsInboundShipment--I-Fulfilment--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"channel_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The product channel for the purchase order.","example":"channel_id"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"currency_code":{"type":"string","default":"USD","pattern":"^[A-Z]{3}$","description":"Currency code.","example":"USD"},"shipping_method":{"type":"string","enum":["air","sea","road"],"description":"Method of shipment travel.","example":"air"},"expected_delivery_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"expected_pallets":{"type":"integer","minimum":0,"description":"Expected number of pallets.","example":0},"expected_cartons":{"type":"integer","minimum":0,"description":"Expected number of cartons.","example":0},"shipping_company":{"type":"string","description":"Shipping company name.","example":"shipping_company"},"tracking_number":{"type":"string","description":"Tracking number.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemi-fulfilment"}}},"required":["channel_id","expected_cartons","expected_delivery_date","expected_pallets","line_items","shipping_method","supplier_object","warehouse_id"],"additionalProperties":false,"title":"I-Fulfilment"},"WmsInboundShipmentWriteLineItemicreate":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"The unique ID of the inventory item.","example":"inventory_item_id"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"carrier":{"type":"string","description":"The carrier of the shipment.","example":"carrier"}},"required":["carrier","expected_quantity","inventory_item_id","tracking_number","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemicreate"},"CreatewmsInboundShipment--iCreate--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"ordered_by":{"type":"string","description":"The name of the person who ordered the shipment.","example":"ordered_by"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"inventory_item_id","expected_quantity":0,"unit_cost":0.0,"tracking_number":"tracking_number","carrier":"carrier"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemicreate"}}},"required":["expected_arrival_date","line_items","ordered_by","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"iCreate"},"WmsInboundShipmentCreateLineIteminfoplus":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineIteminfoplus"},"CreatewmsInboundShipment--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"type":{"type":"string","enum":["Kit","Normal","Transfer"],"description":"Type of inbound shipment","example":"Kit"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineIteminfoplus"}}},"required":["line_items","purchase_order_number","supplier_object","type","warehouse_id"],"additionalProperties":false,"title":"Infoplus"},"ShipFromAddressJas":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressJas"},"WmsInboundShipmentWriteLineItemjas":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemjas"},"CreatewmsInboundShipment--JAS--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressJas"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemjas"}}},"required":["line_items","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"JAS"},"WmsInboundShipmentCreateLineItemjazz-central":{"type":"object","properties":{"sku":{"type":"string","description":"sku","example":"sku"},"expected_quantity":{"type":"integer","description":"The expected quantity of the product.","example":1}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemjazz-central"},"CreatewmsInboundShipment--Cart.com__-_Jazz__Central_---":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"reference_number":{"type":"string","description":"","example":"reference_number"},"shipped_date":{"type":"string","format":"date-time","description":"The date the shipment was sent by the supplier.","example":"2023-03-15T13:45:30Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":1}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemjazz-central"}}},"required":["expected_arrival_date","line_items","warehouse_id"],"additionalProperties":false,"title":"Cart.com (Jazz Central)"},"WmsInboundShipmentWriteLineItemleanware":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemleanware"},"CreatewmsInboundShipment--Leanware--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemleanware"}}},"required":["line_items","purchase_order_number"],"additionalProperties":false,"title":"Leanware"},"ShipFromAddressLineage":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressLineage"},"ShipToAddressLineage":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressLineage"},"WmsInboundShipmentCreateLineItemlineage":{"type":"object","properties":{"sku":{"type":"string","description":"Vendor item code (SKU).","example":"sku"},"expected_quantity":{"type":"integer","description":"Expected quantity.","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemlineage"},"CreatewmsInboundShipment--Lineage--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","maxLength":16,"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the Lineage warehouse receiving the shipment.","example":"warehouse_id"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressLineage"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressLineage"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemlineage"}}},"required":["line_items","purchase_order_number","ship_from_address","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Lineage"},"WmsInboundShipmentWriteLineItem":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItem"},"CreatewmsInboundShipment--Linnworks--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItem"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"Linnworks"},"InboundShipToAddressLogicpod":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"}},"required":["address1","city","country","email_address","full_name","postal_code","state"],"additionalProperties":false,"title":"InboundShipToAddressLogicpod"},"WmsInboundShipmentCreateLineItemlogicpod":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemlogicpod"},"CreatewmsInboundShipment--Quickbox__-_LogicPod_---":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"ship_to_address":{"$ref":"#/components/schemas/InboundShipToAddressLogicpod"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemlogicpod"}},"created_by":{"type":"string","description":"Who created this inbound","example":"created_by"}},"required":["created_by","expected_arrival_date","line_items","purchase_order_number","ship_to_address","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Quickbox (LogicPod)"},"WmsInboundShipmentWriteLineItemlogiwa":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"uom":{"type":"string","default":"Unit","description":"The pack type (unit of measure) for the item, as defined in Logiwa. Defaults to 'Unit'.","example":"Unit"},"location_code":{"type":"string","description":"The location code for the item","example":"location_code"},"license_plate_code":{"type":"string","description":"The license plate code for the item","example":"license_plate_code"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemlogiwa"},"CreatewmsInboundShipment--Logiwa--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"uom":"Unit","location_code":"location_code","license_plate_code":"license_plate_code"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemlogiwa"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"inbound_type":{"type":"string","default":"Purchase Order","description":"The type of inbound shipment. Defaults to 'Purchase Order'.","example":"Purchase Order"}},"required":["line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Logiwa"},"WmsInboundShipmentCreateLineItemlogiwa-io":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"pack_type":{"type":"string","description":"The pack type of the line item (default: Each)","example":"Each"},"lot_number":{"type":["string","null"],"description":"Lot/batch number for the items.","example":"lot_number"},"expiration_date":{"type":["string","null"],"description":"Expiration date for the lot in ISO format.","example":"expiration_date"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemlogiwa-io"},"CreatewmsInboundShipment--Logiwa__IO--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_type":{"type":"string","description":"","example":"purchase_order_type"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"pack_type":"Each","lot_number":"lot_number","expiration_date":"expiration_date"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemlogiwa-io"}}},"required":["line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Logiwa IO"},"WmsInboundShipmentCreateLineItemluminous":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_price":{"type":"number","minimum":0.0,"description":"Cost per unit. When omitted, the product's own cost is used.","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemluminous"},"CreatewmsInboundShipment--Luminous--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemluminous"}}},"required":["line_items","supplier_object"],"additionalProperties":false,"title":"Luminous"},"WmsInboundShipmentWriteLineItemluxroutage":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemluxroutage"},"CreatewmsInboundShipment--Luxroutage__LRI--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemluxroutage"}}},"required":["line_items","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"Luxroutage LRI"},"ShipFromAddressMainfreight":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"ShipFromAddressMainfreight"},"WmsInboundShipmentCreateLineItemmainfreight":{"type":"object","properties":{"sku":{"type":"string","description":"Warehouse stock code","example":"SKU123"},"expected_quantity":{"type":"integer","description":"Expected quantity","example":1},"expiration_date":{"type":"string","format":"date-time","description":"Expiration date for the line in ISO 8601 format.","example":"2022-10-10T01:02:03Z"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemmainfreight"},"CreatewmsInboundShipment--Mainfreight--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressMainfreight"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"SKU123","expected_quantity":1,"expiration_date":"2022-10-10T01:02:03Z"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemmainfreight"}}},"required":["expected_arrival_date","line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Mainfreight"},"WmsInboundShipmentCreateLineItemmasonhub":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"box_ids":{"type":"array","description":"List of box IDs associated with the line item. Not required.","items":{"type":"string","description":"Box ID","example":"box_1"}}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemmasonhub"},"CreatewmsInboundShipment--MasonHub--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"box_ids":null}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemmasonhub"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"comments":{"type":"string","description":"Free-form comments about the inbound shipment.","example":"These shipments are often not labeled."},"box_ids":{"type":"array","description":"List of box IDs associated with the inbound shipment.","example":["box_1","box_2"],"items":{"type":"string","description":"Box ID","example":"box_1"}},"customer_identifier":{"type":"string","description":"Customer-supplied identifier for the inbound shipment. If omitted, one is generated.","example":"shipment32432"}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"MasonHub"},"WmsInboundShipmentWriteLineItemmintsoft":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemmintsoft"},"CreatewmsInboundShipment--Mintsoft--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"quantity":{"type":"integer","description":"","example":0},"package_type":{"type":"string","enum":["Carton","TwentyFtContainer","Pallet","FortyFtContainer","FortyFtContainerHC","FortyFiveFtContainer","FortyFiveFtContainerHC"],"description":"The type of package that the shipment is in","example":"Carton"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemmintsoft"}}},"required":["expected_arrival_date","line_items","package_type","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Mintsoft"},"ShipFromAddressModa-Express":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"ShipFromAddressModa-Express"},"WmsInboundShipmentCreateLineItemmoda-express":{"type":"object","properties":{"sku":{"type":"string","description":"Item identifier as it appears in the Datex material master.","example":"SKU123"},"expected_quantity":{"type":"integer","minimum":1,"description":"Quantity expected for this line.","example":1},"unit_cost":{"type":"number","minimum":0.0,"description":"Cost per unit charged by the vendor.","example":1.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemmoda-express"},"CreatewmsInboundShipment--Moda__Express--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressModa-Express"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"SKU123","expected_quantity":1,"unit_cost":1.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemmoda-express"}}},"required":["expected_arrival_date","line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Moda Express"},"WmsInboundShipmentWriteLineItemmonta":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemmonta"},"CreatewmsInboundShipment--Monta--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemmonta"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"Monta"},"WmsInboundShipmentWriteLineItemnimble":{"type":"object","properties":{"sku":{"type":"string","description":"Required","example":"sku"},"vendor_sku":{"type":"string","description":"Vendor SKU","example":"TA30144X01MC"},"expected_quantity":{"type":"integer","description":"Expected quantity","example":1}},"required":["expected_quantity"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemnimble"},"CreatewmsInboundShipment--Nimble--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","vendor_sku":"TA30144X01MC","expected_quantity":1}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemnimble"}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_first_name":{"type":"string","description":"Supplier first name","example":"John"},"supplier_last_name":{"type":"string","description":"Supplier last name","example":"Doe"},"supplier_city":{"type":"string","description":"Supplier city","example":"San Francisco"},"supplier_state":{"type":"string","description":"Supplier state","example":"CA"},"supplier_country":{"type":"string","description":"Supplier country","example":"US"},"supplier_phone":{"type":"string","description":"Supplier phone","example":"1234567890"},"supplier_street_line1":{"type":"string","description":"Supplier street line 1","example":"123 Main St"},"supplier_street_line2":{"type":"string","description":"Supplier street line 2","example":"Apt 1"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"reference_id":{"type":"string","description":"Reference ID","example":"123456789"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Nimble"},"WmsInboundShipmentWriteLineItemnlrp":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemnlrp"},"CreatewmsInboundShipment--NLRP--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"terms":{"type":"string","description":"","example":"Prepaid"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemnlrp"}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","terms"],"additionalProperties":false,"title":"NLRP"},"WmsInboundShipmentWriteLineItemnpfulfilment":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"lot_id":{"type":"string","description":"The batch / lot number for this line. Only accepted for clients npf has activated batch and expiry tracking for.","example":"batch_01"},"expiration_date":{"type":"string","format":"date","description":"The expiration date for this line's batch.","example":"2029-12-31"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemnpfulfilment"},"ShipFromAddressNpfulfilment":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number of the supplier contact.","example":"555-555-5555"}},"required":["city","country","state"],"additionalProperties":false,"title":"ShipFromAddressNpfulfilment"},"CreatewmsInboundShipment--NPFulfilment--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"lot_id":"batch_01","expiration_date":"2029-12-31"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemnpfulfilment"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressNpfulfilment"},"delivery_type":{"type":"integer","default":2,"enum":[1,2,3,4,5],"description":"npf's delivery mode code. 1/3/5 need pallet_type and number_of_pallets; 2/4 are loose cartons with no pallet detail. Defaults to 2 (loose cartons).","example":2},"pallet_type":{"type":"string","enum":["C","H","L"],"description":"Pallet type. Required when delivery_type is 1, 3, or 5.","example":"C"},"number_of_pallets":{"type":"integer","default":0,"minimum":0,"description":"Number of pallets. Required when delivery_type is 1, 3, or 5; 0 for loose cartons.","example":2},"vessel_number":{"type":"string","description":"Vessel MMSI number, for shipments arriving by sea.","example":"123456789"}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"NPFulfilment"},"WmsInboundShipmentWriteLineItemnri":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemnri"},"CreatewmsInboundShipment--NRI--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemnri"}},"country_code":{"type":"string","description":"Country code of origin for the shipment.","example":"country_code"},"client_reference_number_2":{"type":"string","description":"Optional internal ID for the inbound shipment.","example":"client_reference_number_2"}},"required":["country_code","expected_arrival_date","line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"NRI"},"WmsInboundShipmentWriteLineItemoia-global":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemoia-global"},"ShipFromAddressOia-Global":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"The phone number of the contact at the ship from address.","example":"555-555-5555"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressOia-Global"},"CreatewmsInboundShipment--OIA__Global--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemoia-global"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressOia-Global"}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"OIA Global"},"WmsInboundShipmentCreateLineItemongoing":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemongoing"},"CreatewmsInboundShipment--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemongoing"}}},"required":["line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Ongoing WMS"},"WmsInboundShipmentWriteLineItemorderwise":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemorderwise"},"CreatewmsInboundShipment--OrderWise--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"purchase_order_number":{"type":"string","maxLength":30,"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemorderwise"}}},"required":["line_items","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"OrderWise"},"WmsInboundShipmentCreateLineItempackiyo":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItempackiyo"},"CreatewmsInboundShipment--Packiyo--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItempackiyo"}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Packiyo"},"WmsInboundShipmentCreateLineItempattern":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItempattern"},"CreatewmsInboundShipment--Pattern--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItempattern"}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Pattern"},"WmsInboundShipmentWriteLineItempeoplevox":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItempeoplevox"},"CreatewmsInboundShipment--Peoplevox--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItempeoplevox"}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"}},"required":["line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Peoplevox"},"WmsInboundShipmentWriteLineItempicqer":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItempicqer"},"CreatewmsInboundShipment--Picqer--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItempicqer"}}},"required":["expected_arrival_date","line_items","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Picqer"},"WmsInboundShipmentWriteLineItempostnord":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"external_id":{"type":"string","description":"","example":"external_id"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItempostnord"},"CreatewmsInboundShipment--PostNord--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"external_id":"external_id"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItempostnord"}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"}},"required":["line_items","purchase_order_number"],"additionalProperties":false,"title":"PostNord"},"WmsInboundShipmentWriteLineItempulpo":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItempulpo"},"CreatewmsInboundShipment--Pulpo__WMS--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItempulpo"}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"}},"required":["expected_arrival_date","line_items","purchase_order_number","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"Pulpo WMS"},"WmsInboundShipmentLineItemquiet":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0},"description":{"type":"string","description":"","example":"description"}},"required":["description","expected_quantity","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentLineItemquiet"},"CreatewmsInboundShipment--Quiet__Platforms--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0,"description":"description"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentLineItemquiet"}},"note":{"type":"string","description":"","example":"note"}},"required":["line_items","note","purchase_order_number","tracking_number","warehouse_id"],"additionalProperties":false,"title":"Quiet Platforms"},"ShipFromAddressRjw":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressRjw"},"ShipToAddressRjw":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipToAddressRjw"},"WmsInboundShipmentCreateLineItemrjw":{"type":"object","properties":{"sku":{"type":"string","description":"Vendor item code (SKU).","example":"sku"},"expected_quantity":{"type":"integer","description":"Expected quantity.","example":0},"lot_number":{"type":"string","description":"Lot number; emitted as the W04*LT qualifier. Defaults to NONE.","example":"lot_number"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemrjw"},"CreatewmsInboundShipment--RJW--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the RJW warehouse receiving the shipment.","example":"warehouse_id"},"carrier_scac":{"type":"string","description":"Carrier SCAC code; defaults to RJWI when omitted.","example":"carrier_scac"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressRjw"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressRjw"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"lot_number":"lot_number"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemrjw"}}},"required":["line_items","purchase_order_number","ship_from_address","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"RJW"},"WmsInboundShipmentWriteLineItemrs-logistics":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_cost":{"type":"number","minimum":0.0,"description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemrs-logistics"},"CreatewmsInboundShipment--R_AMP_S__Logistics--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemrs-logistics"}}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"R&S Logistics"},"WmsInboundShipmentWriteLineItemsalesupply":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemsalesupply"},"CreateInboundShipmentShipToAddressSalesupply":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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":["city","country","postal_code"],"additionalProperties":false,"title":"CreateInboundShipmentShipToAddressSalesupply"},"CreateInboundShipmentBillToAddressSalesupply":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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":["city","country","postal_code"],"additionalProperties":false,"title":"CreateInboundShipmentBillToAddressSalesupply"},"CreatewmsInboundShipment--Salesupply--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","default":"N/A - Connect an account to see options","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemsalesupply"}},"ship_to_address":{"$ref":"#/components/schemas/CreateInboundShipmentShipToAddressSalesupply"},"bill_to_address":{"$ref":"#/components/schemas/CreateInboundShipmentBillToAddressSalesupply"},"invoice_currency_code":{"type":"string","default":"USD","enum":["USD"],"description":"Currency code for the purchase order","example":"USD"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"required":["bill_to_address","expected_arrival_date","line_items","notes","purchase_order_number","ship_to_address"],"additionalProperties":false,"title":"Salesupply"},"WmsInboundShipmentWriteLineItemshipbob":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"","example":"inventory_item_id"},"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"lot_id":{"type":"string","description":"Lot number of the items in the box","example":"lot_id"},"lot_expiration_date":{"type":"string","format":"date-time","description":"Lot expiration date for the items in the box","example":"2023-03-15T13:45:30Z"}},"required":["expected_quantity"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemshipbob"},"Box":{"type":"object","properties":{"tracking_number":{"type":"string","description":"Tracking number of the box","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","expected_quantity":0,"lot_id":"lot_id","lot_expiration_date":"2023-03-15T13:45:30Z"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemshipbob"}}},"required":["line_items","tracking_number"],"additionalProperties":false,"title":"Box"},"CreatewmsInboundShipment--ShipBob--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.. ShipBob may reroute this to a regional Hub before going to the specified warehouse.","example":"warehouse_id123"},"package_type":{"type":"string","enum":["Package","Pallet","FloorLoadedContainer"],"description":"Type of package","example":"FloorLoadedContainer"},"box_packaging_type":{"type":"string","enum":["EverythingInOneBox","OneSkuPerBox","MultipleSkusPerBox"],"description":"Type of packaging for the boxes","example":"EverythingInOneBox"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"boxes":{"type":"array","description":"List of boxes in the shipment","items":{"$ref":"#/components/schemas/Box"}}},"required":["box_packaging_type","boxes","expected_arrival_date","package_type","warehouse_id"],"additionalProperties":false,"title":"ShipBob"},"WmsInboundShipmentWriteLineItemshipedge":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemshipedge"},"CreatewmsInboundShipment--Shipedge--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemshipedge"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"Shipedge"},"WmsInboundShipmentWriteLineItemshipfusion":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemshipfusion"},"CreatewmsInboundShipment--Shipfusion--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemshipfusion"}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Shipfusion"},"WmsInboundShipmentCreateLineItemshiphero":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"The number of units expected to be received","example":1},"expected_weight":{"type":"number","description":"Expected weight","example":1.0},"expected_weight_unit":{"type":"string","enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the line item.","example":"lb"},"unit_cost":{"type":"number","description":"Cost of the product (USD).","example":1.0},"external_id":{"type":["string","null"],"default":null,"description":"The external ID of the product. Only applied if supplier is provided","example":"external_id"}},"required":["expected_quantity","expected_weight","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemshiphero"},"CreatewmsInboundShipment--ShipHero--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Use this when you are a 3PL acting on behalf of one of your customers.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"shipping_price":{"type":"number","description":"Price of the shipment.","example":0.0},"tax":{"type":"number","description":"Tax on the purchase order.","example":0.0},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":1,"expected_weight":1.0,"expected_weight_unit":"lb","unit_cost":1.0,"external_id":"external_id"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemshiphero"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"packing_note":{"type":"string","description":"Packing note","example":"packing_note"}},"required":["expected_arrival_date","line_items","purchase_order_number","shipping_price","warehouse_id"],"additionalProperties":false,"title":"ShipHero"},"WmsInboundShipmentCreateLineItemshipmonk":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":["integer","null"],"description":"","example":0},"lot_id":{"type":"string","description":"Lot number of the items in the box.","example":"lot_id"},"lot_expiration_date":{"type":"string","format":"date-time","description":"Lot expiration date for the items in the box.","example":"2023-03-15T13:45:30Z"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemshipmonk"},"CreatewmsInboundShipment--ShipMonk--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"handling_unit_type":{"type":"string","enum":["small_boxes","single_sku_pallet","mixed_sku_pallet","container_20_palletized","container_20_non_palletized","container_40_palletized","container_40_non_palletized","container_53_palletized","container_53_non_palletized","unknown"],"description":"Unit handling type for inbound shipment.","example":"container_20_non_palletized"},"handling_unit_quantity":{"type":"integer","description":"Number of handling units.","example":0},"bol_number":{"type":"string","description":"Bill of lading number for the inbound shipment.","example":"bol_number"},"category":{"type":"string","enum":["purchase_order_asn","inventory_transfer","wholesale_order_return","special_projects","subscription_box_receiving","bonded_inventory","package_forwarding"],"description":"ShipMonk receiving category for the inbound shipment.","example":"bonded_inventory"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"tracking_numbers":{"type":"array","description":"Tracking numbers for the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"lot_id":"lot_id","lot_expiration_date":"2023-03-15T13:45:30Z"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemshipmonk"}}},"required":["expected_arrival_date","handling_unit_quantity","handling_unit_type","supplier_object","warehouse_id"],"additionalProperties":false,"title":"ShipMonk"},"WmsInboundShipmentCreateLineItemshipping-tree":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemshipping-tree"},"CreatewmsInboundShipment--ShippingTree--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemshipping-tree"}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["expected_arrival_date","line_items","supplier_object","tracking_number"],"additionalProperties":false,"title":"ShippingTree"},"WmsInboundShipmentWriteLineItemshippingbo":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemshippingbo"},"CreatewmsInboundShipment--Shippingbo--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemshippingbo"}}},"required":["line_items","purchase_order_number","supplier_object"],"additionalProperties":false,"title":"Shippingbo"},"WmsInboundShipmentCreateLineItemshipstream":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemshipstream"},"CreatewmsInboundShipment--ShipStream--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemshipstream"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["expected_arrival_date","line_items","status","supplier_object","warehouse_id"],"additionalProperties":false,"title":"ShipStream"},"WmsInboundShipmentWriteLineItemshipwire":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemshipwire"},"ShipFromAddressShipwire":{"type":"object","properties":{"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","address2","city","country","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressShipwire"},"CreatewmsInboundShipment--Shipwire--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2024-01-01"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemshipwire"}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"arrangement_type":{"type":"string","default":"none","enum":["none","overseas"],"description":"This tells ShipWire what further actions to take once the ASN is created.","example":"none"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressShipwire"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Shipwire"},"WmsInboundShipmentWriteLineItemskulabs":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemskulabs"},"CreatewmsInboundShipment--Skulabs--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"store_id":{"type":"string","description":"","example":"store_id"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemskulabs"}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"total_tax":{"type":"number","description":"Total tax on the purchase order.","example":0.0},"total_shipping":{"type":"number","description":"Total shipping cost on the purchase order.","example":0.0},"total_discount":{"type":"number","description":"Total discount on the purchase order.","example":0.0}},"required":["line_items","store_id","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Skulabs"},"WmsInboundShipmentWriteLineItemskusavvy":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemskusavvy"},"CreatewmsInboundShipment--SKUSavvy--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemskusavvy"}}},"required":["line_items","supplier_object","warehouse_id"],"additionalProperties":false,"title":"SKUSavvy"},"WmsInboundShipmentCreateLineItemskuvault":{"type":"object","properties":{"sku":{"type":"string","description":"If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU.","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemskuvault"},"CreatewmsInboundShipment--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemskuvault"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["line_items","supplier_object"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"WmsInboundShipmentWriteLineItemsmart-warehousing":{"type":"object","properties":{"sku":{"type":"string","description":"sku","example":"sku"},"expected_quantity":{"type":"integer","description":"Total quantity of the item expected to be received","example":2}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemsmart-warehousing"},"CreatewmsInboundShipment--Smart__Warehousing--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"Customer defined reference associated with the receipt.","example":"reference_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"return_type":{"type":"string","enum":["Railcar","LTL","TL","Small Parcel","40 Ft. Container","20 Ft. Container"],"description":"The type of receipt being created.","example":"Railcar"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":2}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemsmart-warehousing"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["expected_arrival_date","line_items","reference_id","return_type"],"additionalProperties":false,"title":"Smart Warehousing"},"WmsInboundShipmentCreateLineItemsojo":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"","example":"inventory_item_id"},"quantity":{"type":"integer","description":"","example":0}},"required":["inventory_item_id","quantity"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemsojo"},"CreatewmsInboundShipment--Sojo--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"inventory_item_id","quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemsojo"}}},"required":["expected_arrival_date","line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Sojo"},"WmsInboundShipmentWriteLineItemstar":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemstar"},"StarBox":{"type":"object","properties":{"carton_count":{"type":"integer","default":1,"description":"Number of identical cartons of this box type.","example":1},"length":{"type":"number","description":"Carton length in cm.","example":30},"width":{"type":"number","description":"Carton width in cm.","example":20},"height":{"type":"number","description":"Carton height in cm.","example":15},"weight":{"type":"number","description":"Carton weight in kg.","example":5},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemstar"}}},"required":["height","length","line_items","weight","width"],"additionalProperties":false,"title":"StarBox"},"CreatewmsInboundShipment--Star__WMS--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"container_type":{"type":"string","enum":["express","box","pallet","container_20gp","container_20hq","container_40gp","container_40hq","container_45gp","container_53hq","other","platform_pickup","third_party_freight","self_shipped"],"description":"Arrival mode of the shipment at the warehouse.","example":"express"},"boxes":{"type":"array","description":"Box types in the shipment. Each entry is a stack of identically-packed cartons.","items":{"$ref":"#/components/schemas/StarBox"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"required":["boxes","container_type","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"Star WMS"},"WmsInboundShipmentCreateLineItemstockhub":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemstockhub"},"CreatewmsInboundShipment--Stockhub--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemstockhub"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"Stockhub"},"WmsInboundShipmentWriteLineItemstord":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemstord"},"CreatewmsInboundShipment--Stord--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemstord"}}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Stord"},"WmsInboundShipmentWriteLineItemthg-ingenuity-fulfil":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"external_id":{"type":"string","description":"Your own reference for the line, sent as the pre-advice lineId. THG quotes it on per-line rejection reasons.","example":"line_1"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemthg-ingenuity-fulfil"},"CreatewmsInboundShipment--THG__Ingenuity__Fulfil--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"external_id":"line_1"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemthg-ingenuity-fulfil"}},"estimated_number_of_logistics_units":{"type":"integer","minimum":1,"description":"How many pallets or cartons the delivery is expected to hold.","example":5},"logistics_unit_type":{"type":"string","enum":["PALLET","CARTON"],"description":"Whether the delivery arrives on pallets or in cartons.","example":"PALLET"},"delivery_type":{"type":"string","enum":["FREIGHT","COURIER"],"description":"How the delivery is sent.","example":"FREIGHT"}},"required":["delivery_type","estimated_number_of_logistics_units","expected_arrival_date","line_items","logistics_unit_type","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"THG Ingenuity Fulfil"},"WmsInboundShipmentCreateLineItemtlogistics":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_cost":{"type":"number","minimum":0.0,"description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemtlogistics"},"CreatewmsInboundShipment--TLogistics--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","maxLength":20,"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemtlogistics"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"TLogistics"},"WmsInboundShipmentCreateLineItemtps":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"lot_id":{"type":"string","description":"","example":"lot_id"},"expiration_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemtps"},"CreatewmsInboundShipment--TPS--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"lot_id":"lot_id","expiration_date":"2023-03-15T13:45:30Z"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemtps"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"required":["expected_arrival_date","line_items","purchase_order_number"],"additionalProperties":false,"title":"TPS"},"WmsInboundShipmentCreateLineItemunleashed":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemunleashed"},"CreatewmsInboundShipment--Unleashed--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemunleashed"}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","maxLength":15,"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"}},"required":["line_items","supplier_object"],"additionalProperties":false,"title":"Unleashed"},"WmsInboundShipmentCreateLineItem":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0},"tax_rate":{"type":"number","description":"The tax rate for the line item.","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItem"},"CreatewmsInboundShipment--Veeqo--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"invoice_currency_code":{"type":"string","minLength":3,"maxLength":3,"description":"The currency the purchase order is priced in. Veeqo defaults to GBP, and won't let it change once the purchase order is active.","example":"USD"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0,"tax_rate":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItem"}}},"required":["line_items","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Veeqo"},"WmsInboundShipmentWriteLineItemveracore":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"lot_id":{"type":"string","description":"The product version to assign to this line. Veracore calls lots versions.","example":"N-07-08-25"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemveracore"},"CreatewmsInboundShipment--VeraCore--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"our_purchase_order_number":{"type":"string","description":"Sent as Veracore's Our PO. purchase_order_number is sent as Veracore's Client PO. When both are set, Our PO is what reads return as purchase_order_number.","example":"our_po_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"lot_id":"N-07-08-25"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemveracore"}},"owner_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The inventory owner that the products belong to. Required when the account has more than one owner.","example":"owner_id"},"notes":{"type":"string","description":"Notes associated with the inbound shipment.","example":"notes"}},"required":["expected_arrival_date","line_items","supplier_object","warehouse_id"],"additionalProperties":false,"title":"VeraCore"},"WmsInboundShipmentCreateLineItemwarehance":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the product. Use this or `inventory_item_id`.","example":"SKU123"},"expected_quantity":{"type":"integer","description":"","example":0},"inventory_item_id":{"type":"string","description":"The numeric product ID in Warehance. Use this or `sku`.","example":"12345"}},"required":["expected_quantity"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemwarehance"},"CreatewmsInboundShipment--Warehance--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"SKU123","expected_quantity":0,"inventory_item_id":"12345"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemwarehance"}}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Warehance"},"WmsInboundShipmentCreateLineItemwhiplash":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"Total quantity of the item expected to be received.","example":2},"lot_id":{"type":"string","description":"Lot number for the items. Only works if lot control is enabled for that item.","example":"lot_id"},"expiration_date":{"type":"string","description":"Expiration date for the lot in ISO format. Only works if lot control is enabled for that item.","example":"expiration_date"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateLineItemwhiplash"},"CreatewmsInboundShipment--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":2,"lot_id":"lot_id","expiration_date":"expiration_date"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemwhiplash"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["expected_arrival_date","line_items","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Whiplash (Ryder)"},"WmsInboundShipmentWriteLineItemzenventory":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemzenventory"},"CreatewmsInboundShipment--Zenventory--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemzenventory"}},"ship_method":{"type":"string","description":"Shipping method for the inbound shipment.","example":"ship_method"}},"required":["line_items","supplier_object"],"additionalProperties":false,"title":"Zenventory"},"WmsInboundShipmentWriteLineItemzoho":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemzoho"},"CreatewmsInboundShipment--Zoho--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"","example":"warehouse_id"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemzoho"}}},"required":["line_items","supplier_object"],"additionalProperties":false,"title":"Zoho"},"CreatewmsInboundShipmentInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreatewmsInboundShipment--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Active__Ants--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--A.__Duie__Pyle__-_ADP_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Amphora--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Amplifier--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--AMS--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Bergen--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--BEST__Inc.--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Bigblue--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--BlueBox__-_IDrive__Fulfillment_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Boxzooka--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Camelot--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Canary7--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Capacity--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--CartonCloud--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Clarus--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--DCL--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Deposco--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Distribution__Management--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Dotcom__Distribution--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--eShipping--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Evolve--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Finale--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Flexport__-_Deliverr_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Flowspace--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Fulfillor--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--fulfilmentcrowd--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--G__Global--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--GoBolt--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Greenmark__Logistics--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Helm__WMS--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Hive--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--I-Fulfilment--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--iCreate--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Infoplus--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--JAS--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Cart.com__-_Jazz__Central_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Leanware--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Lineage--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Linnworks--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Quickbox__-_LogicPod_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Logiwa--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Logiwa__IO--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Luminous--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Luxroutage__LRI--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Mainfreight--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--MasonHub--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Mintsoft--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Moda__Express--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Monta--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Nimble--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--NLRP--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--NPFulfilment--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--NRI--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--OIA__Global--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Ongoing__WMS--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--OrderWise--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Packiyo--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Pattern--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Peoplevox--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Picqer--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--PostNord--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Pulpo__WMS--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Quiet__Platforms--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--RJW--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--R_AMP_S__Logistics--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Salesupply--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--ShipBob--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Shipedge--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Shipfusion--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--ShipHero--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--ShipMonk--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--ShippingTree--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Shippingbo--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--ShipStream--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Shipwire--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Skulabs--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--SKUSavvy--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Linnworks__Core__-_SKUVault_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Smart__Warehousing--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Sojo--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Star__WMS--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Stockhub--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Stord--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--THG__Ingenuity__Fulfil--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--TLogistics--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--TPS--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Unleashed--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Veeqo--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--VeraCore--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Warehance--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Whiplash__-_Ryder_---"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Zenventory--"},{"$ref":"#/components/schemas/CreatewmsInboundShipment--Zoho--"}],"title":"CreatewmsInboundShipmentInputSchema"},"wmsUpdateKitResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsKitApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateKitResponse"},"HTTPError":{"properties":{"error":{"type":"string"},"id":{"type":"string","description":"The ID of the item that wasn't found."}},"required":["error"],"type":"object","title":"HTTPError"},"UpdatewmsKit--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"XS-RED-SHIRT"},"name":{"type":"string","description":"name","example":"XS Red Shirt"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"012345678905"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitCreateInventoryItemsandbox"}}},"additionalProperties":false,"title":"WMS Sandbox"},"UpdatewmsKit--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"costing_method":{"type":"string","enum":["FIFO","Special - Batch","Special - Serial Number","FIFO - Serial Number","FIFO - Batch","FEFO - Batch","FEFO - Serial Number"],"description":"Costing method for the product.","example":"FEFO - Batch"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemdear-systems"}}},"required":["inventory_items"],"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"UpdatewmsKit--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemextensiv-3pl-central"}}},"required":["inventory_items","warehouse_customer_id"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"WmsKitUpdateInventoryIteminfoplus":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitUpdateInventoryIteminfoplus"},"UpdatewmsKit--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":"string","description":"ID of the warehouse customer that owns this product","example":"warehouse_customer_id"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"touches":{"type":"integer","description":"The number of assembly points there are to build a single kit","example":0},"is_kit_on_demand":{"type":"string","enum":["Yes","No"],"description":"Whether this kit is built on demand (as in built at the point of fulfillment)","example":"No"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitUpdateInventoryIteminfoplus"}}},"required":["inventory_items"],"additionalProperties":false,"title":"Infoplus"},"UpdatewmsKit--Luminous--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"category_id":{"type":"integer","minimum":1,"description":"The ID of the Luminous category the kit belongs to.","example":1},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemluminous"}}},"additionalProperties":false,"title":"Luminous"},"UpdatewmsKit--MasonHub--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsmasonhub"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"description":{"type":"string","description":"Description of the product.","example":"description"},"customer_bar_code":{"type":"string","description":"Customer provided bar code for this sku.","example":"customer_bar_code"},"brand_name":{"type":"string","description":"Brand name for this sku and product.","example":"brand_name"},"category":{"type":"string","description":"Product category for this sku.","example":"category"},"sub_category":{"type":"string","description":"Product sub category for this sku.","example":"sub_category"},"vendor_brand_code":{"type":"string","description":"Vendor provided brand code for identifying this sku.","example":"vendor_brand_code"},"customer_brand_code":{"type":"string","description":"Customer provided brand code for identifying this sku. Used on packing lists.","example":"customer_brand_code"},"vendor_style":{"type":"string","description":"Vendor style code for item identification.","example":"vendor_style"}},"required":["brand_name","category","customer_bar_code","customer_brand_code","description","measurements","name","sub_category","vendor_brand_code","vendor_style"],"additionalProperties":false,"title":"MasonHub"},"WmsKitUpdateInventoryItemongoing":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitUpdateInventoryItemongoing"},"UpdatewmsKit--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitUpdateInventoryItemongoing"}}},"required":["inventory_items"],"additionalProperties":false,"title":"Ongoing WMS"},"UpdatewmsKit--ShipHero--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshiphero"}},"additionalProperties":false,"title":"ShipHero"},"WmsKitUpdateInventoryItemshipstream":{"type":"object","properties":{"sku":{"type":"string","description":"SKU of the kit component.","example":"sku"},"unit_quantity":{"type":"integer","description":"Quantity of the kit component.","example":1}},"required":["sku","unit_quantity"],"additionalProperties":false,"title":"WmsKitUpdateInventoryItemshipstream"},"UpdatewmsKit--ShipStream--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitUpdateInventoryItemshipstream"}}},"required":["inventory_items"],"additionalProperties":false,"title":"ShipStream"},"UpdatewmsKit--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"inventory_items":{"type":"array","description":"Inventory Items that make up this kit.","example":[{"inventory_item_id":"inventory_item_id","sku":"sku","unit_quantity":1}],"items":{"$ref":"#/components/schemas/WmsKitWriteInventoryItemwhiplash"}}},"required":["gtin"],"additionalProperties":false,"title":"Whiplash (Ryder)"},"UpdatewmsKitInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdatewmsKit--WMS__Sandbox--"},{"$ref":"#/components/schemas/UpdatewmsKit--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/UpdatewmsKit--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/UpdatewmsKit--Infoplus--"},{"$ref":"#/components/schemas/UpdatewmsKit--Luminous--"},{"$ref":"#/components/schemas/UpdatewmsKit--MasonHub--"},{"$ref":"#/components/schemas/UpdatewmsKit--Ongoing__WMS--"},{"$ref":"#/components/schemas/UpdatewmsKit--ShipHero--"},{"$ref":"#/components/schemas/UpdatewmsKit--ShipStream--"},{"$ref":"#/components/schemas/UpdatewmsKit--Whiplash__-_Ryder_---"}],"title":"UpdatewmsKitInputSchema"},"WmsWarehouseCustomerIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsWarehouseCustomerIdsQueryParam"},"WmsWarehouseCustomerCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseCustomerCreated_DateQueryParam"},"WmsWarehouseCustomerUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseCustomerUpdated_DateQueryParam"},"WmsWarehouseCustomerTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseCustomerTrackstar_Created_DateQueryParam"},"WmsWarehouseCustomerTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseCustomerTrackstar_Updated_DateQueryParam"},"WmsWarehouseCustomerApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse customer.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse customer was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse customer was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse customer.","example":"Customer Name"},"email":{"type":["string","null"],"description":"The email of the primary contact for the warehouse customer.","example":"customer@email.com"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","email","id","name","trackstar_created_date","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"WmsWarehouseCustomerApiItemSchema"},"WmsWarehouseCustomersListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsWarehouseCustomerApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsWarehouseCustomersListEndpoint"},"ErpItemsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpItemApiItemSchema"}},"additionalProperties":false,"title":"ErpItemsSingleItemEndpoint"},"ErpSalesOrderShipmentIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpSalesOrderShipmentIdsQueryParam"},"ErpSalesOrderShipmentCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentCreated_DateQueryParam"},"ErpSalesOrderShipmentUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentUpdated_DateQueryParam"},"ErpSalesOrderShipmentTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentTrackstar_Created_DateQueryParam"},"ErpSalesOrderShipmentTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentTrackstar_Updated_DateQueryParam"},"ErpSalesOrderShipmentTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpSalesOrderShipmentTrackstar_Tags_FlatQueryParam"},"ErpSalesOrderShipmentSales_Order_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"so_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}}},"additionalProperties":false,"title":"ErpSalesOrderShipmentSales_Order_IdQueryParam"},"ErpSalesOrderShipmentShipment_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"IF1001"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentShipment_NumberQueryParam"},"ErpSalesOrderShipmentShipped_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2024-05-04T00:00:00Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentShipped_DateQueryParam"},"ErpSalesOrderShipmentPackage":{"type":"object","properties":{"package_id":{"type":"string","description":"The ID of the package within the shipment.","example":"package_id"},"tracking_number":{"type":["string","null"],"description":"The carrier tracking number for the package.","example":"tracking_number"},"measurements":{"$ref":"#/components/schemas/PackageMeasurements"}},"required":["measurements","package_id","tracking_number"],"additionalProperties":false,"title":"ErpSalesOrderShipmentPackage"},"ErpSalesOrderShipmentKitComponentLot":{"type":"object","properties":{"lot_id":{"type":["string","null"],"description":"ID of the lot this component was drawn from.","example":"lot_id"},"lot_name":{"type":["string","null"],"description":"Human-readable lot name.","example":"lot_name"},"bin_id":{"type":["string","null"],"description":"ID of the bin this component was drawn from.","example":"bin_id"},"bin_name":{"type":["string","null"],"description":"Human-readable bin name.","example":"bin_name"},"quantity":{"type":"number","description":"Quantity drawn from this lot or bin.","example":0.0}},"required":["bin_id","bin_name","lot_id","lot_name","quantity"],"additionalProperties":false,"title":"ErpSalesOrderShipmentKitComponentLot"},"ErpSalesOrderShipmentKitComponent":{"type":"object","properties":{"line_item_id":{"type":["string","null"],"description":"Line-unique ID of the component on the source sales order.","example":"line_item_id"},"item_id":{"type":"string","description":"ID of the component item shipped.","example":"item_id"},"sku":{"type":"string","description":"SKU / item number of the component item.","example":"sku"},"quantity":{"type":"number","description":"Quantity of this component shipped.","example":0.0},"lots":{"type":"array","description":"The lots and bins this component was drawn from. Empty for components that are not lot or bin tracked.","example":[{"lot_id":"78524","lot_name":"051326","bin_id":null,"bin_name":null,"quantity":4.0}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentKitComponentLot"}}},"required":["item_id","line_item_id","lots","quantity","sku"],"additionalProperties":false,"title":"ErpSalesOrderShipmentKitComponent"},"ErpSalesOrderShipmentLineItem":{"type":"object","properties":{"shipment_line_item_id":{"type":"string","description":"ID of the line within the shipment record.","example":"shipment_line_item_id"},"line_item_id":{"type":["string","null"],"description":"ID of the source sales-order line that this shipment line fulfills. Joins back to the parent sales order's `line_items[*].line_item_id`. Null when the ERP doesn't expose the link.","example":"line_item_id"},"item_id":{"type":"string","description":"ID of the inventory item shipped.","example":"item_id"},"sku":{"type":"string","description":"SKU / item number of the item shipped.","example":"sku"},"quantity":{"type":"number","description":"Quantity shipped on this line.","example":0.0},"is_kit":{"type":"boolean","description":"Whether this line is a kit. A kit ships as a unit, so its components are not listed as separate lines here; they are nested under `kit_components`.","example":false},"kit_components":{"type":"array","description":"The items that shipped inside this kit line, and the lots or bins each was drawn from. Empty unless the line is a kit.","example":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0,"lots":[{"lot_id":"78524","lot_name":"051326","bin_id":null,"bin_name":null,"quantity":4.0}]}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentKitComponent"}},"lot_id":{"type":["string","null"],"description":"ID of the lot this line was drawn from. Null for non-lot-tracked items.","example":"lot_id"},"lot_name":{"type":["string","null"],"description":"Human-readable name of the lot this line was drawn from.","example":"lot_name"},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiration date of the lot this line was drawn from.","example":"2023-03-15T13:45:30Z"},"bin_id":{"type":["string","null"],"description":"ID of the bin this line was drawn from. Null for non-bin-tracked items.","example":"bin_id"},"bin_name":{"type":["string","null"],"description":"Human-readable name of the bin this line was drawn from.","example":"bin_name"}},"required":["bin_id","bin_name","expiration_date","is_kit","item_id","kit_components","line_item_id","lot_id","lot_name","quantity","shipment_line_item_id","sku"],"additionalProperties":false,"title":"ErpSalesOrderShipmentLineItem"},"ErpSalesOrderShipmentCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpSalesOrderShipmentCustomFieldEntry"},"ErpSalesOrderShipmentApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the shipment transaction in the ERP.","example":"ship_1"},"sales_order_id":{"type":"string","description":"ID of the parent sales order this shipment fulfills.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order shipment was last updated.","example":"2022-01-02T05:05:05Z"},"shipment_number":{"type":["string","null"],"description":"The user-facing identifier of the shipment as assigned by the ERP.","example":"IF1001"},"shipped_date":{"type":"string","format":"date-time","description":"Date the shipment was sent.","example":"2024-05-04T00:00:00Z"},"location_id":{"type":["string","null"],"description":"ID of the location the shipment was sent from.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the shipment.","example":["First wave"],"items":{"type":"string","description":"Note","example":"notes"}},"packages":{"type":"array","description":"Per-parcel breakdown of the shipment. Mirrors the WMS shipment.packages shape \u2014 one entry per package shipped, carrying its own tracking number and measurements.","example":[{"package_id":"ship_1-1","tracking_number":"1Z999AA10123456784","measurements":{"length":12.0,"width":9.0,"height":4.0,"unit":"in","weight":2.5,"weight_unit":"lb"}}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentPackage"}},"line_items":{"type":"array","description":"Items included in this shipment. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit ship of one item drawn from two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"shipment_line_item_id":"shipment_line_item_id","line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0,"lots":[{"lot_id":"78524","lot_name":"051326","bin_id":null,"bin_name":null,"quantity":4.0}]}],"lot_id":"lot_id","lot_name":"lot_name","expiration_date":"2023-03-15T13:45:30Z","bin_id":"bin_id","bin_name":"bin_name"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order shipment. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderShipmentCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order shipment in the external system (WMS/Freight etc).","example":"https://example.com/salesordershipment/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","custom_fields","external_system_url","id","line_items","location_id","notes","packages","sales_order_id","shipment_number","shipped_date","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"ErpSalesOrderShipmentApiItemSchema"},"ErpSalesOrderShipmentsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpSalesOrderShipmentsListEndpoint"},"CreateErpSalesOrderShipmentResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the shipment transaction in the ERP.","example":"ship_1"},"sales_order_id":{"type":"string","description":"ID of the parent sales order this shipment fulfills.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order shipment was last updated.","example":"2022-01-02T05:05:05Z"},"shipment_number":{"type":["string","null"],"description":"The user-facing identifier of the shipment as assigned by the ERP.","example":"IF1001"},"shipped_date":{"type":"string","format":"date-time","description":"Date the shipment was sent.","example":"2024-05-04T00:00:00Z"},"location_id":{"type":["string","null"],"description":"ID of the location the shipment was sent from.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the shipment.","example":["First wave"],"items":{"type":"string","description":"Note","example":"notes"}},"packages":{"type":"array","description":"Per-parcel breakdown of the shipment. Mirrors the WMS shipment.packages shape \u2014 one entry per package shipped, carrying its own tracking number and measurements.","example":[{"package_id":"ship_1-1","tracking_number":"1Z999AA10123456784","measurements":{"length":12.0,"width":9.0,"height":4.0,"unit":"in","weight":2.5,"weight_unit":"lb"}}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentPackage"}},"line_items":{"type":"array","description":"Items included in this shipment. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit ship of one item drawn from two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"shipment_line_item_id":"shipment_line_item_id","line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0,"lots":[{"lot_id":"78524","lot_name":"051326","bin_id":null,"bin_name":null,"quantity":4.0}]}],"lot_id":"lot_id","lot_name":"lot_name","expiration_date":"2023-03-15T13:45:30Z","bin_id":"bin_id","bin_name":"bin_name"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order shipment. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderShipmentCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order shipment in the external system (WMS/Freight etc).","example":"https://example.com/salesordershipment/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","custom_fields","external_system_url","id","line_items","location_id","notes","packages","sales_order_id","shipment_number","shipped_date","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"CreateErpSalesOrderShipmentResponseDataSchema"},"erpCreateSalesOrderShipmentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateErpSalesOrderShipmentResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpCreateSalesOrderShipmentResponse"},"WriteErpSalesOrderShipmentPackageMeasurements":{"type":"object","properties":{"weight":{"type":"number","description":"Weight of the package.","example":0.0},"weight_unit":{"type":"string","description":"The unit of measurement for the weight.","example":"weight_unit"}},"required":["weight"],"additionalProperties":false,"title":"WriteErpSalesOrderShipmentPackageMeasurements"},"WriteErpSalesOrderShipmentPackage":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The carrier tracking number for the package.","example":"tracking_number"},"measurements":{"$ref":"#/components/schemas/WriteErpSalesOrderShipmentPackageMeasurements"}},"required":["measurements"],"additionalProperties":false,"title":"WriteErpSalesOrderShipmentPackage"},"ErpSalesOrderShipmentShipToAddressNetsuite":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentShipToAddressNetsuite"},"WriteNetSuiteSalesOrderShipmentLineItemLot":{"type":"object","properties":{"lot_id":{"type":"string","description":"NetSuite inventoryNumber.id; see /erp/inventory.lots[]. Mutually exclusive with lot_name.","example":"lot_id"},"bin_id":{"type":"string","description":"NetSuite bin.id; see /erp/inventory.bins[]. Mutually exclusive with bin_name.","example":"bin_id"},"quantity":{"type":"number","minimum":0.0,"description":"Quantity drawn from this (lot, bin) pair.","example":0.0},"lot_name":{"type":"string","description":"Human-readable lot label (inventoryNumber.inventorynumber). Resolved to lot_id scoped by the line's item_id. Mutually exclusive with lot_id.","example":"lot_name"},"bin_name":{"type":"string","description":"Human-readable bin label (bin.binnumber). Resolved to bin_id scoped by the shipment's location_id. Mutually exclusive with bin_id.","example":"bin_name"}},"required":["quantity"],"additionalProperties":false,"title":"WriteNetSuiteSalesOrderShipmentLineItemLot"},"WriteNetSuiteSalesOrderShipmentKitComponent":{"type":"object","properties":{"line_item_id":{"type":"string","description":"ID of the component's line on the sales order.","example":"line_item_id"},"item_id":{"type":"string","description":"ID of the component item.","example":"item_id"},"quantity":{"type":"number","minimum":0.0,"description":"Quantity of this component going out with the kits on this line.","example":0.0},"lots":{"type":"array","minItems":1,"description":"Per-(lot, bin) commitment for this line. NetSuite requires lot when the item is lot-tracked, bin when the item is bin-tracked. Identify the lot via lot_id OR lot_name (exactly one); same for bin via bin_id OR bin_name. Name-based entries are resolved server-side. The shipment must include location_id when any bin_name is used. The sum of lots[*].quantity must equal the line's quantity.","example":[{"lot_name":"LOT-20240315","bin_name":"ROW-12-B","quantity":60.0}],"items":{"$ref":"#/components/schemas/WriteNetSuiteSalesOrderShipmentLineItemLot"}}},"required":["item_id","line_item_id","quantity"],"additionalProperties":false,"title":"WriteNetSuiteSalesOrderShipmentKitComponent"},"ErpSalesOrderShipmentCreateLineItemnetsuite":{"type":"object","properties":{"line_item_id":{"type":"string","description":"","example":"line_item_id"},"item_id":{"type":"string","description":"","example":"item_id"},"quantity":{"type":"number","description":"","example":0.0},"lots":{"type":"array","minItems":1,"description":"Per-(lot, bin) commitment for this line. NetSuite requires lot when the item is lot-tracked, bin when the item is bin-tracked. Identify the lot via lot_id OR lot_name (exactly one); same for bin via bin_id OR bin_name. Name-based entries are resolved server-side. The shipment must include location_id when any bin_name is used. The sum of lots[*].quantity must equal the line's quantity.","example":[{"lot_name":"LOT-20240315","bin_name":"ROW-12-B","quantity":60.0}],"items":{"$ref":"#/components/schemas/WriteNetSuiteSalesOrderShipmentLineItemLot"}},"kit_components":{"type":"array","minItems":1,"description":"The items inside this kit line, needed only when a component is lot- or bin-tracked. Use the component's own `line_item_id` from the sales order's `line_items[*].kit_components[*]`.","example":[{"line_item_id":"1002","item_id":"610","quantity":4.0,"lots":[{"lot_id":"9821","quantity":4.0}]}],"items":{"$ref":"#/components/schemas/WriteNetSuiteSalesOrderShipmentKitComponent"}}},"required":["item_id","line_item_id","quantity"],"additionalProperties":false,"title":"ErpSalesOrderShipmentCreateLineItemnetsuite"},"CreateerpSalesOrderShipment--NetSuite--":{"type":"object","properties":{"sales_order_id":{"type":"string","description":"ID of the parent sales order this shipment fulfills.","example":"so_id"},"shipped_date":{"type":"string","format":"date-time","description":"Date the shipment was sent.","example":"2024-05-04T00:00:00Z"},"packages":{"type":"array","description":"Per-parcel breakdown of the shipment.","example":[{"tracking_number":"1Z999AA10123456784","measurements":{"weight":2.5,"weight_unit":"lb"}}],"items":{"$ref":"#/components/schemas/WriteErpSalesOrderShipmentPackage"}},"location_id":{"type":"string","description":"ID of the location the shipment was sent from.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the shipment.","example":["First wave"],"items":{"type":"string","description":"Note","example":"notes"}},"ship_to_address":{"$ref":"#/components/schemas/ErpSalesOrderShipmentShipToAddressNetsuite"},"line_items":{"type":"array","description":"Items included in this shipment. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit ship of one item drawn from two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"line_item_id":"line_item_id","item_id":"item_id","quantity":0.0,"lots":[{"lot_name":"LOT-20240315","bin_name":"ROW-12-B","quantity":60.0}],"kit_components":[{"line_item_id":"1002","item_id":"610","quantity":4.0,"lots":[{"lot_id":"9821","quantity":4.0}]}]}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentCreateLineItemnetsuite"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order shipment. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderShipmentCustomFieldEntry"}}},"required":["sales_order_id"],"additionalProperties":false,"title":"NetSuite"},"CreateerpSalesOrderShipmentInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreateerpSalesOrderShipment--NetSuite--"}],"title":"CreateerpSalesOrderShipmentInputSchema"},"IntegrationRequestFlow":{"type":"object","properties":{"value":{"type":"string","description":"Send this in the flows field of an integration request.","example":"read_orders"},"label":{"type":"string","description":"Human-readable name for the flow.","example":"Orders & shipments"},"direction":{"type":"string","description":"Whether we read this data from the system or write it to the system. Requesting any write flow means we need sandbox credentials.","example":"read"},"integration_type":{"type":"string","description":"The integration type this flow belongs to.","example":"wms"}},"required":["direction","integration_type","label","value"],"additionalProperties":false,"title":"IntegrationRequestFlow"},"IntegrationRequestFlowsResponseSchema":{"type":"object","properties":{"flows":{"type":"array","description":"The flows you can ask for on an integration request.","items":{"$ref":"#/components/schemas/IntegrationRequestFlow"}}},"required":["flows"],"additionalProperties":false,"title":"IntegrationRequestFlowsResponseSchema"},"WmsOrdersSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsOrderApiItemSchema"}},"additionalProperties":false,"title":"WmsOrdersSingleItemEndpoint"},"wmsUpdateOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsOrderApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateOrderResponse"},"SandboxUpdateOrderShipToAddress":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":["string","null"],"description":"","example":"Company"},"address1":{"type":"string","description":"","example":"123 Main St"},"address2":{"type":["string","null"],"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","postal_code"],"additionalProperties":false,"title":"SandboxUpdateOrderShipToAddress"},"SandboxUpdateOrderLineItems":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":1}},"required":["quantity","sku"],"additionalProperties":false,"title":"SandboxUpdateOrderLineItems"},"UpdatewmsOrder--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"so_26679"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/SandboxChannelIdSchema"},"shipping_method_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"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","description":"The total price a customer paid for the order.","example":13.49},"ship_to_address":{"$ref":"#/components/schemas/SandboxUpdateOrderShipToAddress"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1}],"items":{"$ref":"#/components/schemas/SandboxUpdateOrderLineItems"}}},"additionalProperties":false,"title":"WMS Sandbox"},"UpdatewmsOrder--Amphora--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressAmphora"}},"required":["ship_to_address"],"additionalProperties":false,"title":"Amphora"},"UpdatewmsOrder--BlueBox__-_IDrive__Fulfillment_---":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressBluebox"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItembluebox"}},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"}},"required":["carrier_id","shipping_method_id"],"additionalProperties":false,"title":"BlueBox (IDrive Fulfillment)"},"UpdateOrderShipToAddressBoxzooka":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"},"email_address":{"type":"string","description":"","example":"johndoe@example.com"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"UpdateOrderShipToAddressBoxzooka"},"UpdatewmsOrder--Boxzooka--":{"type":"object","properties":{"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":{}},"shipping_method_id":{"type":"string","enum":["BXZ.PKP","BXZ.USA.1","BXZ.USA.2","BXZ.USA.3","BXZ.USA.5","BXZ.USA.7","UPS.EXP.1","UPS.DOM.1","UPS.DOM.2","UPS.DOM.3","UPS.GRD.RESI","SUREPOST","USPS.PRIORITY","USPS.GRD","USPS.EXPRESS","FDX.EXP.1","FDX.DOM.1","FDX.DOM.2","FDX.DOM.3","FDX.GRD","FDX.GRD.COLLECT","FDX.HOME","SMARTPOST","DHLEC.GRD","DHLEC.MAX","FDX.INTL.ECO","FDX.CONNECT.PLUS","UPS.INTL.EXP","DHLEC.PLT"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Must be one of Boxzooka's documented method codes, e.g. FDX.GRD or UPS.GRD.RESI.","example":"BXZ.PKP"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"ship_to_address":{"$ref":"#/components/schemas/UpdateOrderShipToAddressBoxzooka"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","name":"Crew Tee - XS / White","quantity":0,"weight":1.5,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemboxzooka"}},"type":{"type":"string","enum":["d2c","b2b","dropship"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"}},"additionalProperties":false,"title":"Boxzooka"},"ClarusUpdateOrderShipToAddressClarus":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"email_address":{"type":"string","description":"","example":"customer@example.com"},"phone_number":{"type":"string","description":"","example":"+441234567890"}},"additionalProperties":false,"title":"ClarusUpdateOrderShipToAddressClarus"},"WmsOrderUpdateLineItemclarus":{"type":"object","properties":{"product_id":{"type":"string","description":"","example":"108"},"quantity":{"type":"integer","minimum":1,"description":"","example":1}},"required":["product_id"],"additionalProperties":false,"title":"WmsOrderUpdateLineItemclarus"},"UpdatewmsOrder--Clarus--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ClarusUpdateOrderShipToAddressClarus"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"108","quantity":1}],"items":{"$ref":"#/components/schemas/WmsOrderUpdateLineItemclarus"}}},"required":["line_items"],"additionalProperties":false,"title":"Clarus"},"UpdateOrderShipToAddressControlport":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"additionalProperties":false,"title":"UpdateOrderShipToAddressControlport"},"UpdateOrderBillToAddressControlport":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"additionalProperties":false,"title":"UpdateOrderBillToAddressControlport"},"WmsOrderUpdateLineItemcontrolport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":1},"unit_price":{"type":"number","description":"","example":0.0},"line_item_id":{"type":"string","description":"The specific order line to update, needed only when a product is on the order more than once.","example":"line_item_id"}},"required":["sku"],"additionalProperties":false,"title":"WmsOrderUpdateLineItemcontrolport"},"UpdatewmsOrder--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"postage_speed":{"type":"integer","description":"How fast the order should ship. 0 is urgent (fastest, most expensive), 3 is economy (cheapest, slowest).","example":2},"preferred_carrier_id":{"type":"integer","description":"The carrier to prefer when choosing a shipping service for the order.","example":1},"international_duty_paid_by":{"type":"string","enum":["sender","recipient"],"description":"Who pays international duties on the order.","example":"sender"},"invoice_currency_code":{"type":"string","description":"The currency used for this order. If not provided, uses the account default.","example":"GBP"},"total_price":{"type":"number","description":"The total price a customer paid for the order.","example":13.49},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/UpdateOrderShipToAddressControlport"},"bill_to_address":{"$ref":"#/components/schemas/UpdateOrderBillToAddressControlport"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":1,"unit_price":0.0,"line_item_id":"line_item_id"}],"items":{"$ref":"#/components/schemas/WmsOrderUpdateLineItemcontrolport"}}},"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"UpdateShipToAddressDarwynn-Fulfillment":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"required":["address1","address2","city","country","email_address","full_name","phone_number","postal_code","state"],"additionalProperties":false,"title":"UpdateShipToAddressDarwynn-Fulfillment"},"UpdatewmsOrder--Darwynn__Fulfillment--":{"type":"object","properties":{"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":{}},"type":{"type":"string","enum":["b2b","d2c"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"service_level":{"type":"string","enum":["Standard","Expedited"],"description":"The type of shipping method requested by the customer. Darwynn courier SLA: Standard or Expedited.","example":"Standard"},"operation_sla":{"type":"string","enum":["Standard","Expedited","Priority"],"description":"Darwynn pick/processing SLA: Standard (24-48h), Expedited (same day), or Priority (3h rush).","example":"Standard"},"signature_required":{"type":"boolean","description":"","example":true},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"note":{"type":"string","description":"","example":"note"},"from_plat_code":{"type":"string","description":"","example":"from_plat_code"},"shop_id":{"type":"string","description":"","example":"shop_id"},"ship_to_address":{"$ref":"#/components/schemas/UpdateShipToAddressDarwynn-Fulfillment"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdarwynn-fulfillment"}}},"required":["carrier_id","line_items","operation_sla","required_ship_date","service_level","ship_to_address","type","warehouse_id"],"additionalProperties":false,"title":"Darwynn Fulfillment"},"UpdatewmsOrder--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressDear-Systems"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressDear-Systems"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","quantity":0,"unit_price":0.0,"tax":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdear-systems"}}},"required":["warehouse_id"],"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"OrderShipToAddressUpdateDeposco":{"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"},"phone_number":{"type":"string","description":"","example":"123-456-7890"}},"required":["address1","city","country"],"additionalProperties":false,"title":"OrderShipToAddressUpdateDeposco"},"UpdatewmsOrder--Deposco--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/OrderShipToAddressUpdateDeposco"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"unit_cost":0.0,"notes":[{"title":"Note Title","body":"Note Body"}]}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemdeposco"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"cancel_by_ship_date":{"type":"string","format":"date-time","description":"Date to cancel the order by","example":"2023-10-01T00:00:00Z"},"custom_attribute_1":{"type":"string","description":"Custom attribute 1","example":"Custom attribute 1"},"custom_attribute_2":{"type":"string","description":"Custom attribute 2","example":"Custom attribute 2"},"custom_attribute_6":{"type":"string","description":"Custom attribute 6","example":"Custom attribute 6"},"custom_attribute_7":{"type":"string","description":"Custom attribute 7","example":"Custom attribute 7"},"order_type":{"type":"string","default":"Sales Order","enum":["Sales Order","Outbound Transfer Order"],"description":"The type of Deposco order, defaults to Sales Order.","example":"Sales Order"},"freight_account_number":{"type":"string","description":"The freight account number.","example":"123456789"},"notes":{"type":"array","description":"List of the custom fields","example":[{"title":"Note Title","body":"Note Body"}],"items":{"$ref":"#/components/schemas/Notes"}}},"additionalProperties":false,"title":"Deposco"},"UpdatewmsOrder--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressExtensiv"},"billing_code":{"type":"string","enum":["default_Prepaid","default_FreightCollect","default_BillThirdParty","fedex_collect","fedex_recipient","fedex_sender","fedex_third_party","ups_BillThirdParty","ups_ConsigneeBilled","ups_FreightCollect","ups_Prepaid"],"description":"Billing Type","example":"default_BillThirdParty"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"carrier_account_number":{"type":"string","description":"Carrier account number to bill freight against (e.g. for third-party billing).","example":"carrier_account_number"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":0,"unit_price":0.0,"custom_fields":[{"name":"CustomField","value":"CustomValue"}]}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemextensiv-3pl-central"}},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"custom_fields":{"type":"array","description":"List of the custom fields","example":[{"name":"CustomField","value":"CustomValue"}],"items":{"$ref":"#/components/schemas/CustomField"}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"total_discount":{"type":"number","description":"The total amount discounted from the order.","example":2.5},"total_shipping":{"type":"number","description":"The total shipping cost for the order incurred by the customer.","example":3.5},"total_tax":{"type":"number","description":"The total tax on the order.","example":1.5},"gift_message":{"type":"string","description":"Gift message","example":"gift_message"},"earliest_ship_date":{"type":"string","format":"date-time","description":"The projected ship date of the order","example":"2023-03-15T13:45:30Z"},"ship_cancel_date":{"type":"string","format":"date-time","description":"Ship cancel date","example":"2023-03-15T13:45:30Z"},"purchase_order_number":{"type":"string","description":"Purchase order number","example":"purchase_order_number"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressExtensiv"},"notes":{"type":"string","description":"Notes","example":"notes"}},"additionalProperties":false,"title":"Extensiv (3PL Central)"},"UpdatewmsOrder--FFE--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressFfe"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"external_id":"retail item number"}],"items":{"$ref":"#/components/schemas/WmsOrderCreateLineItemffe"}},"notes":{"type":"array","description":"List of notes associated with the order.","example":["note_1","note_2"],"items":{"type":"string","description":"A note associated with the order.","example":"note"}},"purchase_order_number":{"type":"string","description":"The purchase order number associated with the order.","example":"PO123"},"is_edi":{"type":"boolean","description":"Whether the order is an EDI order.","example":false},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Maps to FFE's PreferredCarrierId. Use GET /wms/shipping-methods (carrier_id) to find valid IDs. If omitted, the carrier is inferred from the shipping_method_id composite.","example":"fedex"},"shipping_method_id":{"type":["string","null"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Maps to FFE's PreferredCarrierServiceTypeId. Pass the id field returned by GET /wms/shipping-methods, which has the composite format '{carrier_id}-{service_type_id}'. A bare service_type_id (e.g. '21') is also accepted, in which case carrier_id should be supplied separately.","example":"fedex_ground"}},"required":["line_items"],"additionalProperties":false,"title":"FFE"},"UpdateShipToAddressGobolt":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"},"email_address":{"type":"string","description":"","example":"email_address"}},"additionalProperties":false,"title":"UpdateShipToAddressGobolt"},"UpdatewmsOrder--GoBolt--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"signature_required":{"type":"boolean","description":"","example":true},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"notes":{"type":"string","description":"","example":"notes"},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"ship_to_address":{"$ref":"#/components/schemas/UpdateShipToAddressGobolt"}},"additionalProperties":false,"title":"GoBolt"},"UpdatewmsOrder--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddressInfoplus"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressInfoplus"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineIteminfoplus"}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"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"}},"customer_po_number":{"type":"string","description":"Customer's purchase order number","example":"customer_po_number"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"gift_message":{"type":"string","description":"Gift message","example":"gift_message"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"Infoplus"},"UpdatewmsOrder--Logiwa--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressLogiwa"},"status":{"type":"string","enum":["open","confirmed","processing","fulfilled","cancelled","exception"],"description":"The status of the order. See the [order information](info) for more details.","example":"open"}},"required":["warehouse_id"],"additionalProperties":false,"title":"Logiwa"},"UpdatewmsOrder--Logiwa__IO--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"order_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"notes":{"type":"string","description":"","example":"notes"},"shipment_order_type":{"type":"string","description":"","example":"shipment_order_type"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"pack_type":"Each","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemlogiwa-io"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressLogiwa-Io"}},"required":["line_items","order_date","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Logiwa IO"},"UpdateOrderShipToAddressLuminous":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"required":["address1","city","country"],"additionalProperties":false,"title":"UpdateOrderShipToAddressLuminous"},"UpdatewmsOrder--Luminous--":{"type":"object","properties":{"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":{}},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"ship_to_address":{"$ref":"#/components/schemas/UpdateOrderShipToAddressLuminous"}},"additionalProperties":false,"title":"Luminous"},"UpdatewmsOrder--MasonHub--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressMasonhub"},"type":{"type":"string","default":"customer","enum":["customer","destroy","packAndHold","quarantine","returnToVendor","transfer","wholesale","workOrder","dropship"],"description":"The type of order.","example":"customer"},"carrier_id":{"type":"string","default":"masonhub","enum":["rate_shop","masonhub","UPS","USPS","FEDEX","DHL","willCall"],"description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"FEDEX"},"service_level":{"type":"string","enum":["economy","nextDayAirEarlyAM","nextDay","guaranteedNextDay","standardOvernight","priorityOvernight","2-day","2day","3-day","3day","guaranteed2Day","ground","groundSelect","groundPlus","priority","LTL","FTL","willCall","international"],"description":"The type of shipping method requested by the customer.","example":"2-day"},"priority":{"type":"integer","default":100,"minimum":1,"maximum":10000,"description":"The priority number of the order. 1 is the highest priority and should only be used in special circumstances.","example":0},"shipping_address_type":{"type":"string","default":"residential","enum":["business","residential"],"description":"Business or residential address.","example":"residential"},"passthrough_fields":{"type":"object","description":"Use this object to pass fields directly to the underlying API. You will have to read the API's documentation to know what fields are available, and cannot override fields that are managed by Trackstar.","example":{"custom_field_1":"value1","custom_field_2":123},"additionalProperties":{}}},"required":["service_level","ship_to_address"],"additionalProperties":false,"title":"MasonHub"},"UpdatewmsOrder--Mintsoft--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemmintsoft"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressMintsoft"},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelSchema"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"notes":{"type":"string","description":"A note to attach to the order","example":"notes"},"delivery_notes":{"type":"string","description":"Delivery instructions, passed to the courier where supported","example":"delivery_notes"},"gift_messages":{"type":"string","description":"Gift message printed on the despatch note","example":"gift_messages"}},"additionalProperties":false,"title":"Mintsoft"},"UpdatewmsOrder--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"delivery_date":{"type":"string","format":"date-time","description":"Expected delivery date","example":"2023-03-15T13:45:30Z"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemongoing"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressOngoing"}},"required":["order_number"],"additionalProperties":false,"title":"Ongoing WMS"},"UpdatewmsOrder--Packiyo--":{"type":"object","properties":{"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":{}},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItempackiyo"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressPackiyo"}},"additionalProperties":false,"title":"Packiyo"},"UpdatewmsOrder--Picqer--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"ship_to_address":{"$ref":"#/components/schemas/OrderShipToAddressPicqer"}},"additionalProperties":false,"title":"Picqer"},"UpdatewmsOrder--Shipfusion--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipfusion"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipfusion"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"channel_object":{"$ref":"#/components/schemas/ShipfusionCreateOrderChannelObject"},"extra_data":{"type":"object","description":"Free-form fields passed through to Shipfusion's `extraData` as-is.","example":{"Channel_type":"SHOPIFY","shopifyTags":[]},"additionalProperties":{}}},"required":["line_items","order_number","ship_to_address","warehouse_id"],"additionalProperties":false,"title":"Shipfusion"},"UpdateOrderShipToAddressShiphero":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"UpdateOrderShipToAddressShiphero"},"WmsOrderUpdateLineItemshiphero":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"unit_price":{"type":"number","description":"","example":0.0},"warehouse_id":{"type":"string","description":"Warehouse ID to ship item from","example":"warehouse_id"},"quantity_pending_fulfillment":{"type":"integer","description":"Number of units on this line item still pending fulfillment.","example":0}},"required":["quantity","sku","unit_price"],"additionalProperties":false,"title":"WmsOrderUpdateLineItemshiphero"},"ShipmentMeasurementsshiphero":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the shipment.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the shipment.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ShipmentMeasurementsshiphero"},"Label":{"type":"object","properties":{"paper_pdf_location":{"type":"string","description":"","example":"paper_pdf_location"},"thermal_pdf_location":{"type":"string","description":"","example":"thermal_pdf_location"},"pdf_location":{"type":"string","description":"","example":"pdf_location"},"image_location":{"type":"string","description":"","example":"image_location"}},"additionalProperties":false,"title":"Label"},"Labels":{"type":"object","properties":{"shipment_id":{"type":"string","description":"","example":"shipment_id"},"carrier_id":{"type":"string","description":"The carrier used to ship the package","example":"carrier_id"},"shipping_method_id":{"type":"string","description":"","example":"shipping_method_id"},"shipping_method_name":{"type":"string","description":"","example":"shipping_method_name"},"shipping_cost":{"type":"number","description":"","example":0.0},"measurements":{"$ref":"#/components/schemas/ShipmentMeasurementsshiphero"},"label":{"$ref":"#/components/schemas/Label"},"skus":{"type":"array","description":"The skus associated with the label.","example":["sku_1","sku_2"],"items":{"type":"string","description":"","example":"skus"}},"tracking_number":{"type":"string","description":"","example":"tracking_number"}},"required":["measurements","shipment_id","shipping_cost","skus"],"additionalProperties":false,"title":"Labels"},"OrderHolds":{"type":"object","properties":{"address_hold":{"type":"boolean","description":"Address hold","example":true},"payment_hold":{"type":"boolean","description":"Payment hold","example":true},"operator_hold":{"type":"boolean","description":"Operator hold","example":true},"fraud_hold":{"type":"boolean","description":"Fraud hold","example":true},"client_hold":{"type":"boolean","description":"Client hold","example":true}},"additionalProperties":false,"title":"OrderHolds"},"UpdatewmsOrder--ShipHero--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/UpdateOrderShipToAddressShiphero"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0,"warehouse_id":"warehouse_id","quantity_pending_fulfillment":0}],"items":{"$ref":"#/components/schemas/WmsOrderUpdateLineItemshiphero"}},"labels":{"type":"array","description":"List of labels to be created for the shipment. If labels are provided, no other fields can be updated.","items":{"$ref":"#/components/schemas/Labels"}},"order_holds":{"$ref":"#/components/schemas/OrderHolds"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"status":{"type":"string","enum":["fulfilled"],"description":"The status of the order. See the [order information](info) for more details.","example":"fulfilled"},"packing_note":{"type":"string","description":"Packing Note for the order","example":"packing_note"},"gift_note":{"type":"string","description":"Gift note for the order","example":"gift_note"},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"hold_until_date":{"type":"string","format":"date-time","description":"Date before which shiphero should not fulfill the order. Shiphero reads the time of day in the warehouse account's own timezone, so it comes back shifted by that offset.","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ShipHero"},"UpdateOrderShipToAddressShipmonk":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"UpdateOrderShipToAddressShipmonk"},"UpdatewmsOrder--ShipMonk--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"name":"name","unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipmonk"}},"ship_to_address":{"$ref":"#/components/schemas/UpdateOrderShipToAddressShipmonk"}},"additionalProperties":false,"title":"ShipMonk"},"WmsOrderUpdateLineItemshipping-tree":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderUpdateLineItemshipping-tree"},"UpdatewmsOrder--ShippingTree--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderUpdateLineItemshipping-tree"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipping-Tree"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"additionalProperties":false,"title":"ShippingTree"},"UpdateBillingAddressShipstation":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"address1":{"type":"string","description":"","example":"123 Main St"},"address2":{"type":["string","null"],"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","postal_code","state"],"additionalProperties":false,"title":"UpdateBillingAddressShipstation"},"UpdateOrderShipToAddressShipstation":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"address1":{"type":"string","description":"","example":"123 Main St"},"address2":{"type":["string","null"],"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","postal_code","state"],"additionalProperties":false,"title":"UpdateOrderShipToAddressShipstation"},"WmsOrderUpdateLineItemshipstation":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity of the item","example":0},"sku":{"type":"string","description":"The SKU of the item","example":"sku"},"unit_price":{"type":"number","description":"The price of the product","example":10.99},"set_or_update_customs_value":{"type":"boolean","description":"Set or update customs value","example":true},"country_of_origin":{"type":"string","description":"The product country of origin, required if existing customs item does not exist","example":"country_of_origin"},"harmonized_tariff_code":{"type":"string","description":"The harmonized tariff code for the item","example":"harmonized_tariff_code"},"customs_description":{"type":"string","description":"The customs description for the item","example":"customs_description"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderUpdateLineItemshipstation"},"UpdatewmsOrder--ShipStation--":{"type":"object","properties":{"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":{}},"skip_retrieval":{"type":"boolean","default":false,"description":"Skip resource retrieval after successful create operation","example":false},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"required_ship_date":{"type":"string","format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"bill_to_address":{"$ref":"#/components/schemas/UpdateBillingAddressShipstation"},"ship_to_address":{"$ref":"#/components/schemas/UpdateOrderShipToAddressShipstation"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"quantity":0,"sku":"sku","unit_price":10.99,"set_or_update_customs_value":true,"country_of_origin":"country_of_origin","harmonized_tariff_code":"harmonized_tariff_code","customs_description":"customs_description"}],"items":{"$ref":"#/components/schemas/WmsOrderUpdateLineItemshipstation"}}},"additionalProperties":false,"title":"ShipStation"},"UpdatewmsOrder--ShipStream--":{"type":"object","properties":{"custom_fields":{"type":"string","description":"Connect an account to see custom fields.","example":"custom_fields"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipstream"},"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":{}}},"additionalProperties":false,"title":"ShipStream"},"UpdatewmsOrder--Shipwire--":{"type":"object","properties":{"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":{}},"order_number":{"type":"string","minLength":1,"maxLength":25,"description":"A user-friendly identifier for their order.","example":"order_number"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressShipwire"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemshipwire"}}},"additionalProperties":false,"title":"Shipwire"},"UpdatewmsOrder--SKUSavvy--":{"type":"object","properties":{"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressSkusavvy"},"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":{}}},"additionalProperties":false,"title":"SKUSavvy"},"UpdatewmsOrder--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"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":{}},"status":{"type":"string","enum":["open","confirmed","processing","fulfilled","exception","cancelled"],"description":"The status of the order. See the [order information](info) for more details.","example":"open"}},"required":["status"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"UpdatewmsOrder--Sojo--":{"type":"object","properties":{"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":{}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"memo":{"type":"string","description":"A note or memo that will be added to the order for internal use","example":"memo"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"expected_ship_date":{"type":"string","format":"date","description":"The date when the shipment is expected to be dispatched.","example":"2023-03-15"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemsojo"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressSojo"}},"additionalProperties":false,"title":"Sojo"},"UpdateOrderShipToAddressTlogistics":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"UpdateOrderShipToAddressTlogistics"},"UpdatewmsOrder--TLogistics--":{"type":"object","properties":{"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":{}},"trading_partner":{"type":"string","description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"ship_to_address":{"$ref":"#/components/schemas/UpdateOrderShipToAddressTlogistics"}},"required":["ship_to_address"],"additionalProperties":false,"title":"TLogistics"},"UpdateShipToAddressUnleashed":{"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":["country"],"additionalProperties":false,"title":"UpdateShipToAddressUnleashed"},"WmsOrderUpdateLineItemunleashed":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderUpdateLineItemunleashed"},"UpdatewmsOrder--Unleashed--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/UpdateShipToAddressUnleashed"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderUpdateLineItemunleashed"}},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"}},"additionalProperties":false,"title":"Unleashed"},"UpdatewmsOrder--Veeqo--":{"type":"object","properties":{"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":{}},"channel_object":{"description":"The channel the order was placed on.","$ref":"#/components/schemas/ChannelIdSchema"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressVeeqo"},"order_number":{"type":"string","description":"A user-friendly identifier for their order.","example":"order_number"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","unit_price":0.0,"quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemveeqo"}},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"}},"additionalProperties":false,"title":"Veeqo"},"WmsOrderUpdateLineItemveracore":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderUpdateLineItemveracore"},"UpdatewmsOrder--VeraCore--":{"type":"object","properties":{"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsOrderUpdateLineItemveracore"}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressVeracore"},"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":{}}},"additionalProperties":false,"title":"VeraCore"},"UpdatewmsOrder--Warehance--":{"type":"object","properties":{"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":{}},"service_level":{"type":"string","description":"The type of shipping method requested by the customer.","example":"Standard"},"shipping_method_id":{"type":"string","description":"Use service_level instead.","example":"shipping_method_id"},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"additionalProperties":false,"title":"Warehance"},"UpdatewmsOrder--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Can pass in either shipping_method_id or shipping_method_name + carrier_id","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. Can pass in either shipping_method_id or shipping_method_name + carrier_id","example":"FedEx Ground"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Can pass in either shipping_method_id or shipping_method_name + carrier_id","example":"fedex"},"order_type":{"type":"string","enum":["direct_to_consumer","dropship","retail","transfer","value_added_service","wholesale"],"description":"The type of order.","example":"direct_to_consumer"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressWhiplash"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":2,"unit_price":2}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemwhiplash"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"}},"additionalProperties":false,"title":"Whiplash (Ryder)"},"UpdatewmsOrder--Zenventory--":{"type":"object","properties":{"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":{}},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddressZenventory"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":2}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemzenventory"}},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"}},"required":["line_items","ship_to_address"],"additionalProperties":false,"title":"Zenventory"},"UpdatewmsOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdatewmsOrder--WMS__Sandbox--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Amphora--"},{"$ref":"#/components/schemas/UpdatewmsOrder--BlueBox__-_IDrive__Fulfillment_---"},{"$ref":"#/components/schemas/UpdatewmsOrder--Boxzooka--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Clarus--"},{"$ref":"#/components/schemas/UpdatewmsOrder--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/UpdatewmsOrder--Darwynn__Fulfillment--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/UpdatewmsOrder--Deposco--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/UpdatewmsOrder--FFE--"},{"$ref":"#/components/schemas/UpdatewmsOrder--GoBolt--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Infoplus--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Logiwa--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Logiwa__IO--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Luminous--"},{"$ref":"#/components/schemas/UpdatewmsOrder--MasonHub--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Mintsoft--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Ongoing__WMS--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Packiyo--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Picqer--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Shipfusion--"},{"$ref":"#/components/schemas/UpdatewmsOrder--ShipHero--"},{"$ref":"#/components/schemas/UpdatewmsOrder--ShipMonk--"},{"$ref":"#/components/schemas/UpdatewmsOrder--ShippingTree--"},{"$ref":"#/components/schemas/UpdatewmsOrder--ShipStation--"},{"$ref":"#/components/schemas/UpdatewmsOrder--ShipStream--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Shipwire--"},{"$ref":"#/components/schemas/UpdatewmsOrder--SKUSavvy--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Linnworks__Core__-_SKUVault_---"},{"$ref":"#/components/schemas/UpdatewmsOrder--Sojo--"},{"$ref":"#/components/schemas/UpdatewmsOrder--TLogistics--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Unleashed--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Veeqo--"},{"$ref":"#/components/schemas/UpdatewmsOrder--VeraCore--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Warehance--"},{"$ref":"#/components/schemas/UpdatewmsOrder--Whiplash__-_Ryder_---"},{"$ref":"#/components/schemas/UpdatewmsOrder--Zenventory--"}],"title":"UpdatewmsOrderInputSchema"},"WmsBillsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsBillApiItemSchema"}},"additionalProperties":false,"title":"WmsBillsSingleItemEndpoint"},"CarrierInvoiceLineItemIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"CarrierInvoiceLineItemIdsQueryParam"},"CarrierInvoiceLineItemCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierInvoiceLineItemCreated_DateQueryParam"},"CarrierInvoiceLineItemUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierInvoiceLineItemUpdated_DateQueryParam"},"CarrierInvoiceLineItemTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierInvoiceLineItemTrackstar_Created_DateQueryParam"},"CarrierInvoiceLineItemTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierInvoiceLineItemTrackstar_Updated_DateQueryParam"},"CarrierInvoiceLineItemTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"CarrierInvoiceLineItemTrackstar_Tags_FlatQueryParam"},"CarrierInvoiceLineItemTransaction_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2025-11-15T00:00:00Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"CarrierInvoiceLineItemTransaction_DateQueryParam"},"CarrierInvoiceLineItemApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the invoice line item.","example":"invoice_line_item_id"},"created_date":{"type":"string","format":"date-time","description":"The date the invoice line item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the invoice line item was last updated.","example":"2022-01-02T05:05:05Z"},"transaction_date":{"type":"string","format":"date-time","description":"The transaction date of the invoice line item.","example":"2025-11-15T00:00:00Z"},"account_id":{"type":"string","description":"The account ID associated with the invoice line item.","example":"account_id"},"invoice_id":{"type":"string","description":"The invoice ID.","example":"invoice_id"},"tracking_number":{"type":["string","null"],"description":"The tracking number associated with the invoice line item.","example":"tracking_number"},"gross_cost":{"type":"number","description":"The gross cost of the invoice line item.","example":10.0},"net_cost":{"type":"number","description":"The net cost of the invoice line item.","example":8.0},"charge_description":{"type":"string","description":"Description of the charge.","example":"Freight Charge"},"raw":{"description":"The raw invoice line item data."},"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":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["account_id","charge_description","created_date","gross_cost","id","invoice_id","net_cost","raw","tracking_number","trackstar_created_date","trackstar_tags","trackstar_updated_date","transaction_date","updated_date"],"additionalProperties":false,"title":"CarrierInvoiceLineItemApiItemSchema"},"CarrierInvoiceLineItemsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/CarrierInvoiceLineItemApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"CarrierInvoiceLineItemsListEndpoint"},"DeleteMagic_LinkResponse":{"type":"object","properties":{"id":{"type":"string","description":"The id of the deleted object.","example":"example-id-123"},"object":{"type":"string","description":"The type of the object that was deleted.","example":"magic_link"},"deleted":{"type":"boolean","description":"Whether or not the object was deleted.","example":true}},"required":["deleted","id","object"],"additionalProperties":false,"title":"DeleteMagic_LinkResponse"},"SyncJob":{"type":"object","properties":{"id":{"type":"string","description":"The sync job ID.","example":"550e8400-e29b-41d4-a716-446655440000"},"connection_id":{"type":"string","description":"The connection ID for the sync job.","example":"07b344db-0304-4866-9ae1-ac8af5292a28"},"function_name":{"type":"string","description":"The function being synced.","example":"get_orders"},"status":{"type":"string","enum":["open","cancelled","completed","stuck"],"description":"The job status.","example":"open"},"requested_start_time":{"type":"string","description":"Start of the sync range.","example":"2024-01-01T00:00:00Z"},"requested_end_time":{"type":"string","description":"End of the sync range.","example":"2024-01-31T23:59:59Z"},"created_at":{"type":"string","description":"When the job was created.","example":"2024-01-15T12:00:00Z"},"completed_at":{"type":["string","null"],"description":"When the job completed.","example":"2024-01-15T12:05:00Z"},"cancelled_at":{"type":["string","null"],"description":"When the job was cancelled.","example":"2024-01-15T12:05:00Z"}},"required":["connection_id","created_at","function_name","id","requested_end_time","requested_start_time","status"],"additionalProperties":false,"title":"SyncJob"},"OnDemandSyncResponseSchema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SyncJob"}},"required":["data"],"additionalProperties":false,"title":"OnDemandSyncResponseSchema"},"DateRangeSyncInputSchema":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","description":"The start time for the sync range.","example":"2023-03-15T13:45:30Z"},"end_time":{"type":"string","format":"date-time","description":"The end time for the sync range.","example":"2023-03-15T13:45:30Z"},"function_name":{"type":"string","description":"The function to sync.","example":"function_name"}},"required":["end_time","function_name","start_time"],"additionalProperties":false,"title":"DateRangeSyncInputSchema"},"OnDemandSyncsResponseSchema":{"type":"object","properties":{"data":{"type":"array","description":"List of on-demand sync jobs","items":{"$ref":"#/components/schemas/SyncJob"}}},"required":["data"],"additionalProperties":false,"title":"OnDemandSyncsResponseSchema"},"CartOrdersSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CartOrderApiItemSchema"}},"additionalProperties":false,"title":"CartOrdersSingleItemEndpoint"},"ErpPurchaseOrderReceiptIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"ErpPurchaseOrderReceiptIdsQueryParam"},"ErpPurchaseOrderReceiptCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptCreated_DateQueryParam"},"ErpPurchaseOrderReceiptUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptUpdated_DateQueryParam"},"ErpPurchaseOrderReceiptTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptTrackstar_Created_DateQueryParam"},"ErpPurchaseOrderReceiptTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptTrackstar_Updated_DateQueryParam"},"ErpPurchaseOrderReceiptTrackstar_Tags_FlatQueryParam":{"type":"object","properties":{"contains":{"type":"array","description":"Comma-separated.","example":"tag_1,tag_2:value_2","items":{"type":"string","description":"","example":"contains"}},"not_contains":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"not_contains"}}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptTrackstar_Tags_FlatQueryParam"},"ErpPurchaseOrderReceiptPurchase_Order_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"po_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptPurchase_Order_IdQueryParam"},"ErpPurchaseOrderReceiptReceipt_NumberQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"RCPT1001"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptReceipt_NumberQueryParam"},"ErpPurchaseOrderReceiptReceived_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2024-05-08T00:00:00Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptReceived_DateQueryParam"},"ErpPurchaseOrderReceiptLineItem":{"type":"object","properties":{"receipt_line_item_id":{"type":"string","description":"ID of the line within the receipt record.","example":"receipt_line_item_id"},"line_item_id":{"type":["string","null"],"description":"ID of the source purchase-order line that this receipt line fulfills. Joins back to the parent purchase order's `line_items[*].id`. Null when the ERP doesn't expose the link.","example":"line_item_id"},"item_id":{"type":"string","description":"ID of the inventory item received.","example":"item_id"},"sku":{"type":"string","description":"SKU / item number of the item received.","example":"sku"},"quantity":{"type":"number","description":"Quantity received on this line.","example":0.0},"lot_id":{"type":["string","null"],"description":"ID of the lot this line was booked into. Null for non-lot-tracked items.","example":"lot_id"},"lot_name":{"type":["string","null"],"description":"Human-readable name of the lot this line was booked into.","example":"lot_name"},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiration date of the lot this line was booked into.","example":"2023-03-15T13:45:30Z"},"bin_id":{"type":["string","null"],"description":"ID of the bin this line was booked into. Null for non-bin-tracked items.","example":"bin_id"},"bin_name":{"type":["string","null"],"description":"Human-readable name of the bin this line was booked into.","example":"bin_name"}},"required":["bin_id","bin_name","expiration_date","item_id","line_item_id","lot_id","lot_name","quantity","receipt_line_item_id","sku"],"additionalProperties":false,"title":"ErpPurchaseOrderReceiptLineItem"},"ErpPurchaseOrderReceiptCustomFieldEntry":{"type":"object","properties":{"value":{"description":"The value of the custom field. Type matches the 'type' key."},"type":{"type":"string","description":"Type of the value as declared by the ERP.","example":"type"},"title":{"type":["string","null"],"description":"Human-readable label for the field, as declared by the ERP.","example":"title"}},"required":["title","type","value"],"additionalProperties":false,"title":"ErpPurchaseOrderReceiptCustomFieldEntry"},"ErpPurchaseOrderReceiptApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the receipt transaction in the ERP.","example":"rcpt_1"},"purchase_order_id":{"type":"string","description":"ID of the parent purchase order this receipt records against.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order receipt was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order receipt was last updated.","example":"2022-01-02T05:05:05Z"},"receipt_number":{"type":["string","null"],"description":"The user-facing identifier of the receipt as assigned by the ERP.","example":"RCPT1001"},"received_date":{"type":"string","format":"date-time","description":"Date the receipt was recorded in the ERP.","example":"2024-05-08T00:00:00Z"},"location_id":{"type":["string","null"],"description":"ID of the location the receipt was booked into.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the receipt.","example":["First partial"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"Items included in this receipt. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit receipt of one item booked into two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"receipt_line_item_id":"receipt_line_item_id","line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"lot_id":"lot_id","lot_name":"lot_name","expiration_date":"2023-03-15T13:45:30Z","bin_id":"bin_id","bin_name":"bin_name"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order receipt. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order receipt in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorderreceipt/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","custom_fields","external_system_url","id","line_items","location_id","notes","purchase_order_id","receipt_number","received_date","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"ErpPurchaseOrderReceiptApiItemSchema"},"ErpPurchaseOrderReceiptsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"ErpPurchaseOrderReceiptsListEndpoint"},"CreateErpPurchaseOrderReceiptResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the receipt transaction in the ERP.","example":"rcpt_1"},"purchase_order_id":{"type":"string","description":"ID of the parent purchase order this receipt records against.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order receipt was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order receipt was last updated.","example":"2022-01-02T05:05:05Z"},"receipt_number":{"type":["string","null"],"description":"The user-facing identifier of the receipt as assigned by the ERP.","example":"RCPT1001"},"received_date":{"type":"string","format":"date-time","description":"Date the receipt was recorded in the ERP.","example":"2024-05-08T00:00:00Z"},"location_id":{"type":["string","null"],"description":"ID of the location the receipt was booked into.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the receipt.","example":["First partial"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"Items included in this receipt. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit receipt of one item booked into two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"receipt_line_item_id":"receipt_line_item_id","line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"lot_id":"lot_id","lot_name":"lot_name","expiration_date":"2023-03-15T13:45:30Z","bin_id":"bin_id","bin_name":"bin_name"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order receipt. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order receipt in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorderreceipt/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","custom_fields","external_system_url","id","line_items","location_id","notes","purchase_order_id","receipt_number","received_date","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"CreateErpPurchaseOrderReceiptResponseDataSchema"},"erpCreatePurchaseOrderReceiptResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateErpPurchaseOrderReceiptResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpCreatePurchaseOrderReceiptResponse"},"WriteErpPurchaseOrderReceiptLineItemLot":{"type":"object","properties":{"lot_id":{"type":"string","description":"ID or name of the lot. Required when the item is lot-tracked. Used as the receipt's lot identifier; creates a new inventory number on the receiving ERP.","example":"lot_id"},"bin_id":{"type":"string","description":"ID of the bin to book into. Required when the item is bin-tracked. See GET /erp/inventory.bins[].","example":"bin_id"},"quantity":{"type":"number","minimum":0.0,"description":"Quantity booked into this (lot, bin) pair.","example":0.0}},"required":["quantity"],"additionalProperties":false,"title":"WriteErpPurchaseOrderReceiptLineItemLot"},"ErpPurchaseOrderReceiptCreateLineItem":{"type":"object","properties":{"line_item_id":{"type":"string","description":"","example":"line_item_id"},"item_id":{"type":"string","description":"","example":"item_id"},"quantity":{"type":"number","description":"","example":0.0},"lots":{"type":"array","minItems":1,"description":"Per-(lot, bin) breakdown of the line's quantity. Required when the item is lot-tracked or bin-tracked. The sum of lots[*].quantity must equal the line's quantity. Same lot_id may appear across multiple entries (split across bins); same bin_id may appear across multiple entries (holding multiple lots).","example":[{"lot_id":"TS-LOT-001","bin_id":"157","quantity":60.0}],"items":{"$ref":"#/components/schemas/WriteErpPurchaseOrderReceiptLineItemLot"}}},"required":["item_id","line_item_id","quantity"],"additionalProperties":false,"title":"ErpPurchaseOrderReceiptCreateLineItem"},"CreateErpPurchaseOrderReceiptSchema":{"type":"object","properties":{"purchase_order_id":{"type":"string","description":"ID of the parent purchase order this receipt records against.","example":"po_id"},"received_date":{"type":"string","format":"date-time","description":"Date the receipt was recorded in the ERP.","example":"2024-05-08T00:00:00Z"},"location_id":{"type":"string","description":"ID of the location the receipt was booked into.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the receipt.","example":["First partial"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"Items included in this receipt. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit receipt of one item booked into two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"line_item_id":"line_item_id","item_id":"item_id","quantity":0.0,"lots":[{"lot_id":"TS-LOT-001","bin_id":"157","quantity":60.0}]}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptCreateLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order receipt. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptCustomFieldEntry"}}},"required":["purchase_order_id"],"additionalProperties":false,"title":"CreateErpPurchaseOrderReceiptSchema"},"WmsReturnsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsReturnApiItemSchema"}},"additionalProperties":false,"title":"WmsReturnsSingleItemEndpoint"},"wmsUpdateReturnResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsReturnApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateReturnResponse"},"WmsSandboxUpdateReturnLineItems":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"sku","example":"XS-RED-SHIRT"},"expected_quantity":{"type":"integer","description":"","example":1},"return_reason":{"type":"string","description":"The reason for the return.","example":"damaged"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsSandboxUpdateReturnLineItems"},"UpdatewmsReturn--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"order_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"XS-RED-SHIRT","expected_quantity":1,"return_reason":"damaged"}],"items":{"$ref":"#/components/schemas/WmsSandboxUpdateReturnLineItems"}}},"additionalProperties":false,"title":"WMS Sandbox"},"UpdatewmsReturn--Boxzooka--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":1,"return_reason":"return_reason","condition":"condition"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemboxzooka"}},"tracking_number":{"type":"string","description":"The tracking number of the return shipment.","example":"1Z999AA10123456784"},"carrier":{"type":"string","description":"The carrier for the return shipment.","example":"carrier"}},"additionalProperties":false,"title":"Boxzooka"},"UpdatewmsReturn--Cirro--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"carrier_id":{"type":"string","description":"The carrier to use for the return shipment. One of carrier_id or carrier_name is required. Will take precedence over carrier_name if provided.","example":"UPS"},"carrier_name":{"type":"string","description":"The carrier to use for the return shipment","example":"UPS"},"tracking_number":{"type":"string","description":"The tracking number for the return shipment","example":"1Z12345E0205271688"},"reference_number":{"type":"string","description":"The reference number for the return shipment","example":"1234567890"},"ship_to_address":{"$ref":"#/components/schemas/ReturnShipToAddressCirro"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","platform_name":"SHOPIFY","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemcirro"}},"return_reason":{"type":"string","description":"The reason for the return. Damaged, Defective, Incorrect Item, etc.","example":"return_reason"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"}},"additionalProperties":false,"title":"Cirro"},"UpdatewmsReturn--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"tracking_number":{"type":"string","description":"tracking number for the return shipment","example":"tracking_number"},"carrier_name":{"type":"string","description":"carrier bringing the return back","example":"carrier_name"}},"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"UpdatewmsReturn--Deposco--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"ship_to_address":{"$ref":"#/components/schemas/ReturnShipToAddressDeposco"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","inventory_item_id":"inventory_item_id","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemdeposco"}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"number":{"type":"string","description":"An optional return number to use for the return. If not provided, a unique number will be generated.","example":"RMA123"},"return_reason":{"type":"string","description":"The reason for the return. RTS, Partial Customer Return, Full Customer Return","example":"return_reason"},"customer_order_number":{"type":"string","description":"The customer order number in Deposco","example":"PF#"},"tracking_number":{"type":"string","description":"The tracking number of the return","example":"9434636106023310081309"}},"required":["line_items"],"additionalProperties":false,"title":"Deposco"},"UpdatewmsReturn--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"return_type":{"type":"string","enum":["Job","Kit","Normal","Transfer","Blind"],"description":"Type of return","example":"Blind"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineIteminfoplus"}}},"required":["line_items","order_id","return_type","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Infoplus"},"UpdatewmsReturn--Logiwa__IO--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"rma_number":{"type":"string","description":"An optional RMA number. If not provided, a random one will be generated.","example":"rma_number"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemlogiwa-io"}},"tracking_number":{"type":"string","description":"The tracking number of the return.","example":"tracking_number"}},"additionalProperties":false,"title":"Logiwa IO"},"UpdatewmsReturn--Luminous--":{"type":"object","properties":{"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":{}},"restock":{"type":"boolean","description":"Whether receiving this return puts stock back into inventory.","example":true}},"required":["restock"],"additionalProperties":false,"title":"Luminous"},"UpdatewmsReturn--MasonHub--":{"type":"object","properties":{"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":{}},"return_type":{"type":"string","enum":["returned_to_sender","rma_submitted_by_customer","rma_created_by_distribution_center"],"description":"The type of return.","example":"returned_to_sender"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressMasonhub"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"damaged","return_inventory_status":"qc"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemmasonhub"}},"order_id":{"type":"string","description":"The ID of the original order.","example":"order_id"}},"required":["line_items","return_type","ship_from_address"],"additionalProperties":false,"title":"MasonHub"},"UpdatewmsReturn--Ongoing__WMS--":{"type":"object","properties":{"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_cause":null}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemongoing"}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"tracking_number":{"type":"string","description":"","example":"tracking_number"},"tracking_url":{"type":"string","description":"","example":"tracking_url"},"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":{}}},"additionalProperties":false,"title":"Ongoing WMS"},"UpdatewmsReturn--ShipBob--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"inventory_item_id","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipbob"}},"tracking_number":{"type":"string","description":"Tracking number of the return.","example":"tracking_number"}},"required":["line_items","warehouse_id"],"additionalProperties":false,"title":"ShipBob"},"UpdatewmsReturn--ShipHero--":{"type":"object","properties":{"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"open"},"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":{}}},"required":["status","trackstar_tags"],"additionalProperties":false,"title":"ShipHero"},"UpdatewmsReturn--ShipMonk--":{"type":"object","properties":{"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":{}},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"return_reason":{"type":"string","enum":["reason_exchange","reason_changed_mind","reason_undeliverable","reason_unknown","reason_incorrect_product"],"description":"Reason for the return.","example":"reason_changed_mind"},"tracking_number":{"type":"string","description":"The tracking number for the return.","example":"123456789"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"desired_action":"damaged_not_resellable"}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipmonk"}}},"required":["line_items","order_id","return_reason","warehouse_id"],"additionalProperties":false,"title":"ShipMonk"},"UpdatewmsReturn--ShipStream--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsReturnWriteLineItemshipstream"}},"carrier_id":{"type":"string","description":"Carrier ID. Will take precedence over carrier_name if passed.","example":"carrier_id"},"carrier_name":{"type":"string","description":"Carrier name.","example":"carrier_name"},"carrier_tracking_number":{"type":"string","description":"Carrier tracking number","example":"carrier_tracking_number"},"customer_name":{"type":"string","description":"Customer name","example":"customer_name"},"merchant_order_number":{"type":"string","description":"Merchant order number","example":"merchant_order_number"},"tracking_numbers":{"type":"array","description":"List of tracking numbers","items":{"type":"string","description":"","example":"tracking_numbers"}},"merchant_rma_number":{"type":"integer","description":"Merchant RMA number","example":0},"expected_arrival_date":{"type":"string","format":"date","description":"Expected arrival date","example":"2023-03-15"},"notes":{"type":"string","description":"Notes","example":"notes"}},"additionalProperties":false,"title":"ShipStream"},"UpdatewmsReturn--Whiplash__-_Ryder_---":{"type":"object","properties":{"requires_label":{"type":"boolean","description":"Whether or not a label is required.","example":true},"carrier_id":{"type":"string","default":"Whiplash","description":"The carrier for the return. Defaults to 'Whiplash'.","example":"Whiplash"},"tracking_number":{"type":"string","description":"","example":"tracking_number"},"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":{}}},"additionalProperties":false,"title":"Whiplash (Ryder)"},"UpdatewmsReturnInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdatewmsReturn--WMS__Sandbox--"},{"$ref":"#/components/schemas/UpdatewmsReturn--Boxzooka--"},{"$ref":"#/components/schemas/UpdatewmsReturn--Cirro--"},{"$ref":"#/components/schemas/UpdatewmsReturn--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/UpdatewmsReturn--Deposco--"},{"$ref":"#/components/schemas/UpdatewmsReturn--Infoplus--"},{"$ref":"#/components/schemas/UpdatewmsReturn--Logiwa__IO--"},{"$ref":"#/components/schemas/UpdatewmsReturn--Luminous--"},{"$ref":"#/components/schemas/UpdatewmsReturn--MasonHub--"},{"$ref":"#/components/schemas/UpdatewmsReturn--Ongoing__WMS--"},{"$ref":"#/components/schemas/UpdatewmsReturn--ShipBob--"},{"$ref":"#/components/schemas/UpdatewmsReturn--ShipHero--"},{"$ref":"#/components/schemas/UpdatewmsReturn--ShipMonk--"},{"$ref":"#/components/schemas/UpdatewmsReturn--ShipStream--"},{"$ref":"#/components/schemas/UpdatewmsReturn--Whiplash__-_Ryder_---"}],"title":"UpdatewmsReturnInputSchema"},"CarrierFilesSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CarrierFileWithUrlSchema"}},"additionalProperties":false,"title":"CarrierFilesSingleItemEndpoint"},"ErpVendorsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpVendorApiItemSchema"}},"additionalProperties":false,"title":"ErpVendorsSingleItemEndpoint"},"CartProductsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CartProductApiItemSchema"}},"additionalProperties":false,"title":"CartProductsSingleItemEndpoint"},"WebhookPayloadResponseSchema":{"type":"object","properties":{"download_url":{"type":"string","description":"Presigned download URL for the full webhook event, exactly as it would have been delivered (valid for 20 minutes).","example":"https://s3.amazonaws.com/..."},"download_url_expires_at":{"type":"string","format":"date-time","description":"Expiration timestamp for the download URL.","example":"2025-01-15T10:50:00Z"}},"required":["download_url","download_url_expires_at"],"additionalProperties":false,"title":"WebhookPayloadResponseSchema"},"WmsProductsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsProductApiItemSchema"}},"additionalProperties":false,"title":"WmsProductsSingleItemEndpoint"},"wmsUpdateProductResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsProductApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateProductResponse"},"UpdatewmsProduct--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"XS-RED-SHIRT"},"name":{"type":"string","description":"name","example":"XS Red Shirt"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"012345678905"},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"}},"additionalProperties":false,"title":"WMS Sandbox"},"UpdatewmsProduct--BEST__Inc.--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsbest-inc"}},"additionalProperties":false,"title":"BEST Inc."},"UpdatewmsProduct--Boxzooka--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsboxzooka"},{"type":"null"}]},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"}},"additionalProperties":false,"title":"Boxzooka"},"UpdatewmsProduct--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"customs_description":{"type":"string","description":"Customs description matching the harmonized code.","example":"Perfumes and toilet waters"},"cost":{"type":"number","description":"The production cost price of the product.","example":30.5},"active":{"type":"boolean","description":"Whether the product is active.","example":true}},"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"UpdatewmsProduct--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":"string","description":"sku","example":"sku"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsdear-systems"},{"type":"null"}]},"costing_method":{"type":"string","enum":["FIFO","Special - Batch","Special - Serial Number","FIFO - Serial Number","FIFO - Batch","FEFO - Batch","FEFO - Serial Number"],"description":"Costing method for the product.","example":"FEFO - Batch"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"UpdatewmsProduct--Deposco--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsdeposco"},{"type":"null"}]},"active":{"type":"boolean","default":true,"description":"Whether the product is active, defaults to True.","example":true}},"additionalProperties":false,"title":"Deposco"},"UpdatewmsProduct--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"}},"required":["warehouse_customer_id"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"UpdatewmsProduct--Flexport__-_Deliverr_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","maxLength":255,"description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsflexport"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","pattern":"^[0-9]{10}$","description":"The harmonized HS code of the product.","example":"0101210000"},"customs_value":{"type":"number","description":"The customs value of the product in USD. Required when providing customs information.","example":0.0},"customs_description":{"type":"string","maxLength":255,"description":"The customs description of the product. Required when providing customs information.","example":"customs_description"}},"additionalProperties":false,"title":"Flexport (Deliverr)"},"UpdatewmsProduct--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":"string","description":"ID of the warehouse customer that owns this product","example":"warehouse_customer_id"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsinfoplus"},"price":{"type":"number","description":"Price of the product","example":0.0}},"additionalProperties":false,"title":"Infoplus"},"UpdatewmsProduct--Cart.com__-_Jazz__Central_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"price":{"type":"number","description":"The price of the product.","example":1.0}},"required":["gtin","sku"],"additionalProperties":false,"title":"Cart.com (Jazz Central)"},"UpdatewmsProduct--Linnworks--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99},"extended_properties":{"type":"array","description":"Custom properties to attach to the product","example":[{"name":"Color","value":"Red","type":"Attribute"}],"items":{"$ref":"#/components/schemas/ExtendedPropertySchema"}},"measurements":{"$ref":"#/components/schemas/ProductMeasurementslinnworks"}},"additionalProperties":false,"title":"Linnworks"},"UpdatewmsProduct--Logiwa__IO--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"description":{"type":"string","description":"","example":"description"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"additionalProperties":false,"title":"Logiwa IO"},"UpdatewmsProduct--Luminous--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsluminous"},"category_id":{"type":"integer","minimum":1,"description":"The ID of the Luminous category the product belongs to.","example":1}},"additionalProperties":false,"title":"Luminous"},"UpdatewmsProduct--MasonHub--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsmasonhub"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"description":{"type":"string","description":"Description of the product.","example":"description"},"customer_bar_code":{"type":"string","description":"Customer provided bar code for this sku.","example":"customer_bar_code"},"brand_name":{"type":"string","description":"Brand name for this sku and product.","example":"brand_name"},"category":{"type":"string","description":"Product category for this sku.","example":"category"},"sub_category":{"type":"string","description":"Product sub category for this sku.","example":"sub_category"},"vendor_brand_code":{"type":"string","description":"Vendor provided brand code for identifying this sku.","example":"vendor_brand_code"},"customer_brand_code":{"type":"string","description":"Customer provided brand code for identifying this sku. Used on packing lists.","example":"customer_brand_code"},"vendor_style":{"type":"string","description":"Vendor style code for item identification.","example":"vendor_style"}},"required":["brand_name","category","customer_bar_code","customer_brand_code","description","measurements","name","sub_category","vendor_brand_code","vendor_style"],"additionalProperties":false,"title":"MasonHub"},"UpdatewmsProduct--Nimble--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"Required.","example":"123456789"},"vendor_sku":{"type":"string","description":"An external vendor SKU","example":"123456789"},"description":{"type":"string","description":"Description of the product","example":"Description"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"name":{"type":"string","description":"name","example":"name"},"measurements":{"$ref":"#/components/schemas/NimbleProductMeasurements"}},"required":["description","gtin","measurements"],"additionalProperties":false,"title":"Nimble"},"UpdatewmsProduct--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"additionalProperties":false,"title":"Ongoing WMS"},"UpdatewmsProduct--Portless--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsportless"}},"additionalProperties":false,"title":"Portless"},"UpdatewmsProduct--Shipfusion--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementsshipfusion"},{"type":"null"}]},"price":{"type":"number","description":"The retail price of the product","example":0.0}},"required":["name"],"additionalProperties":false,"title":"Shipfusion"},"UpdatewmsProduct--ShipHero--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshiphero"}},"additionalProperties":false,"title":"ShipHero"},"UpdatewmsProduct--ShipStream--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsshipstream"}},"additionalProperties":false,"title":"ShipStream"},"UpdatewmsProduct--SKUSavvy--":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsskusavvy"},"price":{"type":"number","description":"Price of the product","example":0.0}},"additionalProperties":false,"title":"SKUSavvy"},"UpdatewmsProduct--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"classification":{"type":"string","description":"Classification of the product. Defaults to 'General'","example":"classification"},"supplier_object":{"description":"The supplier of the product.","$ref":"#/components/schemas/SupplierSchema"},"brand":{"type":"string","description":"Brand name. Defaults to 'Generic'","example":"brand"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsskuvault"}},"required":["measurements"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"UpdatewmsProduct--TLogistics--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"country_of_origin":{"type":"string","description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":"string","description":"The harmonized HS code of the product.","example":"123456"},"measurements":{"anyOf":[{"$ref":"#/components/schemas/ProductMeasurementstlogistics"},{"type":"null"}]},"batch_required":{"type":"boolean","enum":[true],"description":"Whether tlogistics registers a batch code for the product when it is received. Only true is accepted.","example":true},"expiry_required":{"type":"boolean","description":"Whether tlogistics registers an expiry date for the product when it is received","example":true}},"additionalProperties":false,"title":"TLogistics"},"UpdatewmsProduct--Unleashed--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"measurements":{"$ref":"#/components/schemas/ProductMeasurementsunleashed"}},"additionalProperties":false,"title":"Unleashed"},"UpdatewmsProduct--Warehance--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"name"},"unit_price":{"type":"number","description":"The price of the product.","example":10.99}},"additionalProperties":false,"title":"Warehance"},"UpdatewmsProduct--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"sku":{"type":"string","description":"sku","example":"sku"},"name":{"type":"string","description":"","example":"name"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"}},"required":["gtin"],"additionalProperties":false,"title":"Whiplash (Ryder)"},"UpdatewmsProductInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdatewmsProduct--WMS__Sandbox--"},{"$ref":"#/components/schemas/UpdatewmsProduct--BEST__Inc.--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Boxzooka--"},{"$ref":"#/components/schemas/UpdatewmsProduct--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/UpdatewmsProduct--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/UpdatewmsProduct--Deposco--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/UpdatewmsProduct--Flexport__-_Deliverr_---"},{"$ref":"#/components/schemas/UpdatewmsProduct--Infoplus--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Cart.com__-_Jazz__Central_---"},{"$ref":"#/components/schemas/UpdatewmsProduct--Linnworks--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Logiwa__IO--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Luminous--"},{"$ref":"#/components/schemas/UpdatewmsProduct--MasonHub--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Nimble--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Ongoing__WMS--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Portless--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Shipfusion--"},{"$ref":"#/components/schemas/UpdatewmsProduct--ShipHero--"},{"$ref":"#/components/schemas/UpdatewmsProduct--ShipStream--"},{"$ref":"#/components/schemas/UpdatewmsProduct--SKUSavvy--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Linnworks__Core__-_SKUVault_---"},{"$ref":"#/components/schemas/UpdatewmsProduct--TLogistics--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Unleashed--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Warehance--"},{"$ref":"#/components/schemas/UpdatewmsProduct--Whiplash__-_Ryder_---"}],"title":"UpdatewmsProductInputSchema"},"AllowedOperators":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"shipbob"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}}},"additionalProperties":false,"title":"AllowedOperators"},"IntegrationSpecificFields":{"type":"object","properties":{"properties":{"type":"object","description":"The integration specific fields and their definitions.","example":{"warehouse_id":{"title":"warehouse_id","type":"string","description":"The warehouse this order was shipped from.","example":"","enum":["N/A - Connect an account to see options"]}},"additionalProperties":{}},"type":{"type":"string","description":"The type of the integration specific fields.","example":"object"},"required_fields":{"type":"array","description":"The required fields for the integration specific fields.","example":["warehouse_id"],"items":{"type":"string","description":"Field required for the integration specific fields.","example":"required_fields"}}},"required":["properties","type"],"additionalProperties":false,"title":"IntegrationSpecificFields"},"WriteOperation":{"type":"object","properties":{"action":{"type":"string","description":"The action that can be performed.","example":"create_order"},"url":{"type":"string","description":"The URL for the action.","example":"POST /wms/orders"},"required_base_schema_fields":{"type":"array","description":"The required fields for the action.","example":["line_items.product_id","line_items.quantity"],"items":{"type":"string","description":"Field required for the action.","example":"required_base_schema_fields"}},"optional_base_schema_fields":{"type":"array","description":"The optional fields for the action.","example":["order_number","line_items","trading_partner"],"items":{"type":"string","description":"Field optional for the action.","example":"optional_base_schema_fields"}},"integration_specific_fields":{"$ref":"#/components/schemas/IntegrationSpecificFields"}},"required":["action","integration_specific_fields","optional_base_schema_fields","required_base_schema_fields","url"],"additionalProperties":false,"title":"WriteOperation"},"ListOperation":{"type":"object","properties":{"action":{"type":"string","description":"The action that can be performed.","example":"get_inventory"},"url":{"type":"string","description":"The URL for the action.","example":"GET /wms/inventory"},"implemented_fields":{"type":"object","description":"The fields that are implemented for the action.","example":{"onhand":true,"lots":[{"lot_id":true,"expiration_date":true,"onhand":true,"warehouse_id":true}],"substitute_skus":false,"inventory_by_warehouse_id":{"key":{"committed":true,"fulfillable":true,"onhand":true,"awaiting":true,"unfulfillable":true,"sellable":true}},"sellable":true,"created_date":true,"fulfillable":true,"trackstar_created_date":true,"awaiting":true,"name":true,"locations":[{"location_id":true,"quantity":true,"warehouse_id":true}],"active":true,"committed":true,"measurements":false,"unfulfillable":true,"warehouse_customer_id":true,"trackstar_updated_date":true,"id":true,"connection_id":true,"external_system_url":false,"sku":true,"updated_date":true},"additionalProperties":{"description":"A Boolean indicating if the field is implemented, or an object or list with more details."}}},"required":["action","implemented_fields","url"],"additionalProperties":false,"title":"ListOperation"},"IntegrationInfo":{"type":"object","properties":{"integration_name":{"type":"string","description":"The name of the integration.","example":"shipbob"},"display_name":{"type":"string","description":"The display name of the integration.","example":"ShipBob"},"install_method":{"type":"string","enum":["input","oauth"],"description":"How users install the integration within the Trackstar Modal.","example":"input"},"description":{"type":"string","description":"A description of the integration.","example":"description"},"logo_url":{"type":"string","description":"The URL of the integration's logo.","example":"https://example.com/logo.png"},"installation_guide_url":{"type":["string","null"],"description":"The URL of the installation guide.","example":"https://trackstar.notion.site"},"docs":{"description":"The documentation for the integration. Can be a string or a dictionary of strings. May not be available"},"write_operations":{"type":"array","description":"The write operations supported by the integration.","items":{"$ref":"#/components/schemas/WriteOperation"}},"list_operations":{"type":"array","description":"The list operations supported by the integration.","items":{"$ref":"#/components/schemas/ListOperation"}},"available_actions":{"type":"array","description":"The actions supported by the integration.","example":["create_order","get_inventory"],"items":{"type":"string","description":"Action supported by the integration","example":"available_actions"}}},"required":["available_actions","description","display_name","docs","install_method","installation_guide_url","integration_name","list_operations","logo_url","write_operations"],"additionalProperties":false,"title":"IntegrationInfo"},"IntegrationsResponseSchema":{"type":"object","properties":{"data":{"type":"array","description":"Integration Info","items":{"$ref":"#/components/schemas/IntegrationInfo"}}},"required":["data"],"additionalProperties":false,"title":"IntegrationsResponseSchema"},"AttachFileOrderResponse":{"type":"object","properties":{"data":{"type":"string","enum":["success"],"description":"Status of the file attachment","example":"success"},"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":"","example":"unused_fields"}}},"required":["data","id","unused_fields"],"additionalProperties":false,"title":"AttachFileOrderResponse"},"AttachFileSchema":{"type":"object","properties":{"file_url":{"type":"string","description":"The URL of the file to attach.","example":"file_url"},"file_name":{"type":"string","description":"The name of the file to attach.","example":"file_name"},"file":{"type":"string","format":"binary"}},"additionalProperties":true,"title":"AttachFileSchema"},"WmsInboundShipmentSupplierIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsInboundShipmentSupplierIdsQueryParam"},"WmsInboundShipmentSupplierCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentSupplierCreated_DateQueryParam"},"WmsInboundShipmentSupplierUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentSupplierUpdated_DateQueryParam"},"WmsInboundShipmentSupplierTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentSupplierTrackstar_Created_DateQueryParam"},"WmsInboundShipmentSupplierTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsInboundShipmentSupplierTrackstar_Updated_DateQueryParam"},"WmsInboundShipmentSupplierWarehouse_Customer_IdQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"warehouse_cust_id"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsInboundShipmentSupplierWarehouse_Customer_IdQueryParam"},"WmsInboundShipmentSupplierApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique id of the supplier.","example":"inbound_shipment_supplier_id"},"name":{"type":["string","null"],"description":"The name of the supplier.","example":"inbound_shipment_supplier_name"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the supplier was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the supplier was last updated.","example":"2022-01-02T05:05:05Z"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","id","name","trackstar_created_date","trackstar_updated_date","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsInboundShipmentSupplierApiItemSchema"},"WmsInboundShipmentSuppliersListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsInboundShipmentSupplierApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsInboundShipmentSuppliersListEndpoint"},"GetConnectionsResponseonlydata":{"type":"object","properties":{"data":{"type":"array","description":"A list of connections for your organization.","example":[{"connection_id":"07b344db-0304-4866-9ae1-ac8af5292a28","integration_name":"integration_name","integration_display_name":"ShipBob","customer_id":"customer_id","created_at":"2023-01-01T00:00:00Z","last_used":"2023-01-01T00:00:00Z","times_used":1,"sync_schedules":[{"function_name":"get_inventory","last_crawl_start":"2023-01-01T00:00:00Z","last_crawl_end":"2023-01-01T00:00:00Z","latest_data":"2023-01-01T00:00:00Z","sync_frequency":3600,"sync_status":"enabled"}],"errors":[{"error_message":"error_message","affected_endpoints":[{"endpoint":"GET /connection","preventing_sync":false}],"first_seen":"2023-01-01T00:00:00Z","last_seen":"2023-01-01T00:00:00Z"}],"available_actions":["get_inventory","get_products"],"integration_type":"wms","webhooks_disabled":false,"historical_sync_completed":{"get_bills":true,"get_inbound_shipments":true,"get_inventory":true,"get_orders":true,"get_products":true,"get_returns":true,"get_warehouse_customers":true,"get_warehouse_locations":true,"get_warehouses":true},"me":{"account_id":"account_12345","account_name":"My WMS Account"}}],"items":{"$ref":"#/components/schemas/Connection"}}},"additionalProperties":false,"title":"GetConnectionsResponseonlydata"},"PackLineItem":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"inventory_item_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["inventory_item_id","quantity","sku"],"additionalProperties":false,"title":"PackLineItem"},"Pack":{"type":"object","properties":{"pack_id":{"type":"string","description":"The unique id of the package.","example":"package_id"},"measurements":{"$ref":"#/components/schemas/PackageMeasurements"},"line_items":{"type":"array","description":"A list of the inventory items included in the package.","items":{"$ref":"#/components/schemas/PackLineItem"}}},"required":["line_items","measurements","pack_id"],"additionalProperties":false,"title":"Pack"},"WmsOrderPackLineItem":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"product_id"},"sku":{"type":["string","null"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":1}},"required":["product_id","quantity","sku"],"additionalProperties":false,"title":"WmsOrderPackLineItem"},"OrderPackSchema":{"type":"object","properties":{"packs":{"type":"array","description":"A list of the packages included in the order.","items":{"$ref":"#/components/schemas/Pack"}},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier for the shipping method.","example":"carrier_id"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier for the shipping method.","example":"carrier_name"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code (SCAC) for the shipping method.","example":"scac"},"shipping_method_id":{"type":["string","null"],"description":"The ID of the shipping method.","example":"shipping_method_id"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method.","example":"shipping_method_name"},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"order_line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":1}],"items":{"$ref":"#/components/schemas/WmsOrderPackLineItem"}},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}}},"required":["additional_fields","carrier_id","carrier_name","order_line_items","packs","scac","ship_to_address","shipping_method_id","shipping_method_name"],"additionalProperties":false,"title":"OrderPackSchema"},"WmsOrderPacksSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrderPackSchema"}},"additionalProperties":false,"title":"WmsOrderPacksSingleItemEndpoint"},"ErpLocationsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpLocationApiItemSchema"}},"additionalProperties":false,"title":"ErpLocationsSingleItemEndpoint"},"ErpCustomersSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpCustomerApiItemSchema"}},"additionalProperties":false,"title":"ErpCustomersSingleItemEndpoint"},"ErpEmployeesSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpEmployeeApiItemSchema"}},"additionalProperties":false,"title":"ErpEmployeesSingleItemEndpoint"},"WmsInventorySingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsInventoryItemApiItemSchema"}},"additionalProperties":false,"title":"WmsInventorySingleItemEndpoint"},"wmsUpdateInventoryItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsInventoryItemApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateInventoryItemResponse"},"UpdatewmsInventoryItem--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"name","example":"XS Red Shirt"},"sku":{"type":"string","description":"sku","example":"XS-RED-SHIRT"},"unit_cost":{"type":"number","description":"The cost of a single unit of the inventory item.","example":1.0},"awaiting":{"type":"integer","description":"Inventory that the warehouse is awaiting delivery of.","example":0},"onhand":{"type":"integer","description":"The total amount of inventory in the warehouse.","example":5},"committed":{"type":"integer","description":"Inventory that is already assigned to orders.","example":1},"unfulfillable":{"type":"integer","description":"Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).","example":0},"fulfillable":{"type":"integer","description":"Inventory that can be fulfilled for orders.","example":4},"sellable":{"type":"integer","description":"Inventory that is available in sales channels.","example":2},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurements"}},"additionalProperties":false,"title":"WMS Sandbox"},"UpdatewmsInventoryItemInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdatewmsInventoryItem--WMS__Sandbox--"}],"title":"UpdatewmsInventoryItemInputSchema"},"CancelWmsOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the order.","example":"order_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":["string","null"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"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"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order. Defaults to `reference_id` if not provided.","example":"order_number"},"status":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"The status of the order. See the [order information](info) for more details.","example":"cancelled"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"channel_object":{"anyOf":[{"$ref":"#/components/schemas/OrderChannel"},{"type":"null"}]},"type":{"type":["string","null"],"enum":["d2c","b2b","dropship","transfer"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"trading_partner":{"type":["string","null"],"description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"service_level":{"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 used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level.","example":"fedex_ground"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method used to ship the order.","example":"FedEx Ground"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code for the carrier used to ship the order.","example":"scac"},"is_third_party_freight":{"type":["boolean","null"],"description":"True if the order was shipped using a third party freight account.","example":false},"third_party_freight_account_number":{"type":["string","null"],"description":"The third party freight account number used to ship the order.","example":"123456"},"first_party_freight_account_number":{"type":["string","null"],"description":"The first party freight account number used to ship the order.","example":"123456"},"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"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":1,"unit_price":10.99,"discount_amount":1.5}],"items":{"$ref":"#/components/schemas/WmsOrderLineItem"}},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":["string","null"],"format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"saturday_delivery":{"type":["boolean","null"],"description":"True if the order requires Saturday delivery.","example":false},"signature_required":{"type":["boolean","null"],"description":"True if the order requires a signature upon delivery.","example":false},"international_duty_paid_by":{"type":["string","null"],"enum":["sender","recipient","third_party"],"description":"The party responsible for paying international duties.","example":"sender"},"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","example":[],"items":{"$ref":"#/components/schemas/OrderShipment"}},"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","carrier_id","carrier_name","channel_object","created_date","external_system_url","first_party_freight_account_number","id","international_duty_paid_by","invoice_currency_code","is_third_party_freight","line_items","order_number","raw_status","reference_id","required_ship_date","saturday_delivery","scac","service_level","ship_to_address","shipments","shipping_method_id","shipping_method_name","signature_required","status","tags","third_party_freight_account_number","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","trading_partner","type","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"CancelWmsOrderResponseDataSchema"},"wmsCancelOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CancelWmsOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCancelOrderResponse"},"ErpInventorySingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpInventoryItemApiItemSchema"}},"additionalProperties":false,"title":"ErpInventorySingleItemEndpoint"},"WmsWarehousesSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsWarehouseApiItemSchema"}},"additionalProperties":false,"title":"WmsWarehousesSingleItemEndpoint"},"wmsUpdateWarehouseResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsWarehouseApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateWarehouseResponse"},"UpdatewmsWarehouse--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/SandboxCreateWarehouseAddress"}},"additionalProperties":false,"title":"WMS Sandbox"},"UpdatewmsWarehouse--Luminous--":{"type":"object","properties":{"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":{}},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"}},"additionalProperties":false,"title":"Luminous"},"UpdatewmsWarehouseInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdatewmsWarehouse--WMS__Sandbox--"},{"$ref":"#/components/schemas/UpdatewmsWarehouse--Luminous--"}],"title":"UpdatewmsWarehouseInputSchema"},"cartRefundOrderOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CartOrderApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"cartRefundOrderOrderResponse"},"RefundOrderLineItem":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The ID of the order line item to refund.","example":"line_item_id"},"quantity":{"type":"integer","description":"The number of units to refund.","example":1},"amount":{"type":"number","description":"The dollar amount to refund for this line item.","example":10.99}},"required":["line_item_id"],"additionalProperties":false,"title":"RefundOrderLineItem"},"RefundOrdercartOrder--Cart__Sandbox--":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the refund.","example":"Defective product"},"line_items":{"type":"array","description":"The line items to refund.","items":{"$ref":"#/components/schemas/RefundOrderLineItem"}}},"required":["line_items"],"additionalProperties":false,"title":"Cart Sandbox"},"BigCommerceRefundOrderLineItem":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The order_product_id of the line item to refund.","example":"line_item_id"},"quantity":{"type":"integer","description":"The number of units to refund.","example":1}},"required":["line_item_id","quantity"],"additionalProperties":false,"title":"BigCommerceRefundOrderLineItem"},"RefundOrdercartOrder--BigCommerce--":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the refund.","example":"Defective product"},"provider_id":{"type":"string","description":"The payment provider to refund through. Required when multiple refund methods are available.","example":"braintree"},"line_items":{"type":"array","description":"The line items to refund.","items":{"$ref":"#/components/schemas/BigCommerceRefundOrderLineItem"}}},"required":["line_items"],"additionalProperties":false,"title":"BigCommerce"},"EBayRefundOrderLineItem":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The ID of the order line item to refund.","example":"line_item_id"},"amount":{"type":"number","description":"The dollar amount to refund for this line item.","example":10.99}},"required":["amount","line_item_id"],"additionalProperties":false,"title":"EBayRefundOrderLineItem"},"RefundOrdercartOrder--eBay--":{"type":"object","properties":{"reason":{"type":"string","enum":["BUYER_CANCEL","SELLER_CANCEL","ITEM_NOT_RECEIVED","BUYER_RETURN"],"description":"The reason for the refund.","example":"BUYER_CANCEL"},"line_items":{"type":"array","description":"The line items to refund.","items":{"$ref":"#/components/schemas/EBayRefundOrderLineItem"}}},"required":["line_items","reason"],"additionalProperties":false,"title":"eBay"},"WooCommerceRefundOrderLineItem":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The ID of the order line item to refund.","example":"line_item_id"},"amount":{"type":"number","description":"The dollar amount to refund for this line item.","example":10.99}},"required":["amount","line_item_id"],"additionalProperties":false,"title":"WooCommerceRefundOrderLineItem"},"RefundOrdercartOrder--WooCommerce--":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the refund.","example":"Defective product"},"line_items":{"type":"array","description":"The line items to refund.","items":{"$ref":"#/components/schemas/WooCommerceRefundOrderLineItem"}}},"required":["line_items"],"additionalProperties":false,"title":"WooCommerce"},"RefundOrdercartOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/RefundOrdercartOrder--Cart__Sandbox--"},{"$ref":"#/components/schemas/RefundOrdercartOrder--BigCommerce--"},{"$ref":"#/components/schemas/RefundOrdercartOrder--eBay--"},{"$ref":"#/components/schemas/RefundOrdercartOrder--WooCommerce--"}],"title":"RefundOrdercartOrderInputSchema"},"CancelReturnResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the return.","example":"return_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the return was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the return was last updated.","example":"2022-01-02T05:05:05Z"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"cancelled"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"order_id":{"type":["string","null"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"notes":{"type":"array","description":"A list of notes associated with the return.","example":["This is a note"],"items":{"type":"string","description":"This is a note","example":"notes"}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":1,"received_quantity":1,"restocked_quantity":1,"return_reason":"Too Small"}],"items":{"$ref":"#/components/schemas/WmsReturnLineItem"}},"shipments":{"type":"array","description":"List of the shipments associated with the return.","example":[],"items":{"$ref":"#/components/schemas/ReturnShipment"}},"external_system_url":{"type":["string","null"],"description":"URL link to the return in the external system (WMS/Freight etc).","example":"https://example.com/return/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","external_system_url","id","line_items","notes","order_id","raw_status","shipments","status","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"CancelReturnResponseDataSchema"},"wmsCancelReturnResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CancelReturnResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCancelReturnResponse"},"CartWarehousesSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CartWarehouseApiItemSchema"}},"additionalProperties":false,"title":"CartWarehousesSingleItemEndpoint"},"CreateWmsOrderShipmentResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the order.","example":"order_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":["string","null"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"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"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order. Defaults to `reference_id` if not provided.","example":"order_number"},"status":{"type":"string","enum":["open","confirmed","processing","picked","packed","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 WMS.","example":"raw_status"},"channel_object":{"anyOf":[{"$ref":"#/components/schemas/OrderChannel"},{"type":"null"}]},"type":{"type":["string","null"],"enum":["d2c","b2b","dropship","transfer"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"trading_partner":{"type":["string","null"],"description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"service_level":{"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 used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level.","example":"fedex_ground"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method used to ship the order.","example":"FedEx Ground"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code for the carrier used to ship the order.","example":"scac"},"is_third_party_freight":{"type":["boolean","null"],"description":"True if the order was shipped using a third party freight account.","example":false},"third_party_freight_account_number":{"type":["string","null"],"description":"The third party freight account number used to ship the order.","example":"123456"},"first_party_freight_account_number":{"type":["string","null"],"description":"The first party freight account number used to ship the order.","example":"123456"},"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"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":1,"unit_price":10.99,"discount_amount":1.5}],"items":{"$ref":"#/components/schemas/WmsOrderLineItem"}},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":["string","null"],"format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"saturday_delivery":{"type":["boolean","null"],"description":"True if the order requires Saturday delivery.","example":false},"signature_required":{"type":["boolean","null"],"description":"True if the order requires a signature upon delivery.","example":false},"international_duty_paid_by":{"type":["string","null"],"enum":["sender","recipient","third_party"],"description":"The party responsible for paying international duties.","example":"sender"},"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","example":[{"shipment_id":"shipment_id","warehouse_id":"wh_id","shipped_date":"2022-05-06T01:02:03Z","raw_status":"raw_status","status":"shipped","line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"parent_product_id":null}],"ship_to_address":{"full_name":"John Doe","company":"company","address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"ship_from_address":{"address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"packages":[{"package_id":"package_id","package_name":"package_name","tracking_number":"tracking_number","tracking_url":"tracking_url","shipping_method_id":"shipping_method_id","shipping_method_name":"shipping_method_name","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"scac","bill_of_lading":"bill_of_lading","sscc":"sscc","pro_number":"pro_number","shipping_cost":1.0,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-06-06T01:02:03Z","parent_product_id":null}]}]}],"items":{"$ref":"#/components/schemas/OrderShipment"}},"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","carrier_id","carrier_name","channel_object","created_date","external_system_url","first_party_freight_account_number","id","international_duty_paid_by","invoice_currency_code","is_third_party_freight","line_items","order_number","raw_status","reference_id","required_ship_date","saturday_delivery","scac","service_level","ship_to_address","shipments","shipping_method_id","shipping_method_name","signature_required","status","tags","third_party_freight_account_number","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","trading_partner","type","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"CreateWmsOrderShipmentResponseDataSchema"},"wmsCreateShipmentOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CreateWmsOrderShipmentResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateShipmentOrderResponse"},"WmsOrderCreateOrderShipmentLineItemsandbox":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderCreateOrderShipmentLineItemsandbox"},"CreateShipmentwmsOrder--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"shipped_date":{"type":"string","format":"date-time","description":"The date the shipment was sent.","example":"2022-05-06T01:02:03Z"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"tracking_url":{"type":"string","description":"The URL for the tracking number.","example":"tracking_url"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5},"measurements":{"$ref":"#/components/schemas/ShipmentMeasurements"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderCreateOrderShipmentLineItemsandbox"}}},"required":["measurements","shipped_date","shipping_cost","tracking_number","warehouse_id"],"additionalProperties":false,"title":"WMS Sandbox"},"CreateShipmentwmsOrder--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"carrier_id":{"type":"string","enum":["Connect an account to see available carriers"],"description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"carrier":{"type":"string","enum":["Connect an account to see available carriers"],"description":"The carrier to use for the shipment","example":"carrier"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"}},"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"PackageTracking":{"type":"object","properties":{"package_id":{"type":"string","description":"The ID of the package.","example":"package_id"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"}},"required":["package_id","tracking_number"],"additionalProperties":false,"title":"PackageTracking"},"CreateShipmentwmsOrder--Deposco--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5},"packages":{"type":"array","description":"A list of packages with their desired tracking numbers.","example":[{"package_id":"package_id","tracking_number":"tracking_number"}],"items":{"$ref":"#/components/schemas/PackageTracking"}}},"required":["shipping_cost"],"additionalProperties":false,"title":"Deposco"},"CreateShipmentwmsOrder--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"shipped_date":{"type":"string","format":"date-time","description":"The date the shipment was sent.","example":"2022-05-06T01:02:03Z"},"confirm_date":{"type":"string","format":"date-time","description":"The date the shipment was sent. Defaults to the current time.","example":"2022-05-06T01:02:03Z"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5},"packages":{"type":"array","description":"A list of packages with their desired tracking numbers.","example":[{"package_id":"package_id","tracking_number":"tracking_number"}],"items":{"$ref":"#/components/schemas/PackageTracking"}},"confirm_order":{"type":"boolean","default":true,"description":"Whether to confirm the order in Extensiv, which closes it. Defaults to true. When false, the tracking number, carrier and shipped date are written to the order, the order is left open, and the response is only `{\"success\": true, \"id\": \"\"}` instead of the full order. `shipping_cost` is added to the order as its shipping charge. `confirm_date` can't be sent when false.","example":true}},"required":["shipped_date"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"CreateShipmentwmsOrder--Amazon--":{"type":"object","properties":{"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":{}},"shipped_date":{"type":"string","format":"date-time","description":"The date the shipment was sent.","example":"2022-05-06T01:02:03Z"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order.","example":"carrier_id"},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order.","example":"carrier_name"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method.","example":"shipping_method_id"}},"required":["shipped_date","tracking_number"],"additionalProperties":false,"title":"Amazon"},"WmsOrderWriteLineItemfinale":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0},"location_id":{"type":"string","description":"","example":"location_id"}},"required":["location_id","sku"],"additionalProperties":false,"title":"WmsOrderWriteLineItemfinale"},"CreateShipmentwmsOrder--Finale--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/WmsOrderWriteLineItemfinale"}}},"required":["line_items"],"additionalProperties":false,"title":"Finale"},"CreateShipmentwmsOrder--Infoplus--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"tracking_numbers":{"type":"array","description":"List of tracking numbers if there are multiple shipments","example":["tracking_number_1","tracking_number_2","tracking_number_3"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}}},"additionalProperties":false,"title":"Infoplus"},"CreateShipmentwmsOrder--Linnworks--":{"type":"object","properties":{"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":{}},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5}},"required":["tracking_number"],"additionalProperties":false,"title":"Linnworks"},"CreateShipmentwmsOrder--Logiwa--":{"type":"object","properties":{"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"tracking_numbers":{"type":"array","description":"List of tracking numbers associated with the order shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}}},"required":["shipping_method_id"],"additionalProperties":false,"title":"Logiwa"},"LogiwaIOFile":{"type":"object","properties":{"file_url":{"type":"string","description":"The URL of the file to attach.","example":"https://doc.example.com/example.pdf"},"file_name":{"type":"string","description":"The name of the file to attach.","example":"example.pdf"}},"required":["file_name","file_url"],"additionalProperties":false,"title":"LogiwaIOFile"},"CreateShipmentwmsOrder--Logiwa__IO--":{"type":"object","properties":{"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":{}},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"carrier_name":{"type":"string","description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"files":{"type":"array","description":"A list of files to attach to the order shipment. Will upload a dummy PDF if not provided.","example":[{"file_name":"example.pdf","file_url":"https://doc.phomemo.com/Labels-Sample.pdf"}],"items":{"$ref":"#/components/schemas/LogiwaIOFile"}}},"additionalProperties":false,"title":"Logiwa IO"},"WmsOrderFulfillLineItemluminous":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"product_id":{"type":"integer","description":"","example":0},"quantity":{"type":"integer","minimum":1,"description":"","example":1}},"required":["quantity"],"additionalProperties":false,"title":"WmsOrderFulfillLineItemluminous"},"CreateShipmentwmsOrder--Luminous--":{"type":"object","properties":{"shipped_date":{"type":"string","format":"date-time","description":"The date the shipment was sent.","example":"2022-05-06T01:02:03Z"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5},"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","product_id":0,"quantity":1}],"items":{"$ref":"#/components/schemas/WmsOrderFulfillLineItemluminous"}}},"required":["carrier_id","line_items","shipped_date","tracking_number","warehouse_id"],"additionalProperties":false,"title":"Luminous"},"PackageMeasurementspackiyo":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the package.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the package.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"PackageMeasurementspackiyo"},"PackageOrderItem":{"type":"object","properties":{"sku":{"type":"string","description":"SKU","example":"sku"},"quantity":{"type":"integer","description":"Quantity","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"PackageOrderItem"},"PackiyoBox":{"type":"object","properties":{"measurements":{"$ref":"#/components/schemas/PackageMeasurementspackiyo"},"package_name":{"type":"string","enum":["N/A - Connect an account to see available boxes"],"description":"package_name","example":"package_name"},"line_items":{"type":"array","description":"A list of line items in the package.","example":[{"sku":"sku","quantity":"quantity"}],"items":{"$ref":"#/components/schemas/PackageOrderItem"}}},"required":["package_name"],"additionalProperties":false,"title":"PackiyoBox"},"CreateShipmentwmsOrder--Packiyo--":{"type":"object","properties":{"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"tracking_url":{"type":"string","description":"The URL for the tracking number.","example":"tracking_url"},"boxes":{"type":"array","description":"A list of boxes with their desired tracking numbers.","example":[{"measurements":{"length":"length","width":"width","height":"height","weight":"weight","weight_unit":"weight_unit","unit":"unit"},"package_name":"package_name","line_items":[{"sku":"sku","quantity":"quantity"}]}],"items":{"$ref":"#/components/schemas/PackiyoBox"}}},"required":["boxes","shipping_cost","tracking_number","tracking_url"],"additionalProperties":false,"title":"Packiyo"},"OrderShipmentMeasurements":{"type":"object","properties":{"length":{"type":"number","description":"","example":0.0},"width":{"type":"number","description":"","example":0.0},"height":{"type":"number","description":"","example":0.0},"unit":{"type":"string","enum":["cm","in"],"description":"The unit of measurement for the size of the order shipment.","example":"in"},"weight":{"type":"number","description":"","example":0.0},"weight_unit":{"type":"string","enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the order shipment.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"OrderShipmentMeasurements"},"CreateShipmentwmsOrder--ShipHero--":{"type":"object","properties":{"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_method_name":{"type":"string","description":"The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level.","example":"FedEx Ground"},"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5},"measurements":{"$ref":"#/components/schemas/OrderShipmentMeasurements"},"label_url":{"type":"string","description":"URL where the label can be found","example":"label_url"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"tracking_url":{"type":"string","description":"The URL for the tracking number.","example":"tracking_url"}},"required":["carrier_id","measurements","shipping_cost","warehouse_id"],"additionalProperties":false,"title":"ShipHero"},"CreateShipmentwmsOrder--ShipStation--":{"type":"object","properties":{"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipped_date":{"type":"string","format":"date-time","description":"The date the shipment was sent.","example":"2022-05-06T01:02:03Z"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"notify_customer":{"type":"boolean","description":"Specifies whether the customer should be notified of the shipment","example":true},"notify_sales_channel":{"type":"boolean","description":"Specifies whether the sales channel should be notified of the shipment","example":true},"skip_retrieval":{"type":"boolean","default":false,"description":"Skip resource retrieval after successful create operation","example":false}},"required":["carrier_id"],"additionalProperties":false,"title":"ShipStation"},"ShipmentMeasurementsskuvault":{"type":"object","properties":{"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the shipment.","example":"lb"}},"required":["weight","weight_unit"],"additionalProperties":false,"title":"ShipmentMeasurementsskuvault"},"WmsOrderFulfillLineItemskuvault":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsOrderFulfillLineItemskuvault"},"CreateShipmentwmsOrder--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"warehouse_id":{"type":"string","description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"carrier_id":{"type":"string","description":"The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence.","example":"fedex"},"shipping_method_id":{"type":"string","description":"The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence.","example":"fedex_ground"},"shipping_cost":{"type":"number","description":"The cost incurred by the warehouse to ship the package.","example":2.5},"measurements":{"$ref":"#/components/schemas/ShipmentMeasurementsskuvault"},"tracking_number":{"type":"string","description":"The tracking number for the package.","example":"tracking_number"},"tracking_url":{"type":"string","description":"The URL for the tracking number.","example":"tracking_url"},"source":{"type":"string","default":"External","description":"Where the shipping information came from.","example":"External"},"note":{"type":"string","description":"Note for the shipment.","example":"note"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsOrderFulfillLineItemskuvault"}}},"required":["carrier_id","measurements","shipping_method_id","tracking_number","tracking_url","warehouse_id"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"CreateShipmentwmsOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreateShipmentwmsOrder--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Deposco--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Amazon--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Finale--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Infoplus--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Linnworks--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Logiwa--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Logiwa__IO--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Luminous--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Packiyo--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--ShipHero--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--ShipStation--"},{"$ref":"#/components/schemas/CreateShipmentwmsOrder--Linnworks__Core__-_SKUVault_---"}],"title":"CreateShipmentwmsOrderInputSchema"},"FreightShipmentsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FreightShipmentApiItemSchema"}},"additionalProperties":false,"title":"FreightShipmentsSingleItemEndpoint"},"cartBatchAdjustInventoryProductResponse":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/CartProductApiItemSchema"}},"unused_fields":{"type":"array","description":"Unused fields","items":{"type":"string","description":"","example":"unused_fields"}}},"required":["data","unused_fields"],"additionalProperties":false,"title":"cartBatchAdjustInventoryProductResponse"},"EtsyBatchAdjustInventoryLine":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the variant product to adjust.","example":"product_id"},"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1}},"required":["product_id","quantity"],"additionalProperties":false,"title":"EtsyBatchAdjustInventoryLine"},"BatchAdjustInventorycartProduct--Etsy--":{"type":"object","properties":{"line_items":{"type":"array","description":"Inventory adjustments. Each entry sets the exact on-hand quantity for one variant product. Entries that belong to the same listing are applied together in one Etsy call.","items":{"$ref":"#/components/schemas/EtsyBatchAdjustInventoryLine"}}},"required":["line_items"],"additionalProperties":false,"title":"Etsy"},"JoorBatchAdjustInventoryLine":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the product to adjust.","example":"product_id"},"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["product_id","quantity","warehouse_id"],"additionalProperties":false,"title":"JoorBatchAdjustInventoryLine"},"BatchAdjustInventorycartProduct--JOOR--":{"type":"object","properties":{"line_items":{"type":"array","description":"Inventory adjustments. Each entry sets the exact on-hand quantity for one product.","items":{"$ref":"#/components/schemas/JoorBatchAdjustInventoryLine"}}},"required":["line_items"],"additionalProperties":false,"title":"JOOR"},"BatchAdjustCartInventoryLine":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the product to adjust.","example":"product_id"},"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["product_id","quantity"],"additionalProperties":false,"title":"BatchAdjustCartInventoryLine"},"BatchAdjustInventorycartProduct--Mirakl--":{"type":"object","properties":{"line_items":{"type":"array","description":"Inventory adjustments. Each entry sets the exact on-hand quantity for one product.","items":{"$ref":"#/components/schemas/BatchAdjustCartInventoryLine"}}},"required":["line_items"],"additionalProperties":false,"title":"Mirakl"},"OrderDeskBatchAdjustInventoryLine":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the product to adjust.","example":"product_id"},"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1}},"required":["product_id","quantity"],"additionalProperties":false,"title":"OrderDeskBatchAdjustInventoryLine"},"BatchAdjustInventorycartProduct--OrderDesk--":{"type":"object","properties":{"line_items":{"type":"array","description":"Inventory adjustments. Each entry sets the exact on-hand quantity for one product.","items":{"$ref":"#/components/schemas/OrderDeskBatchAdjustInventoryLine"}}},"required":["line_items"],"additionalProperties":false,"title":"OrderDesk"},"RithumBatchAdjustInventoryLine":{"type":"object","properties":{"product_id":{"type":"string","description":"The ID of the product to adjust.","example":"product_id"},"quantity":{"type":"integer","minimum":0,"description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"oms_id":{"type":"string","description":"The OMS ID of the product.","example":"123456789"}},"required":["oms_id","product_id","quantity"],"additionalProperties":false,"title":"RithumBatchAdjustInventoryLine"},"BatchAdjustInventorycartProduct--Rithum__-__Home__Depot--":{"type":"object","properties":{"line_items":{"type":"array","description":"Inventory adjustments. Each entry sets the exact available quantity for one product. Give a product several entries, one per warehouse, to split its stock across warehouses.","items":{"$ref":"#/components/schemas/RithumBatchAdjustInventoryLine"}}},"required":["line_items"],"additionalProperties":false,"title":"Rithum (_Home Depot"},"BatchAdjustInventorycartProductInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/BatchAdjustInventorycartProduct--Etsy--"},{"$ref":"#/components/schemas/BatchAdjustInventorycartProduct--JOOR--"},{"$ref":"#/components/schemas/BatchAdjustInventorycartProduct--Mirakl--"},{"$ref":"#/components/schemas/BatchAdjustInventorycartProduct--OrderDesk--"},{"$ref":"#/components/schemas/BatchAdjustInventorycartProduct--Rithum__-__Home__Depot--"}],"title":"BatchAdjustInventorycartProductInputSchema"},"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":"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"}],"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"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"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"cartCreateShipmentOrderResponse"},"CreateShipmentcartOrder--Cart__Sandbox--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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"},"CartOrderWriteLineItemamazon":{"type":"object","properties":{"product_sku":{"type":"string","description":"","example":"product_sku"},"sku":{"type":"string","description":"Use product_sku instead.","example":"sku"},"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","example":"transparency_codes"}}},"additionalProperties":false,"title":"CartOrderWriteLineItemamazon"},"CreateShipmentcartOrder--Amazon--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"carrier_name":{"type":"string","enum":["17FEIA","360lion","4PX","A-1","AAA Cooper","ABF","Acelera Flex","Ader","AFL/Fedex","AG Logistica Express","Airtel","AJEX","AL Express","ALLJOY","AMAUK","AMAZON HORIZON","Amazon Shipping","AMZL","AMZL_UK","Andere","Anjun","AO","AO Deutschland","APC","APC Overnight","APC POSTAL LOGISTICS","APC-Overnight","APG eCommerce","Aramex","ARAS","Aras Kargo","Arco Spedizioni","Arkas","Arrow XL","Asendia","Asgard","Assett","AT POST","AT Post","ATPOST","ATS","AUSSIE_POST","Australia Post","Australia Post-ArticleID","Australia Post-Consignment","B2C","B2C Europe","B2CShip","Balnak","Baral Logistics","Bartolini","Beijing Quanfeng Express","Best Buy","Best Express","Better Trucks","Bharat","BJS","Blitz","Blowhorn","Blue Package","BlueDart","Bombax","Bombino Express","Borzo","Bounce","Bo\u011fazi\u00e7i","BPOST","BR1 Express","Bringer","BRT","Buylogic","Cainiao","Canada Post","Canpar","Canpar Express","CargoLine","Caribou","Cart2India","CBHub","CBL","CDC","CELERITAS","Centex","CEVA","Ceva Lojistik","Chama Logistica","Chega Log Entregas Flex","China Post","Chrono Express","Chronopost","Chukou1","Cititrans","City Link","CityPost","CNE","Coliposte","COLIS PRIVE","Colis Prive","Colis Priv\u00e9","Colissimo","Conexao Envios","Consegna Mezzi Propri","Conway","Correios","Correos","Correos Express","COSCO","Couriers Please","CouriersPlease","CTT EXPRESS","CTTExpress","Cubyn","CyberSavings","DACHSER","DACSHER","DAIPOST","DASCHER","DB Schenker","DEL Deliveries","Delhivery","Delivengo","Delivery Group","Der Kurier","Desertcart","DESERTCART","Deutsche Post","DFL","DHL","DHL eCommerce","DHL Express","DHL Freight","DHL Global Mail","DHL Home Delivery","DHL Kargo","DHL Parcel UK","DHL-Paket","DHLPL","Digital Delivery","DirectLink","DirectLog","Dotzot","DPB","DPD","DPD Local","DPWorld","DSV","DTDC","DX","DX Express","DX Freight","DX Secure","DYNAMIC EXPRESS","ECMS","ECMS express","ECMS Express, Inc","ECMS Express, Inc.","Ecom Express","Ecom Shipping solutions PVT ltd","EINSA SOURCING","EKI Trans","Emirates Post","Emons","Endopack","Energo","Envialia","ePost Global","Equick","Equipe Motoboys","ESI Delivery Service","ESNAD","Estafeta","Estes","EUB","Europaczka","Evri","Exapaq","Expresso Flex","F6 Express","FAST EST","Fastway","FedEx","Fedex Freight","FEDEX JP","FedEx SmartPost","FEDEX_JP","Fenix express","FERCAM","Fercam","Fillo Kargo","First Flight","First Flight China","First Mile","FITFRESH","Flash","Flash Express","Fleetan","FleetOptics","Flex Boys","Flex Correria Express","Flex Velozz","FlexJa Entregas Rapidas","Flyt","Foguete Log","FRACHTPOST","FRANCE EXPRESS","France Express","Gati","GBL Express","GEL","GEL Express","geodis","GEODIS","Geodis Calberson","Geopost Kargo","GFS","GlobalPost","GLS","GLS Canada","GLS US","GO!","Gojavas","Goncargas Express","GRUPO LOGISTIC","GT Flex Entregas","Hellmann","Heppner","Hepsijet Kargo","Hermes","Hermes (Corporate)","Hermes Einrichtungsservice","Hermes Logistik Gruppe","Hermes UK","Hlog","HNC","Home Logistics","honesteye","Hong Kong Post","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","Intelcom","Interlink","Interno","Intersoft","iParcel","ITD Global","J&T Express","J3 Flex","Jadlog","Japan Post","JCEX","JD Logistics","JD LOGISTICS","Jeebly","Jersey Post","JetSouq Express","Jiehang","Jiufang","JP EXPRESS","JP_EXPRESS","JPL UPU","JS Express","JT","JT Express","JT Flex Logistica","JY Express","K10 Flex","Kargokar","KEAVO","Kerry","Korea Post","KSE","Kuehne Nagel","Kuehne+Nagel","Kunzendorf","Kybotech","La Poste","LANDMARK","Landmark","Landmark Global","Lasership","Lemonmode","Letian","LF Logistic","Liccardi","Liccardi Trasporti","LN Transportes","Loadshare","Log manager","Logi Connect","Logistik Gruppe","Loomis","Lovely Express","Magicfleet","Mail Alliance","Mail Americas","Mainpost","MAX Express","MB Flex Express","MBE","Metro Kargo","Metropolitan Warehouse and Delivery","Meyer Logistics","Mezzi propri","MG Log Express","MHI","Milkman","Mineiro Express","MNG Kargo","Mondial Relay","MRW","Mylerz","MZZ Briefdienst","MZZ-Briefdienst","Nacex","NACEX","Naplog Logistics","NAQEL EXPRESS","Narpost Kargo","New Zealand Post","Newgistics","Nexive","Ninjavan","NipponExpress","NITTSU","Nobres Entregas","NOVEO","NowBikes","NTL","OCS Worldwide","Ola","Old Dominion","OneWorldExpress","ONTIME","OnTrac","OSM","OSM Worldwide","Other","Otro","Overnite Express","Palletline","Palletways","Pandion","Panther","Paquetexpress","Parcel Hub","Parcel Monkey","Parcel Station","Parcel2go","PARCEL2GO.COM","ParcelDenOnline","Parcelforce","Parcelhub","Parcelink Logistics","Parcelnet","ParcelOne","PDC Logistics","PF Logistics","Pidge","Pilot","Pilot Freight","PIN","Pitt Ohio","Polish Post","Pomo DOuro Express","Pos Laju","Post Modern","Post NL","Poste Italiane","PostNL","PostNord","Professional","PTT Kargo","Purolator","PUROLATOR","QExpress","Quantium","Quick","QuickShift","Qwqer","Qxpress","R+L","Raben","Raben Group","Rapiboy","Rapido","RBNA","Redpack","REDUR","Rhenus","Rieck","Rivigo","RMLGB","RND Logistica","Roadie","ROADIE","Roadrunner","Royal Mail","ROYAL_MAIL","RR Donnelley","RR Express Logistica","RRleste","RS Flex","Safexpress","SAGAWA","Sagawa Express","SAGAWA EXPRESS","SagawaExpress","Saia","Sailpost","Saudi Post","Schweizer Post","Scooton","SDA","Seino","SEINO TRANSPORTATION","Seko Logistics","Selem Kargo","Self Delivery","Sendcloud","Sending","SENDLE","Sendle","Seur","Seven Senders","SF Express","SFC","Shadowfax","Shanghai Shouwu","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","SJL Express","SkyNet Worldwide Express","Skypostal","Smartmail","Smartrlogistics","SMSA","SMSA Express","Soarmall","Sonic Flex","Sonstige","SOS Envios Express","South Eastern Freight Lines","Speed Guri","Speedaf","Speedex","Spoton","Spreetail","SPRING","spring GDS","Spring GDS","Sprint","Stahlmann and Sachs","Stampit","Staples","StarTrack","StarTrack-ArticleID","StarTrack-Consignment","STG","STO Express","Streamlite","Sunyou","Super Express","Susa","Swftbox","Swiss post","Szendex","S\u00fcrat Kargo","Target","TATA Express","TDN","Team Express","Team Global Express","Tezel Lojistik","TFM Express","TForce Freight","TForce Logistics","The Delivery Group","The Professional Couriers","TIPSA","TLG Logistica","TM Logistica","TNT","TNT Kargo","TNTIT","Toll","Toll Global Express","Tongda Global","Top Express","Topyou","Total Express","Tourline","Tracken","Trackon","Trakpak","Trans-o-Flex","Transaher","Transaragon\u00e9s","TransFolha","Translink","Transoflex","Truline","TSB","Tuffnells","TWS","TXT","TyD","Uber","UBI","UK MAIL","UKMail","UniUni","UPakWeShip","UPS","UPS Freight","UPS Mail Innovations","Upsilon","UPSMI","Urban Express","Uship","USPS","Vancotech","Varoes Express","Verage Shipping","Via Xpress","Viplog","VIR","VNLIN","WA Transportes","WanbExpress","Watkins and Shepard","Waynik","WDK Express","Wefast","WeWorldExpress","Whistl","Whizzard","WINIT","WPX","XDP","XPO","XPO Freight","XPO HB","Xpressbees","YAMATO","YAMATO TRANSPORT","YamatoTransport","YANWEN","Yanwen","YDH","Yellow Freight","YF Logistics","YFHEX","YHT","Yodel","YTO Express","Yulu","Yun Express","Yunda Express","Yurti\u00e7i Kargo","ZAD Express","ZAJEL Courier Services","Zeleris","ZID","Zippee","ZTO Express","Zust Ambrosetti"],"description":"The name of the carrier used to ship the order.","example":"17FEIA"},"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).","example":"package_reference_id"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_sku":"product_sku","sku":"sku","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":"fedex"},"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"}},"required":["carrier_id","tracking_number"],"additionalProperties":false,"title":"BigCommerce"},"CartOrderCreateLineItemebay":{"type":"object","properties":{"product_sku":{"type":"string","description":"","example":"product_sku"},"line_item_id":{"type":"string","description":"","example":"line_item_id"},"quantity":{"type":"integer","description":"","example":0}},"required":["product_sku"],"additionalProperties":false,"title":"CartOrderCreateLineItemebay"},"CreateShipmentcartOrder--eBay--":{"type":"object","properties":{"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_sku":"product_sku","line_item_id":"line_item_id","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":"A1CourierServices"},"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"}},"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":"AUSTRALIA_POST"},"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"shipping_cost":{"type":"number","description":"Cost for this shipment","example":1.99}},"required":["carrier_name","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.","example":"tracking_number"}},"required":["carrier_name","tracking_number"],"additionalProperties":false,"title":"Groupon"},"CartOrderCreateLineItemjoor":{"type":"object","properties":{"shipment_line_item_id":{"type":"string","description":"The ID of the order line item being shipped.","example":"line_item_id"},"quantity":{"type":"integer","description":"The number of units shipped for this line item.","example":1}},"required":["quantity","shipment_line_item_id"],"additionalProperties":false,"title":"CartOrderCreateLineItemjoor"},"CreateShipmentcartOrder--JOOR--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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"},"expected_delivery_date":{"type":"string","format":"date-time","description":"The date the shipment is expected to be delivered.","example":"2026-08-01T00:00:00Z"},"requested_delivery_date":{"type":"string","format":"date-time","description":"The date delivery was originally requested for.","example":"2026-08-01T00:00:00Z"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"shipment_line_item_id":"line_item_id","quantity":1}],"items":{"$ref":"#/components/schemas/CartOrderCreateLineItemjoor"}}},"required":["expected_delivery_date","line_items","requested_delivery_date"],"additionalProperties":false,"title":"JOOR"},"CartOrderCreateLineItemmagento":{"type":"object","properties":{"product_sku":{"type":"string","description":"","example":"product_sku"},"sku":{"type":"string","description":"Use product_sku instead.","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity"],"additionalProperties":false,"title":"CartOrderCreateLineItemmagento"},"CreateShipmentcartOrder--Magento__-_Adobe__Commerce_---":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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":"product_sku","sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/CartOrderCreateLineItemmagento"}}},"additionalProperties":false,"title":"Magento (Adobe Commerce)"},"CartOrderWriteLineItemmirakl":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The ID of the line item in the order","example":"line_item_id"},"quantity":{"type":"integer","description":"","example":0}},"required":["line_item_id","quantity"],"additionalProperties":false,"title":"CartOrderWriteLineItemmirakl"},"CreateShipmentcartOrder--Mirakl--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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"},"carrier_id":{"type":"string","description":"The code of a carrier configured on the Mirakl operator (sent as tracking.carrier_code).","example":"UPS"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"line_item_id":"line_item_id","quantity":0}],"items":{"$ref":"#/components/schemas/CartOrderWriteLineItemmirakl"}}},"required":["carrier_name","line_items"],"additionalProperties":false,"title":"Mirakl"},"CartOrderCreateLineItemnuorder":{"type":"object","properties":{"product_sku":{"type":"string","description":"","example":"product_sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["product_sku","quantity"],"additionalProperties":false,"title":"CartOrderCreateLineItemnuorder"},"CreateShipmentcartOrder--NuOrder--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_sku":"product_sku","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--OrderDesk--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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"}},"additionalProperties":false,"title":"OrderDesk"},"CreateShipmentcartOrder--Overstock--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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"},"ShipFromAddressRithum-Home-Depot":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressRithum-Home-Depot"},"CartOrderCreateLineItemrithum-home-depot":{"type":"object","properties":{"shipment_line_item_id":{"type":"string","description":"The PO line number to ship or cancel.","example":"1"},"status":{"type":"string","default":"fulfilled","enum":["fulfilled","cancelled"],"description":"Whether the line ships or is cancelled in this shipment.","example":"fulfilled"},"cancel_reason_code":{"type":"string","description":"The retailer's cancel reason code. Required on a cancelled line.","example":"Out of Stock"}},"required":["shipment_line_item_id"],"additionalProperties":false,"title":"CartOrderCreateLineItemrithum-home-depot"},"CreateShipmentcartOrder--Rithum__-__Home__Depot--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"shipping_method_name":{"type":"string","description":"The name of the actual shipping method.","example":"UPSN"},"ship_date":{"type":"string","format":"date-time","description":"The date the order was shipped.","example":"2030-01-01T00:00:00Z"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressRithum-Home-Depot"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"shipment_line_item_id":"1","status":"fulfilled","cancel_reason_code":"Out of Stock"}],"items":{"$ref":"#/components/schemas/CartOrderCreateLineItemrithum-home-depot"}}},"required":["ship_date","ship_from_address","shipping_method_name","tracking_number"],"additionalProperties":false,"title":"Rithum (_Home Depot"},"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"},"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"},"CreateShipmentcartOrder--Shopify--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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.","example":"tracking_number"},"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"},"CartOrderWriteLineItemtiktok":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The ID of the order line item to ship.","example":"line_item_id"},"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"},"CreateShipmentcartOrder--TikTok--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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.","example":"carrier"},"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/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"},"CartOrderWriteLineItemwalmart":{"type":"object","properties":{"product_sku":{"type":"string","description":"","example":"product_sku"},"sku":{"type":"string","description":"Use product_sku instead.","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity"],"additionalProperties":false,"title":"CartOrderWriteLineItemwalmart"},"CreateShipmentcartOrder--Walmart--":{"type":"object","properties":{"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_sku":"product_sku","sku":"sku","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":"4PX"},"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.","example":"tracking_number"},"intent_to_cancel_override":{"type":"boolean","description":"Ship the order lines even if the buyer has requested a cancellation.","example":true},"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"},"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"},"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":"2-Day Delivery -- Free!"},"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.","example":"tracking_number"},"ship_date":{"type":"string","format":"date-time","description":"The date the shipment was shipped.","example":"2023-03-15T13:45:30Z"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressWayfair"}},"required":["carrier_name","ship_from_address","shipping_method_name","tracking_number"],"additionalProperties":false,"title":"Wayfair"},"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"},"CreateShipmentcartOrder--Wix--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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","line_items","tracking_number"],"additionalProperties":false,"title":"Wix"},"CreateShipmentcartOrder--WooCommerce--":{"type":"object","properties":{"tracking_number":{"type":"string","description":"The tracking number for the shipment.","example":"tracking_number"},"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","\u010cesk\u00e1 po\u0161ta"],"example":"Fedex"},"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"},"CreateShipmentcartOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreateShipmentcartOrder--Cart__Sandbox--"},{"$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--JOOR--"},{"$ref":"#/components/schemas/CreateShipmentcartOrder--Magento__-_Adobe__Commerce_---"},{"$ref":"#/components/schemas/CreateShipmentcartOrder--Mirakl--"},{"$ref":"#/components/schemas/CreateShipmentcartOrder--NuOrder--"},{"$ref":"#/components/schemas/CreateShipmentcartOrder--OrderDesk--"},{"$ref":"#/components/schemas/CreateShipmentcartOrder--Overstock--"},{"$ref":"#/components/schemas/CreateShipmentcartOrder--Rithum__-__Home__Depot--"},{"$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"},"ErpSalesOrdersSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpSalesOrderApiItemSchema"}},"additionalProperties":false,"title":"ErpSalesOrdersSingleItemEndpoint"},"UpdateErpSalesOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sales order in the ERP.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"status":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"The status of the sales order. See the [sales order information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Fulfillment', 'Partially Fulfilled').","example":"Pending Fulfillment"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"subtotal":{"type":["number","null"],"description":"Sum of item line amounts before tax, shipping, and discount, in the order currency.","example":100.0},"total_tax":{"type":["number","null"],"description":"Total tax charged on the order, in the order currency.","example":8.5},"total_shipping":{"type":["number","null"],"description":"Total shipping charged on the order, in the order currency.","example":12.0},"total_discount":{"type":["number","null"],"description":"Total discount applied to the order, in the order currency.","example":5.0},"total_price":{"type":["number","null"],"description":"Grand total the customer will be billed for the order, in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_method_id":{"type":["string","null"],"description":"ID of the shipping method on the order.","example":"sm_1"},"shipping_method_name":{"type":["string","null"],"description":"Display name of the shipping method.","example":"UPS Ground"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0}],"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order in the external system (WMS/Freight etc).","example":"https://example.com/salesorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","customer_id","expected_ship_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","shipping_method_id","shipping_method_name","status","subtotal","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"UpdateErpSalesOrderResponseDataSchema"},"erpUpdateSalesOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UpdateErpSalesOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpUpdateSalesOrderResponse"},"ErpSalesOrderUpdateShipToAddressNetsuite":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"},"phone_number":{"type":"string","description":"","example":"phone_number"}},"additionalProperties":false,"title":"ErpSalesOrderUpdateShipToAddressNetsuite"},"ErpSalesOrderUpdateBillToAddressNetsuite":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe"},"company":{"type":"string","description":"","example":"Company"},"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"}},"additionalProperties":false,"title":"ErpSalesOrderUpdateBillToAddressNetsuite"},"ErpSalesOrderUpdateLineItemnetsuite":{"type":"object","properties":{"line_item_id":{"type":"string","description":"ID of the source sales-order line being updated. Required to edit or close an existing line; omit when adding a new line.","example":"line_1"},"close":{"type":"boolean","description":"Set to true to close this open line on the sales order. Closing transitions the order toward closed/fulfilled without requiring the line to be shipped. Requires line_item_id.","example":false},"item_id":{"type":"string","description":"","example":"item_id"},"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"number","description":"","example":0.0},"unit_price":{"type":"number","description":"","example":0.0},"location_id":{"type":"string","description":"","example":"location_id"}},"additionalProperties":false,"title":"ErpSalesOrderUpdateLineItemnetsuite"},"UpdateerpSalesOrder--NetSuite--":{"type":"object","properties":{"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":{}},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"reference_id":{"type":"string","description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":"string","format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"location_id":{"type":"string","description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"ship_to_address":{"$ref":"#/components/schemas/ErpSalesOrderUpdateShipToAddressNetsuite"},"bill_to_address":{"$ref":"#/components/schemas/ErpSalesOrderUpdateBillToAddressNetsuite"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"line_item_id":"line_1","close":false,"item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderUpdateLineItemnetsuite"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}}},"additionalProperties":false,"title":"NetSuite"},"UpdateerpSalesOrderInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdateerpSalesOrder--NetSuite--"}],"title":"UpdateerpSalesOrderInputSchema"},"AddErpItemsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the item in the ERP.","example":"item_id"},"created_date":{"type":"string","format":"date-time","description":"The date the item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The display name of the item.","example":"Apple - Fuji"},"sku":{"type":["string","null"],"description":"The SKU / item number of the item.","example":"10000"},"description":{"type":["string","null"],"description":"A long-form description of the item.","example":"Fuji apple, loose"},"active":{"type":"boolean","description":"Whether the item is active.","example":true},"is_kit":{"type":"boolean","description":"Whether this item is a kit. A kit is not stocked itself; its components carry the inventory and ship in its place.","example":false},"kit_components":{"type":"array","description":"The items that make up this kit, and how many of each go into a single kit. Empty for items that are not kits.","example":[{"item_id":"610","sku":"10000","unit_quantity":2.0}],"items":{"$ref":"#/components/schemas/ErpKitComponent"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the item. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpItemCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the item in the external system (WMS/Freight etc).","example":"https://example.com/item/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":{}}},"required":["active","additional_fields","created_date","custom_fields","description","external_system_url","id","is_kit","kit_components","name","sku","trackstar_tags","updated_date"],"additionalProperties":false,"title":"AddErpItemsTagsResponseDataSchema"},"erpAddTrackstarTagItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpItemsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagItemResponse"},"AddTrackstarTagitemsSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagitemsSchema"},"wmsAdjustInventoryInventoryItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsInventoryItemApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsAdjustInventoryInventoryItemResponse"},"AdjustInventorywmsInventoryItem--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"quantity":{"type":"integer","description":"The quantity to adjust the inventory by.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"location_id":{"type":"string","description":"ID of the location to adjust inventory in.","example":"location_id"}},"required":["adjustment_type","quantity","warehouse_id"],"additionalProperties":false,"title":"WMS Sandbox"},"AdjustInventorywmsInventoryItem--Amazon--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"}},"required":["adjustment_type","quantity","warehouse_id"],"additionalProperties":false,"title":"Amazon"},"AdjustInventorywmsInventoryItem--Linnworks--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"location_id":{"type":"string","description":"ID of the location to adjust inventory in. Can be passed into the [Warehouse Location](/wms-api/warehouses/get-warehouse-locations) endpoint for more details.","example":"location_id"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Linnworks"},"AdjustInventorywmsInventoryItem--Logiwa--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"location_id":{"type":"string","description":"ID of the location to adjust inventory in. Can be passed into the [Warehouse Location](/wms-api/warehouses/get-warehouse-locations) endpoint for more details.","example":"location_id"}},"required":["adjustment_type","quantity","warehouse_id"],"additionalProperties":false,"title":"Logiwa"},"AdjustInventorywmsInventoryItem--Luminous--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"location_id":{"type":"string","description":"ID of the location to adjust inventory in.","example":"location_id"}},"required":["adjustment_type","location_id","quantity","warehouse_id"],"additionalProperties":false,"title":"Luminous"},"AdjustInventorywmsInventoryItem--ShipHero--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"location_id":{"type":"string","description":"ID of the location to adjust inventory in.","example":"location_id"}},"required":["adjustment_type","location_id","quantity","warehouse_id"],"additionalProperties":false,"title":"ShipHero"},"AdjustInventorywmsInventoryItemInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/AdjustInventorywmsInventoryItem--WMS__Sandbox--"},{"$ref":"#/components/schemas/AdjustInventorywmsInventoryItem--Amazon--"},{"$ref":"#/components/schemas/AdjustInventorywmsInventoryItem--Linnworks--"},{"$ref":"#/components/schemas/AdjustInventorywmsInventoryItem--Logiwa--"},{"$ref":"#/components/schemas/AdjustInventorywmsInventoryItem--Luminous--"},{"$ref":"#/components/schemas/AdjustInventorywmsInventoryItem--ShipHero--"}],"title":"AdjustInventorywmsInventoryItemInputSchema"},"AddWmsOrdersTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the order.","example":"order_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":["string","null"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"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"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order. Defaults to `reference_id` if not provided.","example":"order_number"},"status":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"The status of the order. See the [order information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"channel_object":{"anyOf":[{"$ref":"#/components/schemas/OrderChannel"},{"type":"null"}]},"type":{"type":["string","null"],"enum":["d2c","b2b","dropship","transfer"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"trading_partner":{"type":["string","null"],"description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"service_level":{"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 used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level.","example":"fedex_ground"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method used to ship the order.","example":"FedEx Ground"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code for the carrier used to ship the order.","example":"scac"},"is_third_party_freight":{"type":["boolean","null"],"description":"True if the order was shipped using a third party freight account.","example":false},"third_party_freight_account_number":{"type":["string","null"],"description":"The third party freight account number used to ship the order.","example":"123456"},"first_party_freight_account_number":{"type":["string","null"],"description":"The first party freight account number used to ship the order.","example":"123456"},"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"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":1,"unit_price":10.99,"discount_amount":1.5}],"items":{"$ref":"#/components/schemas/WmsOrderLineItem"}},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":["string","null"],"format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"saturday_delivery":{"type":["boolean","null"],"description":"True if the order requires Saturday delivery.","example":false},"signature_required":{"type":["boolean","null"],"description":"True if the order requires a signature upon delivery.","example":false},"international_duty_paid_by":{"type":["string","null"],"enum":["sender","recipient","third_party"],"description":"The party responsible for paying international duties.","example":"sender"},"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","example":[{"shipment_id":"shipment_id","warehouse_id":"wh_id","shipped_date":"2022-05-06T01:02:03Z","raw_status":"raw_status","status":"shipped","line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"parent_product_id":null}],"ship_to_address":{"full_name":"John Doe","company":"company","address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"ship_from_address":{"address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"packages":[{"package_id":"package_id","package_name":"package_name","tracking_number":"tracking_number","tracking_url":"tracking_url","shipping_method_id":"shipping_method_id","shipping_method_name":"shipping_method_name","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"scac","bill_of_lading":"bill_of_lading","sscc":"sscc","pro_number":"pro_number","shipping_cost":1.0,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-06-06T01:02:03Z","parent_product_id":null}]}]}],"items":{"$ref":"#/components/schemas/OrderShipment"}},"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":{}}},"required":["additional_fields","carrier_id","carrier_name","channel_object","created_date","external_system_url","first_party_freight_account_number","id","international_duty_paid_by","invoice_currency_code","is_third_party_freight","line_items","order_number","raw_status","reference_id","required_ship_date","saturday_delivery","scac","service_level","ship_to_address","shipments","shipping_method_id","shipping_method_name","signature_required","status","tags","third_party_freight_account_number","total_discount","total_price","total_shipping","total_tax","trackstar_tags","trading_partner","type","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"AddWmsOrdersTagsResponseDataSchema"},"wmsAddTrackstarTagOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddWmsOrdersTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsAddTrackstarTagOrderResponse"},"AddTrackstarTagordersSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagordersSchema"},"AddCartOrdersTagsResponseDataSchema":{"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":"open"},"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":"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"}],"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":{}},"skus":{"type":"array","description":"hidden","example":["sku1"],"items":{"type":"string","description":"","example":"skus"}},"warehouse_ids":{"type":"array","description":"hidden","example":["warehouse_id"],"items":{"type":"string","description":"","example":"warehouse_ids"}}},"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","skus","status","tags","total_discount","total_price","total_shipping","total_tax","trackstar_tags","updated_date","warehouse_ids"],"additionalProperties":false,"title":"AddCartOrdersTagsResponseDataSchema"},"cartAddTrackstarTagOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddCartOrdersTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"cartAddTrackstarTagOrderResponse"},"ExchangeResponseSandbox":{"type":"object","properties":{"access_token":{"type":"string","description":"The permanent access token for the integration used to make requests to the Trackstar API.","example":"your_permanent_access_token"},"connection_id":{"type":"string","description":"A unique connection ID for the integration.","example":"unique_connection_id"},"integration_name":{"type":"string","description":"The name of the integration that was installed.","example":"sandbox"},"customer_id":{"type":["string","null"],"description":"An identifier for your end customer.","example":"customer_id"},"available_actions":{"type":"array","description":"A list of actions that the integration supports.","example":["get_inventory","get_products"],"items":{"type":"string","description":"Actions supported by the integration","example":"available_actions"}},"me":{"type":["object","null"],"description":"Information that helps identify the connected account. If null, the integration does not provide this information.","example":{"account_id":"account_12345","account_name":"My WMS Account"},"additionalProperties":{"description":"Field value. Structure varies based on integration."}}},"required":["access_token","available_actions","connection_id","customer_id","integration_name","me"],"additionalProperties":false,"title":"ExchangeResponseSandbox"},"AddWmsReturnsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the return.","example":"return_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the return was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the return was last updated.","example":"2022-01-02T05:05:05Z"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"order_id":{"type":["string","null"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"notes":{"type":"array","description":"A list of notes associated with the return.","example":["This is a note"],"items":{"type":"string","description":"This is a note","example":"notes"}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":1,"received_quantity":1,"restocked_quantity":1,"return_reason":"Too Small"}],"items":{"$ref":"#/components/schemas/WmsReturnLineItem"}},"shipments":{"type":"array","description":"List of the shipments associated with the return.","example":[{"tracking_number":"tracking_number","shipped_date":"2023-02-03T02:04:06Z","arrived_date":"2023-02-03T02:04:06Z","warehouse_id":"warehouse_id","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"FDXG","shipping_cost":1.23,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":4,"receiving_details":[{"quantity":1,"condition":"good","disposition":"restocked"},{"quantity":1,"condition":"damaged","disposition":"scrapped"}]}]}],"items":{"$ref":"#/components/schemas/ReturnShipment"}},"external_system_url":{"type":["string","null"],"description":"URL link to the return in the external system (WMS/Freight etc).","example":"https://example.com/return/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":{}}},"required":["additional_fields","created_date","external_system_url","id","line_items","notes","order_id","raw_status","shipments","status","trackstar_tags","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"AddWmsReturnsTagsResponseDataSchema"},"wmsAddTrackstarTagReturnResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddWmsReturnsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsAddTrackstarTagReturnResponse"},"AddTrackstarTagreturnsSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagreturnsSchema"},"AddErpVendorsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the vendor in the ERP.","example":"vend_1"},"created_date":{"type":"string","format":"date-time","description":"The date the vendor was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the vendor was last updated.","example":"2022-01-02T05:05:05Z"},"vendor_number":{"type":["string","null"],"description":"The user-facing identifier of the vendor as assigned by the ERP.","example":"V0001"},"name":{"type":"string","description":"Display name of the vendor (company name for businesses, full name for individuals).","example":"Acme Supply Co."},"email":{"type":["string","null"],"description":"Primary email address recorded on the vendor.","example":"ap@acme-supply.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the vendor.","example":"415-555-0193"},"is_individual":{"type":["boolean","null"],"description":"Whether the vendor is a person rather than a company.","example":false},"active":{"type":["boolean","null"],"description":"Whether the vendor is active in the ERP.","example":true},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the vendor. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpVendorCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the vendor in the external system (WMS/Freight etc).","example":"https://example.com/vendor/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":{}}},"required":["active","additional_fields","created_date","custom_fields","email","external_system_url","id","is_individual","name","phone","trackstar_tags","updated_date","vendor_number"],"additionalProperties":false,"title":"AddErpVendorsTagsResponseDataSchema"},"erpAddTrackstarTagVendorResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpVendorsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagVendorResponse"},"AddTrackstarTagvendorsSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagvendorsSchema"},"SandboxReturnReceiveLineItem":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the item.","example":"XS-RED-SHIRT"},"received_quantity":{"type":"integer","description":"Units received.","example":2},"condition":{"type":"string","description":"Item condition.","example":"good"},"disposition":{"type":"string","description":"Disposition action.","example":"return_to_stock"}},"required":["condition","disposition","received_quantity","sku"],"additionalProperties":false,"title":"SandboxReturnReceiveLineItem"},"SandboxReturnReceiveSchema":{"type":"object","properties":{"line_items":{"type":"array","description":"The line items being received with inspection results.","items":{"$ref":"#/components/schemas/SandboxReturnReceiveLineItem"}}},"required":["line_items"],"additionalProperties":false,"title":"SandboxReturnReceiveSchema"},"WmsWarehouseLocationIdsQueryParam":{"type":"object","properties":{"in":{"type":"array","description":"A comma-separated list of resource IDs. If provided, all other query params are ignored.","example":"resource_id_1,resource_id_2","items":{"type":"string","description":"","example":"_in"}}},"required":["in"],"additionalProperties":false,"title":"WmsWarehouseLocationIdsQueryParam"},"WmsWarehouseLocationCreated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseLocationCreated_DateQueryParam"},"WmsWarehouseLocationUpdated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseLocationUpdated_DateQueryParam"},"WmsWarehouseLocationTrackstar_Created_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseLocationTrackstar_Created_DateQueryParam"},"WmsWarehouseLocationTrackstar_Updated_DateQueryParam":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"neq":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"gt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"gte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lt":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"lte":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false,"title":"WmsWarehouseLocationTrackstar_Updated_DateQueryParam"},"WmsWarehouseLocationTypeQueryParam":{"type":"object","properties":{"eq":{"type":"string","description":"","example":"pallet"},"neq":{"type":"string","description":"","example":"neq"},"in":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"_in"}},"nin":{"type":"array","description":"Comma-separated.","items":{"type":"string","description":"","example":"nin"}},"contains":{"type":"string","description":"","example":"contains"},"not_contains":{"type":"string","description":"","example":"not_contains"}},"additionalProperties":false,"title":"WmsWarehouseLocationTypeQueryParam"},"LocationMeasurements":{"type":"object","properties":{"length":{"type":["number","null"],"description":"","example":1.5},"width":{"type":["number","null"],"description":"","example":1.5},"height":{"type":["number","null"],"description":"","example":1.5},"unit":{"type":["string","null"],"enum":["cm","in"],"description":"The unit of measurement for the size of the location.","example":"in"},"weight":{"type":["number","null"],"description":"","example":2.5},"weight_unit":{"type":["string","null"],"enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the location.","example":"lb"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"LocationMeasurements"},"WmsWarehouseLocationApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the location.","example":"location_id"},"created_date":{"type":"string","format":"date-time","description":"The date the location was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the location was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":["string","null"],"description":"The name of the location.","example":"Location Name"},"warehouse_id":{"type":"string","description":"The ID of the warehouse the location is in.","example":"warehouse_id"},"type":{"type":["string","null"],"description":"The location type","example":"pallet"},"measurements":{"$ref":"#/components/schemas/LocationMeasurements"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","id","measurements","name","trackstar_created_date","trackstar_updated_date","type","updated_date","warehouse_id"],"additionalProperties":false,"title":"WmsWarehouseLocationApiItemSchema"},"WmsWarehouseLocationsListEndpoint":{"type":"object","properties":{"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/WmsWarehouseLocationApiItemSchema"}},"next_token":{"type":["string","null"],"description":"See [pagination](/how-to-guides/about-the-api#pagination) for more details.","example":"next_token"},"total_count":{"type":"integer","description":"The number of items returned.","example":1}},"required":["data","next_token","total_count"],"additionalProperties":false,"title":"WmsWarehouseLocationsListEndpoint"},"ErpSalesOrderShipmentsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpSalesOrderShipmentApiItemSchema"}},"additionalProperties":false,"title":"ErpSalesOrderShipmentsSingleItemEndpoint"},"ErpPurchaseOrdersSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpPurchaseOrderApiItemSchema"}},"additionalProperties":false,"title":"ErpPurchaseOrdersSingleItemEndpoint"},"UpdateErpPurchaseOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the purchase order in the ERP.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"status":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"The status of the purchase order. See the [purchase order information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Receipt', 'Partially Received').","example":"Pending Receipt"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":["string","null"],"description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"total_price":{"type":["number","null"],"description":"Grand total the supplier will be paid for the order (item subtotal plus tax and shipping minus discount), in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"id":"id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","employee_id","expected_arrival_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","status","total_price","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","vendor_id"],"additionalProperties":false,"title":"UpdateErpPurchaseOrderResponseDataSchema"},"erpUpdatePurchaseOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UpdateErpPurchaseOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpUpdatePurchaseOrderResponse"},"UpdateErpPurchaseOrderLineItem":{"type":"object","properties":{"item_id":{"type":"string","description":"","example":"item_id"},"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"number","description":"","example":0.0},"unit_price":{"type":"number","description":"","example":0.0},"location_id":{"type":"string","description":"","example":"location_id"},"line_item_id":{"type":"string","description":"ID of the source purchase order line being updated. Required to edit or close an existing line; omit when adding a new line.","example":"line_1"},"close":{"type":"boolean","description":"Set to true to close this open line on the purchase order. Closing transitions the order toward closed/received without requiring the line to be received \u2014 used to short-circuit the remainder of the order. Requires line_item_id and is mutually exclusive with quantity.","example":false}},"additionalProperties":true,"title":"UpdateErpPurchaseOrderLineItem"},"UpdateErpPurchaseOrderSchema":{"type":"object","properties":{"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":{}},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":"string","description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"reference_id":{"type":"string","description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":"string","format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"location_id":{"type":"string","description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/UpdateErpPurchaseOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}},"status":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"The status of the purchase order. See the [purchase order information](info) for more details.","example":"pending_approval"}},"required":["line_items","status"],"additionalProperties":true,"title":"UpdateErpPurchaseOrderSchema"},"AddWmsProductsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":["number","null"],"description":"The price of the product.","example":10.99},"inventory_items":{"type":"array","description":"A list of inventory items associated with the product.","example":[{"inventory_item_id":"id1","sku":"sku1","unit_quantity":1},{"inventory_item_id":"id2","sku":"sku2","unit_quantity":1}],"items":{"$ref":"#/components/schemas/ProductInventoryItems"}},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/ProductSupplier"},{"type":"null"}]},"country_of_origin":{"type":["string","null"],"description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":["string","null"],"description":"The harmonized HS code of the product.","example":"123456"},"supplier_products":{"type":"array","description":"A list of supplier products associated with the product.","example":[{"supplier_id":"id1","supplier_name":"name1","external_id":"ext_id1","unit_cost":1.0},{"supplier_id":"id2","supplier_name":"name2","external_id":"ext_id2","unit_cost":2.5}],"items":{"$ref":"#/components/schemas/ProductSupplierProducts"}},"categories":{"type":"array","description":"A list of category names associated with the product.","example":["Electronics","Accessories"],"items":{"type":"string","description":"","example":"categories"}},"image_urls":{"type":"array","description":"A list of image URLs associated with the product.","example":["https://example.com/image1.jpg"],"items":{"type":"string","description":"","example":"image_urls"}},"external_system_url":{"type":["string","null"],"description":"URL link to the product in the external system (WMS/Freight etc).","example":"https://example.com/product/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":{}}},"required":["active","additional_fields","categories","country_of_origin","created_date","external_system_url","gtin","harmonized_code","id","image_urls","inventory_items","is_kit","name","sku","supplier_object","supplier_products","trackstar_tags","unit_price","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"AddWmsProductsTagsResponseDataSchema"},"wmsAddTrackstarTagProductResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddWmsProductsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsAddTrackstarTagProductResponse"},"AddTrackstarTagproductsSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagproductsSchema"},"CancelErpSalesOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sales order in the ERP.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"status":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"The status of the sales order. See the [sales order information](info) for more details.","example":"closed"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Fulfillment', 'Partially Fulfilled').","example":"Pending Fulfillment"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"subtotal":{"type":["number","null"],"description":"Sum of item line amounts before tax, shipping, and discount, in the order currency.","example":100.0},"total_tax":{"type":["number","null"],"description":"Total tax charged on the order, in the order currency.","example":8.5},"total_shipping":{"type":["number","null"],"description":"Total shipping charged on the order, in the order currency.","example":12.0},"total_discount":{"type":["number","null"],"description":"Total discount applied to the order, in the order currency.","example":5.0},"total_price":{"type":["number","null"],"description":"Grand total the customer will be billed for the order, in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_method_id":{"type":["string","null"],"description":"ID of the shipping method on the order.","example":"sm_1"},"shipping_method_name":{"type":["string","null"],"description":"Display name of the shipping method.","example":"UPS Ground"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0}],"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order in the external system (WMS/Freight etc).","example":"https://example.com/salesorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","customer_id","expected_ship_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","shipping_method_id","shipping_method_name","status","subtotal","total_discount","total_price","total_shipping","total_tax","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date"],"additionalProperties":false,"title":"CancelErpSalesOrderResponseDataSchema"},"erpCancelSalesOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CancelErpSalesOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpCancelSalesOrderResponse"},"ErpPurchaseOrderReceiptsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptApiItemSchema"}},"additionalProperties":false,"title":"ErpPurchaseOrderReceiptsSingleItemEndpoint"},"WmsShippingMethodsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsShippingMethodApiItemSchema"}},"additionalProperties":false,"title":"WmsShippingMethodsSingleItemEndpoint"},"AddCartProductsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"created_date":{"type":"string","format":"date-time","description":"The date the cart product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the cart product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the product.","example":"product_name"},"sku":{"type":["string","null"],"description":"The SKU of the product.","example":"sku"},"gtin":{"type":["string","null"],"description":"The GTIN of the product.","example":"gtin"},"parent_product_id":{"type":"string","description":"If this is a variant, the ID of the parent product. If this is a parent product, this field should be the same as ID.","example":"parent_product_id"},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"image_url":{"type":["string","null"],"description":"The URL of the product's image.","example":"https://example.com/image.jpg"},"price":{"type":["number","null"],"description":"The price of the product if it is a variant. Not the source of truth for parent products.","example":10.0},"unit_cost":{"type":["number","null"],"description":"The unit cost of the product if it is a variant. Not the source of truth for parent products.","example":10.0},"inventory":{"type":["integer","null"],"description":"The inventory of the product if it is a variant. Not the source of truth for parent products.","example":10},"inventory_by_warehouse_id":{"type":"object","description":"Inventory broken down by warehouse.","example":{"warehouse_id_1":6,"warehouse_id_2":4},"additionalProperties":{"type":"integer","description":"Inventory for that warehouse.","example":5}},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"},"tags":{"type":"array","description":"A list of tags associated with the product. Tags that are represented as key-value pairs in the underlying system will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the product.","example":"tag_0"}},"categories":{"type":"array","description":"A list of category names the product belongs to. For platforms with a hierarchical category tree, each level is a separate element with the leaf last (e.g. [\"Apparel\", \"Shoes\", \"Running\"]). For platforms with a single scalar product type, a single-element list.","example":["Apparel","Shoes","Running"],"items":{"type":"string","description":"A category name.","example":"Apparel"}},"external_system_url":{"type":["string","null"],"description":"URL link to the cart product in the external system (WMS/Freight etc).","example":"https://example.com/cartproduct/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":{}}},"required":["active","additional_fields","categories","created_date","external_system_url","gtin","id","image_url","inventory","inventory_by_warehouse_id","is_kit","measurements","name","parent_product_id","price","sku","tags","trackstar_tags","unit_cost","updated_date"],"additionalProperties":false,"title":"AddCartProductsTagsResponseDataSchema"},"cartAddTrackstarTagProductResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddCartProductsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"cartAddTrackstarTagProductResponse"},"AddErpLocationsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the location in the ERP.","example":"loc_1"},"created_date":{"type":"string","format":"date-time","description":"The date the location was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the location was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the location as shown in the ERP.","example":"Fresno DC"},"code":{"type":["string","null"],"description":"A short user-facing code for the location. Many ERPs do not distinguish a code from the name.","example":"FRE"},"active":{"type":["boolean","null"],"description":"Whether the location is active in the ERP.","example":true},"location_type":{"type":["string","null"],"description":"The ERP's classification for the location (e.g., Warehouse, Store, Office).","example":"Warehouse"},"full_path":{"type":["string","null"],"description":"The hierarchical path of the location (e.g., 'North America : West : Fresno DC'). Populated when the ERP nests locations under parents.","example":"North America : West : Fresno DC"},"parent_location_id":{"type":["string","null"],"description":"ID of the parent location in the ERP's location hierarchy.","example":"loc_parent_1"},"parent_location_name":{"type":["string","null"],"description":"Display name of the parent referenced by parent_location_id.","example":"West"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the location. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpLocationCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the location in the external system (WMS/Freight etc).","example":"https://example.com/location/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":{}}},"required":["active","additional_fields","address","code","created_date","custom_fields","external_system_url","full_path","id","location_type","name","parent_location_id","parent_location_name","trackstar_tags","updated_date"],"additionalProperties":false,"title":"AddErpLocationsTagsResponseDataSchema"},"erpAddTrackstarTagLocationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpLocationsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagLocationResponse"},"AddTrackstarTaglocationsSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTaglocationsSchema"},"AddErpCustomersTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the customer in the ERP.","example":"cust_1"},"created_date":{"type":"string","format":"date-time","description":"The date the customer was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the customer was last updated.","example":"2022-01-02T05:05:05Z"},"customer_number":{"type":["string","null"],"description":"The user-facing identifier of the customer as assigned by the ERP.","example":"CUS0001"},"name":{"type":"string","description":"Display name of the customer (company name for businesses, full name for individuals).","example":"Acme Co."},"email":{"type":["string","null"],"description":"Primary email address recorded on the customer.","example":"buyer@example.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the customer.","example":"415-555-0142"},"is_individual":{"type":["boolean","null"],"description":"Whether the customer is a person (B2C) rather than a company (B2B).","example":false},"active":{"type":["boolean","null"],"description":"Whether the customer is active in the ERP.","example":true},"billing_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_address":{"$ref":"#/components/schemas/ShipToAddress"},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the customer. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpCustomerCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the customer in the external system (WMS/Freight etc).","example":"https://example.com/customer/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":{}}},"required":["active","additional_fields","billing_address","created_date","custom_fields","customer_number","email","external_system_url","id","is_individual","name","phone","shipping_address","trackstar_tags","updated_date"],"additionalProperties":false,"title":"AddErpCustomersTagsResponseDataSchema"},"erpAddTrackstarTagCustomerResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpCustomersTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagCustomerResponse"},"AddTrackstarTagcustomersSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagcustomersSchema"},"AddErpEmployeesTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the employee in the ERP.","example":"emp_1"},"created_date":{"type":"string","format":"date-time","description":"The date the employee was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the employee was last updated.","example":"2022-01-02T05:05:05Z"},"employee_number":{"type":["string","null"],"description":"The user-facing identifier of the employee as assigned by the ERP.","example":"E0001"},"name":{"type":"string","description":"Display name of the employee (firstname + lastname, or entityid fallback).","example":"Jane Smith"},"first_name":{"type":["string","null"],"description":"Employee's first name.","example":"Jane"},"last_name":{"type":["string","null"],"description":"Employee's last name.","example":"Smith"},"email":{"type":["string","null"],"description":"Primary email address recorded on the employee.","example":"jane.smith@example.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the employee.","example":"415-555-0193"},"title":{"type":["string","null"],"description":"Job title of the employee.","example":"Warehouse Manager"},"active":{"type":["boolean","null"],"description":"Whether the employee is active in the ERP.","example":true},"supervisor_id":{"type":["string","null"],"description":"Internal ID of the employee's supervisor.","example":"42"},"approver_id":{"type":["string","null"],"description":"Internal ID of the employee's general approver.","example":"43"},"location_id":{"type":["string","null"],"description":"Internal ID of the employee's primary location.","example":"309"},"subsidiary_id":{"type":["string","null"],"description":"Internal ID of the employee's subsidiary.","example":"1"},"purchase_order_limit":{"type":["number","null"],"description":"Maximum purchase order amount this employee can author. Units vary by account configuration.","example":10.0},"purchase_order_approver_id":{"type":["string","null"],"description":"Internal ID of the employee who approves this employee's purchase orders.","example":"44"},"purchase_order_approval_limit":{"type":["number","null"],"description":"Maximum purchase order amount this employee can approve for others. Units vary by account configuration.","example":10.0},"expense_limit":{"type":["number","null"],"description":"Maximum expense report amount for this employee. Units vary by account configuration.","example":500.0},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the employee. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpEmployeeCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the employee in the external system (WMS/Freight etc).","example":"https://example.com/employee/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":{}}},"required":["active","additional_fields","approver_id","created_date","custom_fields","email","employee_number","expense_limit","external_system_url","first_name","id","last_name","location_id","name","phone","purchase_order_approval_limit","purchase_order_approver_id","purchase_order_limit","subsidiary_id","supervisor_id","title","trackstar_tags","updated_date"],"additionalProperties":false,"title":"AddErpEmployeesTagsResponseDataSchema"},"erpAddTrackstarTagEmployeeResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpEmployeesTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagEmployeeResponse"},"AddTrackstarTagemployeesSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagemployeesSchema"},"AddWmsInventoryTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item.","example":"inv_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"unit_cost":{"type":["number","null"],"description":"The cost of a single unit of the inventory item.","example":1.0},"active":{"type":"boolean","description":"Whether the inventory item is active.","example":true},"awaiting":{"type":"integer","description":"Inventory that the warehouse is awaiting delivery of.","example":0},"onhand":{"type":"integer","description":"The total amount of inventory in the warehouse.","example":5},"committed":{"type":"integer","description":"Inventory that is already assigned to orders.","example":1},"unfulfillable":{"type":"integer","description":"Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).","example":0},"fulfillable":{"type":"integer","description":"Inventory that can be fulfilled for orders.","example":4},"sellable":{"type":"integer","description":"Inventory that is available in sales channels.","example":2},"substitute_skus":{"type":"array","description":"A list of inventory item SKUs that can replace this item if it runs out of stock.","example":["sub_sku_1","sub_sku_2"],"items":{"type":"string","description":"sub_sku","example":"substitute_skus"}},"inventory_by_warehouse_id":{"type":"object","description":"Inventory broken down by warehouse.","example":{"warehouse_id_1":{"onhand":4,"committed":1,"unfulfillable":0,"fulfillable":3,"sellable":2,"awaiting":0},"warehouse_id_2":{"onhand":1,"committed":0,"unfulfillable":0,"fulfillable":1,"sellable":1,"awaiting":0}},"additionalProperties":{"$ref":"#/components/schemas/InventoryInWarehouse"}},"lots":{"type":"array","description":"A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.","example":[{"lot_id":"lot_id_1","onhand":2,"expiration_date":"2022-01-01T00:00:00Z","warehouse_id":"warehouse_id1"},{"lot_id":"lot_id_2","onhand":1,"expiration_date":"2022-01-03T00:00:00Z","warehouse_id":"warehouse_id2"}],"items":{"$ref":"#/components/schemas/Lot"}},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurements"},"locations":{"type":"array","description":"A list of locations within a warehouse where the inventory item is stored.","example":[{"location_id":"location_id_1","quantity":2,"warehouse_id":"warehouse_id1"},{"location_id":"location_id_2","quantity":1,"warehouse_id":"warehouse_id2"}],"items":{"$ref":"#/components/schemas/Location"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inventory item in the external system (WMS/Freight etc).","example":"https://example.com/inventoryitem/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":{}}},"required":["active","additional_fields","awaiting","committed","created_date","external_system_url","fulfillable","id","inventory_by_warehouse_id","locations","lots","measurements","name","onhand","sellable","sku","substitute_skus","trackstar_tags","unfulfillable","unit_cost","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"AddWmsInventoryTagsResponseDataSchema"},"wmsAddTrackstarTagInventoryItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddWmsInventoryTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsAddTrackstarTagInventoryItemResponse"},"AddTrackstarTaginventorySchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTaginventorySchema"},"WmsInboundShipmentsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsInboundShipmentApiItemSchema"}},"additionalProperties":false,"title":"WmsInboundShipmentsSingleItemEndpoint"},"wmsUpdateInboundShipmentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsInboundShipmentApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateInboundShipmentResponse"},"SandboxUpdateInboundShipmentLineItems":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":1}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"SandboxUpdateInboundShipmentLineItems"},"UpdatewmsInboundShipment--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/SupplierIdSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_35604"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":1}],"items":{"$ref":"#/components/schemas/SandboxUpdateInboundShipmentLineItems"}}},"additionalProperties":false,"title":"WMS Sandbox"},"WmsInboundShipmentUpdateLineItembluebox":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"gtin":{"type":"string","description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"The cost per product that is charged by the manufacturer","example":1.0}},"required":["expected_quantity","gtin","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItembluebox"},"UpdatewmsInboundShipment--BlueBox__-_IDrive__Fulfillment_---":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressBluebox"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","gtin":"gtin","expected_quantity":0,"unit_cost":1.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItembluebox"}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"carton_count":{"type":"integer","description":"The number of cartons that are being shipped in the shipment","example":1}},"required":["line_items","purchase_order_number","warehouse_id"],"additionalProperties":false,"title":"BlueBox (IDrive Fulfillment)"},"WmsInboundShipmentUpdateLineItemboxzooka":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"external_id":{"type":"string","description":"","example":"external_id"},"lot_id":{"type":"string","description":"","example":"lot_id"},"expiration_date":{"type":"string","format":"date","description":"","example":"2023-03-15"}},"required":["sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemboxzooka"},"UpdatewmsInboundShipment--Boxzooka--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"external_id":"external_id","lot_id":"lot_id","expiration_date":"2023-03-15"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemboxzooka"}}},"additionalProperties":false,"title":"Boxzooka"},"WmsInboundShipmentUpdateLineItemclarus":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"","example":"108"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"lot":{"type":"string","description":"","example":"lot"},"storage_unit_quantity":{"type":"integer","minimum":1,"description":"","example":0}},"required":["expected_quantity","inventory_item_id"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemclarus"},"UpdatewmsInboundShipment--Clarus--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"108","expected_quantity":0,"lot":"lot","storage_unit_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemclarus"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"additionalProperties":false,"title":"Clarus"},"WmsInboundShipmentUpdateLineItemcontrolport":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0},"line_item_id":{"type":"string","description":"The specific line to update, needed only when the same product already appears on the shipment more than once.","example":"line_item_id"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemcontrolport"},"UpdatewmsInboundShipment--J_AMP_J__Global__Fulfillment__-_Control__Port_---":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0,"line_item_id":"line_item_id"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemcontrolport"}}},"additionalProperties":false,"title":"J&J Global Fulfillment (Control Port)"},"Update":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"received_quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","received_quantity","sku"],"additionalProperties":false,"title":"Update"},"UpdatewmsInboundShipment--Cin7__Core__-_Dear__Systems_---":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"received_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/Update"}}},"required":["warehouse_id"],"additionalProperties":false,"title":"Cin7 Core (Dear Systems)"},"WmsInboundShipmentUpdateLineItemdeposco":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"received_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0},"inbound_lpn":{"type":"string","description":"","example":"inbound_lpn"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemdeposco"},"UpdatewmsInboundShipment--Deposco--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"received_quantity":0,"unit_cost":0.0,"inbound_lpn":"inbound_lpn"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemdeposco"}},"order_source":{"type":"string","description":"Name of the external system from which the inbound originated.","example":"my_system"}},"additionalProperties":false,"title":"Deposco"},"WmsInboundShipmentUpdateLineItemextensiv-3pl-central":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"external_id":{"type":["string","null"],"description":"","example":"external_id"},"warehouse_location_id":{"type":["string","null"],"description":"","example":"warehouse_location_id"},"lot_number":{"type":["string","null"],"description":"","example":"lot_number"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemextensiv-3pl-central"},"UpdatewmsInboundShipment--Extensiv__-_3PL__Central_---":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"external_id":"external_id","warehouse_location_id":"warehouse_location_id","lot_number":"lot_number"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemextensiv-3pl-central"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"required":["line_items"],"additionalProperties":false,"title":"Extensiv (3PL Central)"},"UpdatewmsInboundShipment--Flexport__-_Deliverr_---":{"type":"object","properties":{"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":{}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressFlexport"},"tracking_number":{"type":"string","description":"The tracking number for the inbound shipment.","example":"tracking_number"}},"additionalProperties":false,"title":"Flexport (Deliverr)"},"UpdatewmsInboundShipment--GoBolt--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"shipment_type":{"type":"string","default":"parcel","enum":["parcel","pallet","floor_loaded","container","drop_off"],"description":"The shipment type for your inbound, defaults to parcel","example":"parcel"},"box_packing_option":{"type":"string","default":"multiple_sku_per_box","enum":["one_sku_per_box","multiple_sku_per_box"],"description":"Box packing option, defaults to multiple_sku_per_box","example":"multiple_sku_per_box"},"box_expected_quantity":{"type":"integer","default":1,"description":"Expected number of boxes, defaults to 1","example":0},"pallet_packing_option":{"type":"string","default":"multiple_sku_per_pallet","enum":["one_sku_per_pallet","multiple_sku_per_pallet"],"description":"Pallet packing option, defaults to multiple_sku_per_pallet if shipment_type is pallet","example":"multiple_sku_per_pallet"},"container_size":{"type":"string","enum":["20_ft","40_ft"],"description":"Container size, required for container shipments","example":"20_ft"},"pallet_expected_quantity":{"type":"integer","default":1,"description":"Expected number of pallets, defaults to 1 if shipment_type is pallet","example":0},"reference_number":{"type":"string","description":"","example":"reference_number"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateLineItemgobolt"}}},"additionalProperties":false,"title":"GoBolt"},"WmsInboundShipmentUpdateLineItemhelm-wms":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemhelm-wms"},"UpdatewmsInboundShipment--Helm__WMS--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemhelm-wms"}}},"additionalProperties":false,"title":"Helm WMS"},"WmsInboundShipmentUpdateLineItemhive":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemhive"},"UpdatewmsInboundShipment--Hive--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"delivery_option":{"type":"string","enum":["courier","dropoff","hive_freight","postal"],"description":"Delivery method for the shipment","example":"courier"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemhive"}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"}},"additionalProperties":false,"title":"Hive"},"WmsInboundShipmentUpdateLineIteminfoplus":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineIteminfoplus"},"UpdatewmsInboundShipment--Infoplus--":{"type":"object","properties":{"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":{}},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"type":{"type":"string","enum":["Kit","Normal","Transfer"],"description":"Type of inbound shipment","example":"Kit"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineIteminfoplus"}}},"required":["line_items","purchase_order_number","supplier_object","type","warehouse_id"],"additionalProperties":false,"title":"Infoplus"},"UpdatewmsInboundShipment--Cart.com__-_Jazz__Central_---":{"type":"object","properties":{"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"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":{}}},"required":["expected_arrival_date"],"additionalProperties":false,"title":"Cart.com (Jazz Central)"},"UpdatewmsInboundShipment--Logiwa--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}}},"additionalProperties":false,"title":"Logiwa"},"WmsInboundShipmentUpdateLineItemlogiwa-io":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"pack_type":{"type":"string","description":"The pack type of the line item (default: Each)","example":"Each"},"lot_number":{"type":["string","null"],"description":"Lot/batch number for the items.","example":"lot_number"},"expiration_date":{"type":["string","null"],"description":"Expiration date for the lot in ISO format.","example":"expiration_date"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemlogiwa-io"},"UpdatewmsInboundShipment--Logiwa__IO--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_type":{"type":"string","description":"","example":"purchase_order_type"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"pack_type":"Each","lot_number":"lot_number","expiration_date":"expiration_date"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemlogiwa-io"}}},"required":["line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Logiwa IO"},"WmsInboundShipmentUpdateLineItemluminous":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_price":{"type":"number","minimum":0.0,"description":"Cost per unit. When omitted, the product's own cost is used.","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemluminous"},"UpdatewmsInboundShipment--Luminous--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_price":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemluminous"}}},"additionalProperties":false,"title":"Luminous"},"WmsInboundShipmentUpdateLineItemmasonhub":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"box_ids":{"type":"array","description":"List of box IDs associated with the line item. Not required.","items":{"type":"string","description":"Box ID","example":"box_1"}}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemmasonhub"},"UpdatewmsInboundShipment--MasonHub--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"box_ids":null}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemmasonhub"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"comments":{"type":"string","description":"Free-form comments about the inbound shipment.","example":"These shipments are often not labeled."},"box_ids":{"type":"array","description":"List of box IDs associated with the inbound shipment.","example":["box_1","box_2"],"items":{"type":"string","description":"Box ID","example":"box_1"}}},"required":["expected_arrival_date","line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"MasonHub"},"WmsInboundShipmentUpdateLineItemongoing":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemongoing"},"UpdatewmsInboundShipment--Ongoing__WMS--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemongoing"}}},"required":["line_items","purchase_order_number","supplier_object","warehouse_id"],"additionalProperties":false,"title":"Ongoing WMS"},"UpdatewmsInboundShipment--Packiyo--":{"type":"object","properties":{"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":{}},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"additionalProperties":false,"title":"Packiyo"},"UpdatewmsInboundShipment--ShipBob--":{"type":"object","properties":{"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":{}},"status":{"type":"string","enum":["cancelled"],"description":"Status of the shipment","example":"cancelled"}},"required":["status"],"additionalProperties":false,"title":"ShipBob"},"WmsInboundShipmentUpdateLineItemshipheroUpdate":{"type":"object","properties":{"sku":{"type":"string","description":"Cannot add new skus to line items, but can update fields for existing skus.","example":"sku"},"expected_quantity":{"type":"integer","description":"The number of units expected to be received","example":1}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemshipheroUpdate"},"UpdatewmsInboundShipment--ShipHero--":{"type":"object","properties":{"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Use this when you are a 3PL acting on behalf of one of your customers.","example":"warehouse_customer_id"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"shipping_price":{"type":"number","description":"Price of the shipment.","example":0.0},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":1,"expected_weight":1.0,"expected_weight_unit":"lb","unit_cost":1.0,"external_id":"external_id"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemshipheroUpdate"}},"status":{"type":"string","enum":["open","received","cancelled"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"},"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":{}}},"additionalProperties":false,"title":"ShipHero"},"WmsInboundShipmentUpdateLineItemshipmonk":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":["integer","null"],"description":"","example":0},"lot_id":{"type":"string","description":"Lot number of the items in the box.","example":"lot_id"},"lot_expiration_date":{"type":"string","format":"date-time","description":"Lot expiration date for the items in the box.","example":"2023-03-15T13:45:30Z"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemshipmonk"},"UpdatewmsInboundShipment--ShipMonk--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"handling_unit_type":{"type":"string","enum":["small_boxes","single_sku_pallet","mixed_sku_pallet","container_20_palletized","container_20_non_palletized","container_40_palletized","container_40_non_palletized","container_53_palletized","container_53_non_palletized","unknown"],"description":"Unit handling type for inbound shipment.","example":"container_20_non_palletized"},"handling_unit_quantity":{"type":"integer","description":"Number of handling units.","example":0},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"tracking_numbers":{"type":"array","description":"Tracking numbers for the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"lot_id":"lot_id","lot_expiration_date":"2023-03-15T13:45:30Z"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemshipmonk"}}},"required":["expected_arrival_date","handling_unit_quantity","handling_unit_type","supplier_object","warehouse_id"],"additionalProperties":false,"title":"ShipMonk"},"WmsInboundShipmentUpdateLineItemshipstream":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemshipstream"},"UpdatewmsInboundShipment--ShipStream--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemshipstream"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"additionalProperties":false,"title":"ShipStream"},"UpdatewmsInboundShipment--Shipwire--":{"type":"object","properties":{"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":{}},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2024-01-01"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemshipwire"}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddressShipwire"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"additionalProperties":false,"title":"Shipwire"},"UpdatewmsInboundShipment--SKUSavvy--":{"type":"object","properties":{"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":{}},"status":{"type":"string","enum":["cancelled"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"cancelled"}},"required":["status"],"additionalProperties":false,"title":"SKUSavvy"},"WmsInboundShipmentUpdateLineItemskuvault":{"type":"object","properties":{"sku":{"type":"string","description":"If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU.","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemskuvault"},"UpdatewmsInboundShipment--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemskuvault"}},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"required":["purchase_order_number","supplier_object"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"WmsInboundShipmentUpdateLineItemsojo":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"","example":"inventory_item_id"},"quantity":{"type":"integer","description":"","example":0}},"required":["inventory_item_id","quantity"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemsojo"},"UpdatewmsInboundShipment--Sojo--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"inventory_item_id","quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemsojo"}}},"additionalProperties":false,"title":"Sojo"},"WmsInboundShipmentUpdateLineItemtlogistics":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0},"unit_cost":{"type":"number","minimum":0.0,"description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemtlogistics"},"UpdatewmsInboundShipment--TLogistics--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemtlogistics"}}},"additionalProperties":false,"title":"TLogistics"},"WmsInboundShipmentUpdateLineItemunleashed":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemunleashed"},"UpdatewmsInboundShipment--Unleashed--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemunleashed"}}},"additionalProperties":false,"title":"Unleashed"},"WmsInboundShipmentUpdateLineItem":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"","example":0},"unit_cost":{"type":"number","description":"","example":0.0},"tax_rate":{"type":"number","description":"The tax rate for the line item.","example":0.0}},"required":["sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItem"},"UpdatewmsInboundShipment--Veeqo--":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"invoice_currency_code":{"type":"string","minLength":3,"maxLength":3,"description":"The currency the purchase order is priced in. Veeqo defaults to GBP, and won't let it change once the purchase order is active.","example":"USD"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":0,"unit_cost":0.0,"tax_rate":0.0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItem"}}},"additionalProperties":false,"title":"Veeqo"},"UpdatewmsInboundShipment--Warehance--":{"type":"object","properties":{"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":{}},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"additionalProperties":false,"title":"Warehance"},"WmsInboundShipmentUpdateLineItemwhiplash":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"expected_quantity":{"type":"integer","description":"Total quantity of the item expected to be received.","example":2},"lot_id":{"type":"string","description":"Lot number for the items. Only works if lot control is enabled for that item.","example":"lot_id"},"expiration_date":{"type":"string","description":"Expiration date for the lot in ISO format. Only works if lot control is enabled for that item.","example":"expiration_date"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentUpdateLineItemwhiplash"},"UpdatewmsInboundShipment--Whiplash__-_Ryder_---":{"type":"object","properties":{"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":{}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"purchase_order_number":{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","expected_quantity":2,"lot_id":"lot_id","expiration_date":"expiration_date"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentUpdateLineItemwhiplash"}},"tracking_number":{"type":"string","description":"Tracking number associated with the inbound shipment.","example":"tracking_number"}},"additionalProperties":false,"title":"Whiplash (Ryder)"},"UpdatewmsInboundShipmentInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/UpdatewmsInboundShipment--WMS__Sandbox--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--BlueBox__-_IDrive__Fulfillment_---"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Boxzooka--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Clarus--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--J_AMP_J__Global__Fulfillment__-_Control__Port_---"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Cin7__Core__-_Dear__Systems_---"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Deposco--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Flexport__-_Deliverr_---"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--GoBolt--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Helm__WMS--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Hive--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Infoplus--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Cart.com__-_Jazz__Central_---"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Logiwa--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Logiwa__IO--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Luminous--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--MasonHub--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Ongoing__WMS--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Packiyo--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--ShipBob--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--ShipHero--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--ShipMonk--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--ShipStream--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Shipwire--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--SKUSavvy--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Linnworks__Core__-_SKUVault_---"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Sojo--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--TLogistics--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Unleashed--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Veeqo--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Warehance--"},{"$ref":"#/components/schemas/UpdatewmsInboundShipment--Whiplash__-_Ryder_---"}],"title":"UpdatewmsInboundShipmentInputSchema"},"cartAdjustInventoryProductResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CartProductApiItemSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"cartAdjustInventoryProductResponse"},"AdjustInventorycartProduct--Cart__Sandbox--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Cart Sandbox"},"AdjustInventorycartProduct--Amazon--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","enum":["DEFAULT"],"description":"ID of the warehouse to adjust inventory in. (hit authenticated to get full enum)","example":"DEFAULT"}},"required":["adjustment_type","quantity","warehouse_id"],"additionalProperties":false,"title":"Amazon"},"AdjustInventorycartProduct--BigCommerce--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"reason":{"type":"string","enum":["recount","received","sold","damaged","other"],"description":"The reason for the inventory adjustment.","example":"damaged"}},"required":["adjustment_type","quantity","reason","warehouse_id"],"additionalProperties":false,"title":"BigCommerce"},"AdjustInventorycartProduct--eBay--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"eBay"},"AdjustInventorycartProduct--Etsy--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Etsy"},"AdjustInventorycartProduct--Faire--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Faire"},"AdjustInventorycartProduct--JOOR--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"JOOR"},"AdjustInventorycartProduct--Magento__-_Adobe__Commerce_---":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Magento (Adobe Commerce)"},"AdjustInventorycartProduct--Mirakl--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["exact"],"description":"The type of adjustment to make to the inventory.","example":"exact"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Mirakl"},"AdjustInventorycartProduct--NuOrder--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"future_date":{"type":"string","format":"date-time","description":"The future date for the adjustment. If not provided, the adjustment will be applied immediately.","example":"2030-01-01T00:00:00Z"}},"required":["adjustment_type","quantity","warehouse_id"],"additionalProperties":false,"title":"NuOrder"},"AdjustInventorycartProduct--OrderDesk--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease"],"description":"The type of adjustment to make to the inventory.","example":"increase"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"OrderDesk"},"AdjustInventorycartProduct--Overstock--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["exact"],"description":"The type of adjustment to make to the inventory.","example":"exact"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["adjustment_type","quantity","warehouse_id"],"additionalProperties":false,"title":"Overstock"},"AdjustInventorycartProduct--Rithum__-__Home__Depot--":{"type":"object","properties":{"quantity":{"type":"integer","minimum":0,"description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["exact"],"description":"The type of adjustment to make to the inventory.","example":"exact"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"oms_id":{"type":"string","description":"The OMS ID of the product.","example":"123456789"}},"required":["adjustment_type","oms_id","quantity"],"additionalProperties":false,"title":"Rithum (_Home Depot"},"AdjustInventorycartProduct--Shopify--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"reason":{"type":"string","enum":["correction","cycle_count_available","damaged","movement_created","movement_updated","movement_received","payment_canceled","other","promotion","quality_control","received","reservation_created","reservation_updated","reservation_deleted","restock","safety_stock","shrinkage"],"description":"The reason for the inventory adjustment.","example":"correction"}},"required":["adjustment_type","quantity","reason","warehouse_id"],"additionalProperties":false,"title":"Shopify"},"AdjustInventorycartProduct--Squarespace--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Squarespace"},"AdjustInventorycartProduct--TikTok--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"},"shop_id":{"type":"string","description":"The TikTok shop ID of the product to adjust inventory for. If you only have one shop, we will default to it. Otherwise, you must provide a shop ID.","example":"shop_id"}},"required":["adjustment_type","quantity","shop_id","warehouse_id"],"additionalProperties":false,"title":"TikTok"},"AdjustInventorycartProduct--Walmart--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Walmart"},"AdjustInventorycartProduct--Wix--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"},"warehouse_id":{"type":"string","description":"ID of the warehouse to adjust inventory in.","example":"warehouse_id"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"Wix"},"AdjustInventorycartProduct--WooCommerce--":{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.","example":1},"adjustment_type":{"type":"string","enum":["increase","decrease","exact"],"description":"The type of adjustment to make to the inventory.","example":"increase"}},"required":["adjustment_type","quantity"],"additionalProperties":false,"title":"WooCommerce"},"AdjustInventorycartProductInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/AdjustInventorycartProduct--Cart__Sandbox--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Amazon--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--BigCommerce--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--eBay--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Etsy--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Faire--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--JOOR--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Magento__-_Adobe__Commerce_---"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Mirakl--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--NuOrder--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--OrderDesk--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Overstock--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Rithum__-__Home__Depot--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Shopify--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Squarespace--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--TikTok--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Walmart--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--Wix--"},{"$ref":"#/components/schemas/AdjustInventorycartProduct--WooCommerce--"}],"title":"AdjustInventorycartProductInputSchema"},"AddErpInventoryTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item in the ERP.","example":"inv_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The display name of the inventory item.","example":"Apple - Fuji"},"sku":{"type":["string","null"],"description":"The SKU / item number of the inventory item.","example":"10000"},"upc":{"type":["string","null"],"description":"UPC / GTIN barcode for the item.","example":"012345678905"},"active":{"type":"boolean","description":"Whether the inventory item is active.","example":true},"description":{"type":["string","null"],"description":"A long-form description of the inventory item.","example":"Fuji apple, loose"},"unit_cost":{"type":["number","null"],"description":"Cost of a single unit of the inventory item, expressed in the ERP's base currency. The accounting meaning (e.g., standard, average, FIFO/LIFO) depends on `costing_method`.","example":1.0},"costing_method":{"type":["string","null"],"description":"How the ERP values this item for inventory accounting (e.g., Standard, Average, FIFO, LIFO).","example":"Standard"},"stock_unit":{"type":["string","null"],"description":"Unit of measure for on-hand quantities (e.g., EA, LB, CS).","example":"EA"},"onhand":{"type":["number","null"],"description":"Total physical on-hand quantity across all locations.","example":42.5},"committed":{"type":["number","null"],"description":"Total quantity committed / reserved against orders across all locations.","example":2.5},"available":{"type":["number","null"],"description":"Total quantity available to sell across all locations (typically onhand minus committed).","example":40.0},"inventory_by_location_id":{"type":"object","description":"Inventory broken down by location. A location can be a warehouse, retail store, production line, or consignment site depending on how the ERP is configured.","example":{"location_id_1":{"onhand":42.5,"committed":2.5,"available":40.0},"location_id_2":{"onhand":0.0,"committed":0.0,"available":0.0}},"additionalProperties":{"$ref":"#/components/schemas/ErpInventoryAtLocation"}},"vendors":{"type":"array","description":"Vendors from whom this item is purchased.","example":[{"vendor_id":"vendor_1","vendor_name":"Acme Produce Co."}],"items":{"$ref":"#/components/schemas/ErpItemVendor"}},"lots":{"type":"array","description":"A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.","example":[{"lot_id":"9821","lot_name":"LOT-20260418-A","onhand":240.0,"expiration_date":"2026-05-09T00:00:00Z","location_id":"114"}],"items":{"$ref":"#/components/schemas/ErpLot"}},"bins":{"type":"array","description":"Bins are physical storage slots within a location. For items also tracked by lot, each entry is a (lot, bin) pair \u2014 the same bin can appear across multiple entries (holding different lots) and the same lot can appear across multiple bins.","example":[{"bin_id":"157","bin_name":"C-03-L3-P2","onhand":240.0,"location_id":"114","lot_id":"9821"}],"items":{"$ref":"#/components/schemas/ErpBin"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the inventory item. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpInventoryItemCustomFieldEntry"}},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurementsErp"},"external_system_url":{"type":["string","null"],"description":"URL link to the inventory item in the external system (WMS/Freight etc).","example":"https://example.com/inventoryitem/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":{}}},"required":["active","additional_fields","available","bins","committed","costing_method","created_date","custom_fields","description","external_system_url","id","inventory_by_location_id","lots","measurements","name","onhand","sku","stock_unit","trackstar_tags","unit_cost","upc","updated_date","vendors"],"additionalProperties":false,"title":"AddErpInventoryTagsResponseDataSchema"},"erpAddTrackstarTagInventoryItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpInventoryTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagInventoryItemResponse"},"AddWmsWarehousesTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse.","example":"warehouse_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"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":{}}},"required":["additional_fields","address","code","created_date","id","name","trackstar_tags","updated_date"],"additionalProperties":false,"title":"AddWmsWarehousesTagsResponseDataSchema"},"wmsAddTrackstarTagWarehouseResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddWmsWarehousesTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsAddTrackstarTagWarehouseResponse"},"AddTrackstarTagwarehousesSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagwarehousesSchema"},"AddCartWarehousesTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse.","example":"warehouse_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"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":{}}},"required":["address","code","created_date","id","name","trackstar_tags","updated_date"],"additionalProperties":false,"title":"AddCartWarehousesTagsResponseDataSchema"},"cartAddTrackstarTagWarehouseResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddCartWarehousesTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"cartAddTrackstarTagWarehouseResponse"},"CancelErpPurchaseOrderResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the purchase order in the ERP.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"status":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"The status of the purchase order. See the [purchase order information](info) for more details.","example":"closed"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Receipt', 'Partially Received').","example":"Pending Receipt"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":["string","null"],"description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"total_price":{"type":["number","null"],"description":"Grand total the supplier will be paid for the order (item subtotal plus tax and shipping minus discount), in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"id":"id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","bill_to_address","created_date","custom_fields","employee_id","expected_arrival_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","status","total_price","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","vendor_id"],"additionalProperties":false,"title":"CancelErpPurchaseOrderResponseDataSchema"},"erpCancelPurchaseOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CancelErpPurchaseOrderResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpCancelPurchaseOrderResponse"},"WmsWarehouseCustomersSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsWarehouseCustomerApiItemSchema"}},"additionalProperties":false,"title":"WmsWarehouseCustomersSingleItemEndpoint"},"AddErpSales_ordersTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sales order in the ERP.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"status":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"The status of the sales order. See the [sales order information](info) for more details.","example":"pending_approval"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Fulfillment', 'Partially Fulfilled').","example":"Pending Fulfillment"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"subtotal":{"type":["number","null"],"description":"Sum of item line amounts before tax, shipping, and discount, in the order currency.","example":100.0},"total_tax":{"type":["number","null"],"description":"Total tax charged on the order, in the order currency.","example":8.5},"total_shipping":{"type":["number","null"],"description":"Total shipping charged on the order, in the order currency.","example":12.0},"total_discount":{"type":["number","null"],"description":"Total discount applied to the order, in the order currency.","example":5.0},"total_price":{"type":["number","null"],"description":"Grand total the customer will be billed for the order, in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_method_id":{"type":["string","null"],"description":"ID of the shipping method on the order.","example":"sm_1"},"shipping_method_name":{"type":["string","null"],"description":"Display name of the shipping method.","example":"UPS Ground"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0}],"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order in the external system (WMS/Freight etc).","example":"https://example.com/salesorder/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":{}}},"required":["additional_fields","bill_to_address","created_date","custom_fields","customer_id","expected_ship_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","shipping_method_id","shipping_method_name","status","subtotal","total_discount","total_price","total_shipping","total_tax","trackstar_tags","updated_date"],"additionalProperties":false,"title":"AddErpSales_ordersTagsResponseDataSchema"},"erpAddTrackstarTagSalesOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpSales_ordersTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagSalesOrderResponse"},"AddTrackstarTagsales_ordersSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagsales_ordersSchema"},"CarrierInvoiceLineItemsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CarrierInvoiceLineItemApiItemSchema"}},"additionalProperties":false,"title":"CarrierInvoiceLineItemsSingleItemEndpoint"},"ReceiveInboundShipmentResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inbound shipment.","example":"inbound_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was last updated.","example":"2022-01-02T05:05:05Z"},"purchase_order_number":{"type":["string","null"],"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"receiving"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentSupplier"},{"type":"null"}]},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":["string","null"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":2,"received_quantity":1,"unit_cost":1.0,"external_id":"external_sku"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentLineItem"}},"receipts":{"type":"array","description":"List of receiving events associated with the inbound shipment.","example":[{"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"}]}],"items":{"$ref":"#/components/schemas/InboundReceipt"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddress"},"tracking_numbers":{"type":"array","description":"List of tracking numbers associated with the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inbound shipment in the external system (WMS/Freight etc).","example":"https://example.com/inboundshipment/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["additional_fields","created_date","expected_arrival_date","external_system_url","id","line_items","notes","purchase_order_number","raw_status","receipts","ship_from_address","status","supplier_object","tracking_numbers","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"ReceiveInboundShipmentResponseDataSchema"},"wmsCreateReceiptInboundShipmentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ReceiveInboundShipmentResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateReceiptInboundShipmentResponse"},"WmsInboundShipmentCreateReceiptLineItemsandbox":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"sku"},"quantity":{"type":"integer","description":"","example":1}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateReceiptLineItemsandbox"},"CreateReceiptwmsInboundShipment--WMS__Sandbox--":{"type":"object","properties":{"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":{}},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","quantity":1}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateReceiptLineItemsandbox"}}},"required":["line_items"],"additionalProperties":false,"title":"WMS Sandbox"},"CreateReceiptwmsInboundShipment--Extensiv__-_3PL__Central_---":{"type":"object","properties":{},"additionalProperties":false,"title":"Extensiv (3PL Central)"},"WmsInboundShipmentCreateReceiptLineItemluminous":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku"},"quantity":{"type":"integer","description":"Total quantity of the item that has been received.","example":1}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateReceiptLineItemluminous"},"CreateReceiptwmsInboundShipment--Luminous--":{"type":"object","properties":{"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","quantity":1}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentCreateReceiptLineItemluminous"}},"warehouse_location_id":{"type":"string","description":"Location where the item is being received.","example":"location"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"}},"required":["line_items","warehouse_id","warehouse_location_id"],"additionalProperties":false,"title":"Luminous"},"WmsInboundShipmentWriteLineItemskuvaultReceipt":{"type":"object","properties":{"sku":{"type":"string","description":"If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU.","example":"sku"},"quantity":{"type":"integer","description":"","example":0}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemskuvaultReceipt"},"CreateReceiptwmsInboundShipment--Linnworks__Core__-_SKUVault_---":{"type":"object","properties":{"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","quantity":0}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentWriteLineItemskuvaultReceipt"}},"supplier_object":{"description":"The supplier from which the shipment is being sent.","$ref":"#/components/schemas/WriteSupplierSchema"},"warehouse_location_id":{"type":"string","description":"Location where the items are being received.","example":"warehouse_location_id"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"}},"required":["line_items","supplier_object"],"additionalProperties":false,"title":"Linnworks Core (SKUVault)"},"CreateReceiptwmsInboundShipmentInputSchema":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/CreateReceiptwmsInboundShipment--WMS__Sandbox--"},{"$ref":"#/components/schemas/CreateReceiptwmsInboundShipment--Extensiv__-_3PL__Central_---"},{"$ref":"#/components/schemas/CreateReceiptwmsInboundShipment--Luminous--"},{"$ref":"#/components/schemas/CreateReceiptwmsInboundShipment--Linnworks__Core__-_SKUVault_---"}],"title":"CreateReceiptwmsInboundShipmentInputSchema"},"AddErpPurchase_ordersTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the purchase order in the ERP.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"status":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"The status of the purchase order. See the [purchase order information](info) for more details.","example":"pending_approval"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Receipt', 'Partially Received').","example":"Pending Receipt"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":["string","null"],"description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"total_price":{"type":["number","null"],"description":"Grand total the supplier will be paid for the order (item subtotal plus tax and shipping minus discount), in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"id":"id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorder/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":{}}},"required":["additional_fields","bill_to_address","created_date","custom_fields","employee_id","expected_arrival_date","external_system_url","id","line_items","location_id","notes","order_date","order_number","raw_status","reference_id","ship_to_address","status","total_price","trackstar_tags","updated_date","vendor_id"],"additionalProperties":false,"title":"AddErpPurchase_ordersTagsResponseDataSchema"},"erpAddTrackstarTagPurchaseOrderResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddErpPurchase_ordersTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"erpAddTrackstarTagPurchaseOrderResponse"},"AddTrackstarTagpurchase_ordersSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTagpurchase_ordersSchema"},"PassthroughSchema":{"type":"object","properties":{},"additionalProperties":false,"title":"PassthroughSchema"},"AddWmsInbound_shipmentsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inbound shipment.","example":"inbound_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was last updated.","example":"2022-01-02T05:05:05Z"},"purchase_order_number":{"type":["string","null"],"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentSupplier"},{"type":"null"}]},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":["string","null"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":2,"received_quantity":1,"unit_cost":1.0,"external_id":"external_sku"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentLineItem"}},"receipts":{"type":"array","description":"List of receiving events associated with the inbound shipment.","example":[{"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"}]}],"items":{"$ref":"#/components/schemas/InboundReceipt"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddress"},"tracking_numbers":{"type":"array","description":"List of tracking numbers associated with the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inbound shipment in the external system (WMS/Freight etc).","example":"https://example.com/inboundshipment/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":{}}},"required":["additional_fields","created_date","expected_arrival_date","external_system_url","id","line_items","notes","purchase_order_number","raw_status","receipts","ship_from_address","status","supplier_object","tracking_numbers","trackstar_tags","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"AddWmsInbound_shipmentsTagsResponseDataSchema"},"wmsAddTrackstarTagInboundShipmentResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddWmsInbound_shipmentsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsAddTrackstarTagInboundShipmentResponse"},"AddTrackstarTaginbound_shipmentsSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTaginbound_shipmentsSchema"},"WmsWarehouseLocationsSingleItemEndpoint":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WmsWarehouseLocationApiItemSchema"}},"additionalProperties":false,"title":"WmsWarehouseLocationsSingleItemEndpoint"},"AddCarrierInvoice_line_itemsTagsResponseDataSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the invoice line item.","example":"invoice_line_item_id"},"created_date":{"type":"string","format":"date-time","description":"The date the invoice line item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the invoice line item was last updated.","example":"2022-01-02T05:05:05Z"},"transaction_date":{"type":"string","format":"date-time","description":"The transaction date of the invoice line item.","example":"2025-11-15T00:00:00Z"},"account_id":{"type":"string","description":"The account ID associated with the invoice line item.","example":"account_id"},"invoice_id":{"type":"string","description":"The invoice ID.","example":"invoice_id"},"tracking_number":{"type":["string","null"],"description":"The tracking number associated with the invoice line item.","example":"tracking_number"},"gross_cost":{"type":"number","description":"The gross cost of the invoice line item.","example":10.0},"net_cost":{"type":"number","description":"The net cost of the invoice line item.","example":8.0},"charge_description":{"type":"string","description":"Description of the charge.","example":"Freight Charge"},"raw":{"description":"The raw invoice line item data."},"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":{}}},"required":["account_id","charge_description","created_date","gross_cost","id","invoice_id","net_cost","raw","tracking_number","trackstar_tags","transaction_date","updated_date"],"additionalProperties":false,"title":"AddCarrierInvoice_line_itemsTagsResponseDataSchema"},"carrierAddTrackstarTagInvoiceLineItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AddCarrierInvoice_line_itemsTagsResponseDataSchema"},"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":"","example":"unused_fields"}}},"required":["id","unused_fields"],"additionalProperties":false,"title":"carrierAddTrackstarTagInvoiceLineItemResponse"},"AddTrackstarTaginvoice_line_itemsSchema":{"type":"object","properties":{"trackstar_tags":{"type":"array","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":{}}},"required":["trackstar_tags"],"additionalProperties":false,"title":"AddTrackstarTaginvoice_line_itemsSchema"},"WmsInventoryCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryItemApiItemSchema"},"event_type":{"type":"string","enum":["inventory.created"],"description":"","example":"inventory.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsInventoryCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryCreatedTruncatedData"},"event_type":{"type":"string","enum":["inventory.created"],"description":"","example":"inventory.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsInventoryCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsInventoryCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsInventoryCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsInventoryCreatedTruncatedWebhook"}]},"WmsInventoryUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryItemApiItemSchema"},"event_type":{"type":"string","enum":["inventory.updated"],"description":"","example":"inventory.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsInventoryUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsInventoryUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item.","example":"inv_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"unit_cost":{"type":["number","null"],"description":"The cost of a single unit of the inventory item.","example":1.0},"active":{"type":"boolean","description":"Whether the inventory item is active.","example":true},"awaiting":{"type":"integer","description":"Inventory that the warehouse is awaiting delivery of.","example":0},"onhand":{"type":"integer","description":"The total amount of inventory in the warehouse.","example":5},"committed":{"type":"integer","description":"Inventory that is already assigned to orders.","example":1},"unfulfillable":{"type":"integer","description":"Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).","example":0},"fulfillable":{"type":"integer","description":"Inventory that can be fulfilled for orders.","example":4},"sellable":{"type":"integer","description":"Inventory that is available in sales channels.","example":2},"substitute_skus":{"type":"array","description":"A list of inventory item SKUs that can replace this item if it runs out of stock.","example":["sub_sku_1","sub_sku_2"],"items":{"type":"string","description":"sub_sku","example":"substitute_skus"}},"inventory_by_warehouse_id":{"type":"object","description":"Inventory broken down by warehouse.","example":{"warehouse_id_1":{"onhand":4,"committed":1,"unfulfillable":0,"fulfillable":3,"sellable":2,"awaiting":0},"warehouse_id_2":{"onhand":1,"committed":0,"unfulfillable":0,"fulfillable":1,"sellable":1,"awaiting":0}},"additionalProperties":{"$ref":"#/components/schemas/InventoryInWarehouse"}},"lots":{"type":"array","description":"A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.","example":[{"lot_id":"lot_id_1","onhand":2,"expiration_date":"2022-01-01T00:00:00Z","warehouse_id":"warehouse_id1"},{"lot_id":"lot_id_2","onhand":1,"expiration_date":"2022-01-03T00:00:00Z","warehouse_id":"warehouse_id2"}],"items":{"$ref":"#/components/schemas/Lot"}},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurements"},"locations":{"type":"array","description":"A list of locations within a warehouse where the inventory item is stored.","example":[{"location_id":"location_id_1","quantity":2,"warehouse_id":"warehouse_id1"},{"location_id":"location_id_2","quantity":1,"warehouse_id":"warehouse_id2"}],"items":{"$ref":"#/components/schemas/Location"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inventory item in the external system (WMS/Freight etc).","example":"https://example.com/inventoryitem/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsInventoryUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryUpdatedTruncatedData"},"event_type":{"type":"string","enum":["inventory.updated"],"description":"","example":"inventory.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsInventoryUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsInventoryUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsInventoryUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsInventoryUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsInventoryUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsInventoryUpdatedTruncatedWebhook"}]},"WmsProductsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsProductApiItemSchema"},"event_type":{"type":"string","enum":["product.created"],"description":"","example":"product.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsProductsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsProductsCreatedTruncatedData"},"event_type":{"type":"string","enum":["product.created"],"description":"","example":"product.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsProductsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsProductsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsProductsCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsProductsCreatedTruncatedWebhook"}]},"WmsProductsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsProductApiItemSchema"},"event_type":{"type":"string","enum":["product.updated"],"description":"","example":"product.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsProductsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsProductsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":["number","null"],"description":"The price of the product.","example":10.99},"inventory_items":{"type":"array","description":"A list of inventory items associated with the product.","example":[{"inventory_item_id":"id1","sku":"sku1","unit_quantity":1},{"inventory_item_id":"id2","sku":"sku2","unit_quantity":1}],"items":{"$ref":"#/components/schemas/ProductInventoryItems"}},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/ProductSupplier"},{"type":"null"}]},"country_of_origin":{"type":["string","null"],"description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":["string","null"],"description":"The harmonized HS code of the product.","example":"123456"},"supplier_products":{"type":"array","description":"A list of supplier products associated with the product.","example":[{"supplier_id":"id1","supplier_name":"name1","external_id":"ext_id1","unit_cost":1.0},{"supplier_id":"id2","supplier_name":"name2","external_id":"ext_id2","unit_cost":2.5}],"items":{"$ref":"#/components/schemas/ProductSupplierProducts"}},"categories":{"type":"array","description":"A list of category names associated with the product.","example":["Electronics","Accessories"],"items":{"type":"string","description":"","example":"categories"}},"image_urls":{"type":"array","description":"A list of image URLs associated with the product.","example":["https://example.com/image1.jpg"],"items":{"type":"string","description":"","example":"image_urls"}},"external_system_url":{"type":["string","null"],"description":"URL link to the product in the external system (WMS/Freight etc).","example":"https://example.com/product/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsProductsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsProductsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["product.updated"],"description":"","example":"product.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsProductsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsProductsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsProductsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsProductsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsProductsUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsProductsUpdatedTruncatedWebhook"}]},"WmsKitsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsKitApiItemSchema"},"event_type":{"type":"string","enum":["product.created"],"description":"","example":"product.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsKitsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsKitsCreatedTruncatedData"},"event_type":{"type":"string","enum":["product.created"],"description":"","example":"product.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsKitsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsKitsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsKitsCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsKitsCreatedTruncatedWebhook"}]},"WmsKitsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsKitApiItemSchema"},"event_type":{"type":"string","enum":["product.updated"],"description":"","example":"product.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsKitsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsKitsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the product. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"name","example":"name"},"sku":{"type":["string","null"],"description":"sku","example":"sku"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN.","example":"gtin"},"unit_price":{"type":["number","null"],"description":"The price of the product.","example":10.99},"inventory_items":{"type":"array","description":"A list of inventory items associated with the product.","example":[{"inventory_item_id":"id1","sku":"sku1","unit_quantity":1},{"inventory_item_id":"id2","sku":"sku2","unit_quantity":1}],"items":{"$ref":"#/components/schemas/ProductInventoryItems"}},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/ProductSupplier"},{"type":"null"}]},"country_of_origin":{"type":["string","null"],"description":"The country of origin of the product.","example":"USA"},"harmonized_code":{"type":["string","null"],"description":"The harmonized HS code of the product.","example":"123456"},"supplier_products":{"type":"array","description":"A list of supplier products associated with the product.","example":[{"supplier_id":"id1","supplier_name":"name1","external_id":"ext_id1","unit_cost":1.0},{"supplier_id":"id2","supplier_name":"name2","external_id":"ext_id2","unit_cost":2.5}],"items":{"$ref":"#/components/schemas/ProductSupplierProducts"}},"categories":{"type":"array","description":"A list of category names associated with the product.","example":["Electronics","Accessories"],"items":{"type":"string","description":"","example":"categories"}},"image_urls":{"type":"array","description":"A list of image URLs associated with the product.","example":["https://example.com/image1.jpg"],"items":{"type":"string","description":"","example":"image_urls"}},"external_system_url":{"type":["string","null"],"description":"URL link to the product in the external system (WMS/Freight etc).","example":"https://example.com/product/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsKitsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsKitsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["product.updated"],"description":"","example":"product.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsKitsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsKitsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsKitsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsKitsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsKitsUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsKitsUpdatedTruncatedWebhook"}]},"WmsInboundShipmentsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInboundShipmentApiItemSchema"},"event_type":{"type":"string","enum":["inbound-shipment.created"],"description":"","example":"inbound-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsInboundShipmentsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInboundShipmentsCreatedTruncatedData"},"event_type":{"type":"string","enum":["inbound-shipment.created"],"description":"","example":"inbound-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsInboundShipmentsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsInboundShipmentsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsInboundShipmentsCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsInboundShipmentsCreatedTruncatedWebhook"}]},"WmsInboundShipmentsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInboundShipmentApiItemSchema"},"event_type":{"type":"string","enum":["inbound-shipment.updated"],"description":"","example":"inbound-shipment.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsInboundShipmentsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsInboundShipmentsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inbound shipment.","example":"inbound_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was last updated.","example":"2022-01-02T05:05:05Z"},"purchase_order_number":{"type":["string","null"],"description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"supplier_object":{"anyOf":[{"$ref":"#/components/schemas/InboundShipmentSupplier"},{"type":"null"}]},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z"},"warehouse_id":{"type":["string","null"],"description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":2,"received_quantity":1,"unit_cost":1.0,"external_id":"external_sku"}],"items":{"$ref":"#/components/schemas/WmsInboundShipmentLineItem"}},"receipts":{"type":"array","description":"List of receiving events associated with the inbound shipment.","example":[{"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"}]}],"items":{"$ref":"#/components/schemas/InboundReceipt"}},"ship_from_address":{"$ref":"#/components/schemas/ShipFromAddress"},"tracking_numbers":{"type":"array","description":"List of tracking numbers associated with the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number"}},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note"}},"external_system_url":{"type":["string","null"],"description":"URL link to the inbound shipment in the external system (WMS/Freight etc).","example":"https://example.com/inboundshipment/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsInboundShipmentsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInboundShipmentsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["inbound-shipment.updated"],"description":"","example":"inbound-shipment.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsInboundShipmentsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsInboundShipmentsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsInboundShipmentsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsInboundShipmentsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsInboundShipmentsUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsInboundShipmentsUpdatedTruncatedWebhook"}]},"WmsInboundShipmentsReceipt.CreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInboundShipmentApiItemSchema"},"event_type":{"type":"string","enum":["inbound-shipment.receipt.created"],"description":"","example":"inbound-shipment.receipt.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/receipt.createdPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"receipt.createdPreviousAttributes":{"type":"object","properties":{"receipts":{"type":"array","description":"List of receiving events associated with the inbound shipment.","example":[{"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"}]}],"items":{"$ref":"#/components/schemas/InboundReceipt"}}},"required":["receipts"],"additionalProperties":false},"WmsInboundShipmentsReceipt.CreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInboundShipmentsReceipt.CreatedTruncatedData"},"event_type":{"type":"string","enum":["inbound-shipment.receipt.created"],"description":"","example":"inbound-shipment.receipt.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsInboundShipmentsReceipt.CreatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsInboundShipmentsReceipt.CreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsInboundShipmentsReceipt.CreatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsInboundShipmentsReceipt.CreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsInboundShipmentsReceipt.CreatedFullWebhook"},{"$ref":"#/components/schemas/WmsInboundShipmentsReceipt.CreatedTruncatedWebhook"}]},"WmsOrdersCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsOrderApiItemSchema"},"event_type":{"type":"string","enum":["order.created"],"description":"","example":"order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsOrdersCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsOrdersCreatedTruncatedData"},"event_type":{"type":"string","enum":["order.created"],"description":"","example":"order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsOrdersCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsOrdersCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsOrdersCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsOrdersCreatedTruncatedWebhook"}]},"WmsOrdersUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsOrderApiItemSchema"},"event_type":{"type":"string","enum":["order.updated"],"description":"","example":"order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsOrdersUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsOrdersUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the order.","example":"order_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"warehouse_id":{"type":["string","null"],"description":"If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id"},"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"},"reference_id":{"type":"string","description":"An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one.","example":"order_reference_id"},"order_number":{"type":"string","description":"A user-friendly identifier for their order. Defaults to `reference_id` if not provided.","example":"order_number"},"status":{"type":"string","enum":["open","confirmed","processing","picked","packed","partially_fulfilled","fulfilled","exception","cancelled","backordered","other"],"description":"The status of the order. See the [order information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"channel_object":{"anyOf":[{"$ref":"#/components/schemas/OrderChannel"},{"type":"null"}]},"type":{"type":["string","null"],"enum":["d2c","b2b","dropship","transfer"],"description":"The type of order, such as d2c, b2b, dropship, or transfer.","example":"d2c"},"trading_partner":{"type":["string","null"],"description":"For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).","example":"Target"},"service_level":{"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 used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level.","example":"fedex_ground"},"shipping_method_name":{"type":["string","null"],"description":"The name of the shipping method used to ship the order.","example":"FedEx Ground"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code for the carrier used to ship the order.","example":"scac"},"is_third_party_freight":{"type":["boolean","null"],"description":"True if the order was shipped using a third party freight account.","example":false},"third_party_freight_account_number":{"type":["string","null"],"description":"The third party freight account number used to ship the order.","example":"123456"},"first_party_freight_account_number":{"type":["string","null"],"description":"The first party freight account number used to ship the order.","example":"123456"},"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"},"line_items":{"type":"array","description":"List of the products included in the order.","example":[{"product_id":"product_id","sku":"sku","quantity":1,"unit_price":10.99,"discount_amount":1.5}],"items":{"$ref":"#/components/schemas/WmsOrderLineItem"}},"tags":{"type":"array","description":"A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the order.","example":"tag_0"}},"required_ship_date":{"type":["string","null"],"format":"date-time","description":"The date the order must be shipped by.","example":"2021-01-01T12:00:00Z"},"saturday_delivery":{"type":["boolean","null"],"description":"True if the order requires Saturday delivery.","example":false},"signature_required":{"type":["boolean","null"],"description":"True if the order requires a signature upon delivery.","example":false},"international_duty_paid_by":{"type":["string","null"],"enum":["sender","recipient","third_party"],"description":"The party responsible for paying international duties.","example":"sender"},"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","example":[{"shipment_id":"shipment_id","warehouse_id":"wh_id","shipped_date":"2022-05-06T01:02:03Z","raw_status":"raw_status","status":"shipped","line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"parent_product_id":null}],"ship_to_address":{"full_name":"John Doe","company":"company","address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"ship_from_address":{"address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"packages":[{"package_id":"package_id","package_name":"package_name","tracking_number":"tracking_number","tracking_url":"tracking_url","shipping_method_id":"shipping_method_id","shipping_method_name":"shipping_method_name","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"scac","bill_of_lading":"bill_of_lading","sscc":"sscc","pro_number":"pro_number","shipping_cost":1.0,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-06-06T01:02:03Z","parent_product_id":null}]}]}],"items":{"$ref":"#/components/schemas/OrderShipment"}},"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsOrdersUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsOrdersUpdatedTruncatedData"},"event_type":{"type":"string","enum":["order.updated"],"description":"","example":"order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsOrdersUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsOrdersUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsOrdersUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsOrdersUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsOrdersUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsOrdersUpdatedTruncatedWebhook"}]},"WmsOrdersShipment.CreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsOrderApiItemSchema"},"event_type":{"type":"string","enum":["order.shipment.created"],"description":"","example":"order.shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/shipment.createdPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"shipment.createdPreviousAttributes":{"type":"object","properties":{"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","example":[{"shipment_id":"shipment_id","warehouse_id":"wh_id","shipped_date":"2022-05-06T01:02:03Z","raw_status":"raw_status","status":"shipped","line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"parent_product_id":null}],"ship_to_address":{"full_name":"John Doe","company":"company","address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"ship_from_address":{"address1":"address1","address2":"address2","address3":"address3","city":"city","state":"state","postal_code":"postal_code","country":"country"},"packages":[{"package_id":"package_id","package_name":"package_name","tracking_number":"tracking_number","tracking_url":"tracking_url","shipping_method_id":"shipping_method_id","shipping_method_name":"shipping_method_name","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"scac","bill_of_lading":"bill_of_lading","sscc":"sscc","pro_number":"pro_number","shipping_cost":1.0,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-06-06T01:02:03Z","parent_product_id":null}]}]}],"items":{"$ref":"#/components/schemas/OrderShipment"}}},"required":["shipments"],"additionalProperties":false},"WmsOrdersShipment.CreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsOrdersShipment.CreatedTruncatedData"},"event_type":{"type":"string","enum":["order.shipment.created"],"description":"","example":"order.shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsOrdersShipment.CreatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsOrdersShipment.CreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsOrdersShipment.CreatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsOrdersShipment.CreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsOrdersShipment.CreatedFullWebhook"},{"$ref":"#/components/schemas/WmsOrdersShipment.CreatedTruncatedWebhook"}]},"WmsWarehousesCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseApiItemSchema"},"event_type":{"type":"string","enum":["warehouse.created"],"description":"","example":"warehouse.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsWarehousesCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehousesCreatedTruncatedData"},"event_type":{"type":"string","enum":["warehouse.created"],"description":"","example":"warehouse.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsWarehousesCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsWarehousesCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsWarehousesCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsWarehousesCreatedTruncatedWebhook"}]},"WmsWarehousesUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseApiItemSchema"},"event_type":{"type":"string","enum":["warehouse.updated"],"description":"","example":"warehouse.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsWarehousesUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsWarehousesUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse.","example":"warehouse_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsWarehousesUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehousesUpdatedTruncatedData"},"event_type":{"type":"string","enum":["warehouse.updated"],"description":"","example":"warehouse.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsWarehousesUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsWarehousesUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsWarehousesUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsWarehousesUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsWarehousesUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsWarehousesUpdatedTruncatedWebhook"}]},"WmsShippingMethodsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsShippingMethodApiItemSchema"},"event_type":{"type":"string","enum":["shipping-method.created"],"description":"","example":"shipping-method.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsShippingMethodsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsShippingMethodsCreatedTruncatedData"},"event_type":{"type":"string","enum":["shipping-method.created"],"description":"","example":"shipping-method.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsShippingMethodsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsShippingMethodsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsShippingMethodsCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsShippingMethodsCreatedTruncatedWebhook"}]},"WmsShippingMethodsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsShippingMethodApiItemSchema"},"event_type":{"type":"string","enum":["shipping-method.updated"],"description":"","example":"shipping-method.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsShippingMethodsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsShippingMethodsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the shipping method.","example":"shipping_method_id"},"created_date":{"type":"string","format":"date-time","description":"The date the shipping method was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the shipping method was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the shipping method.","example":"Priority Overnight"},"carrier_id":{"type":["string","null"],"description":"The ID of the carrier for the shipping method.","example":"fedex"},"carrier_name":{"type":["string","null"],"description":"The name of the carrier for the shipping method.","example":"FedEx"},"scac":{"type":["string","null"],"description":"The Standard Carrier Alpha Code (SCAC) for the shipping method.","example":"FDXG"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsShippingMethodsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsShippingMethodsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["shipping-method.updated"],"description":"","example":"shipping-method.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsShippingMethodsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsShippingMethodsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsShippingMethodsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsShippingMethodsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsShippingMethodsUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsShippingMethodsUpdatedTruncatedWebhook"}]},"WmsReturnsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsReturnApiItemSchema"},"event_type":{"type":"string","enum":["return.created"],"description":"","example":"return.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsReturnsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsReturnsCreatedTruncatedData"},"event_type":{"type":"string","enum":["return.created"],"description":"","example":"return.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsReturnsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsReturnsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsReturnsCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsReturnsCreatedTruncatedWebhook"}]},"WmsReturnsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsReturnApiItemSchema"},"event_type":{"type":"string","enum":["return.updated"],"description":"","example":"return.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsReturnsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsReturnsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the return.","example":"return_id"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the return was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the return was last updated.","example":"2022-01-02T05:05:05Z"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"open"},"raw_status":{"type":["string","null"],"description":"The raw status (if available) returned directly from the WMS.","example":"raw_status"},"order_id":{"type":["string","null"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id"},"notes":{"type":"array","description":"A list of notes associated with the return.","example":["This is a note"],"items":{"type":"string","description":"This is a note","example":"notes"}},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":1,"received_quantity":1,"restocked_quantity":1,"return_reason":"Too Small"}],"items":{"$ref":"#/components/schemas/WmsReturnLineItem"}},"shipments":{"type":"array","description":"List of the shipments associated with the return.","example":[{"tracking_number":"tracking_number","shipped_date":"2023-02-03T02:04:06Z","arrived_date":"2023-02-03T02:04:06Z","warehouse_id":"warehouse_id","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"FDXG","shipping_cost":1.23,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":4,"receiving_details":[{"quantity":1,"condition":"good","disposition":"restocked"},{"quantity":1,"condition":"damaged","disposition":"scrapped"}]}]}],"items":{"$ref":"#/components/schemas/ReturnShipment"}},"external_system_url":{"type":["string","null"],"description":"URL link to the return in the external system (WMS/Freight etc).","example":"https://example.com/return/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsReturnsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsReturnsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["return.updated"],"description":"","example":"return.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsReturnsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsReturnsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsReturnsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsReturnsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsReturnsUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsReturnsUpdatedTruncatedWebhook"}]},"WmsBillsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsBillApiItemSchema"},"event_type":{"type":"string","enum":["bill.created"],"description":"","example":"bill.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsBillsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsBillsCreatedTruncatedData"},"event_type":{"type":"string","enum":["bill.created"],"description":"","example":"bill.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsBillsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsBillsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsBillsCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsBillsCreatedTruncatedWebhook"}]},"WmsBillsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsBillApiItemSchema"},"event_type":{"type":"string","enum":["bill.updated"],"description":"","example":"bill.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsBillsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsBillsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the bill.","example":"bill_id_1"},"warehouse_customer_id":{"type":["string","null"],"description":"The ID of the merchant/tenant/customer that owns the bill. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the bill was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the bill was last updated.","example":"2022-01-02T05:05:05Z"},"object_id":{"type":["string","null"],"description":"The ID of the object that incurred a charge.","example":"object_id"},"object_type":{"type":["string","null"],"description":"The type of object that incurred a charge.","example":"order"},"charge_type":{"type":"string","description":"The reason for the charge.","example":"shipping"},"amount":{"type":"number","description":"The amount charged.","example":10.5},"currency_code":{"type":"string","description":"The currency of the charge. Defaults to USD.","example":"USD"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsBillsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsBillsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["bill.updated"],"description":"","example":"bill.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsBillsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsBillsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsBillsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsBillsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsBillsUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsBillsUpdatedTruncatedWebhook"}]},"WmsWarehouseCustomersCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseCustomerApiItemSchema"},"event_type":{"type":"string","enum":["warehouse-customer.created"],"description":"","example":"warehouse-customer.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsWarehouseCustomersCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseCustomersCreatedTruncatedData"},"event_type":{"type":"string","enum":["warehouse-customer.created"],"description":"","example":"warehouse-customer.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsWarehouseCustomersCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsWarehouseCustomersCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsWarehouseCustomersCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsWarehouseCustomersCreatedTruncatedWebhook"}]},"WmsWarehouseCustomersUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseCustomerApiItemSchema"},"event_type":{"type":"string","enum":["warehouse-customer.updated"],"description":"","example":"warehouse-customer.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsWarehouseCustomersUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsWarehouseCustomersUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse customer.","example":"warehouse_customer_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse customer was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse customer was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse customer.","example":"Customer Name"},"email":{"type":["string","null"],"description":"The email of the primary contact for the warehouse customer.","example":"customer@email.com"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsWarehouseCustomersUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseCustomersUpdatedTruncatedData"},"event_type":{"type":"string","enum":["warehouse-customer.updated"],"description":"","example":"warehouse-customer.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsWarehouseCustomersUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsWarehouseCustomersUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsWarehouseCustomersUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsWarehouseCustomersUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsWarehouseCustomersUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsWarehouseCustomersUpdatedTruncatedWebhook"}]},"WmsWarehouseLocationsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseLocationApiItemSchema"},"event_type":{"type":"string","enum":["warehouse-location.created"],"description":"","example":"warehouse-location.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsWarehouseLocationsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseLocationsCreatedTruncatedData"},"event_type":{"type":"string","enum":["warehouse-location.created"],"description":"","example":"warehouse-location.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsWarehouseLocationsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsWarehouseLocationsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsWarehouseLocationsCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsWarehouseLocationsCreatedTruncatedWebhook"}]},"WmsWarehouseLocationsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseLocationApiItemSchema"},"event_type":{"type":"string","enum":["warehouse-location.updated"],"description":"","example":"warehouse-location.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsWarehouseLocationsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsWarehouseLocationsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the location.","example":"location_id"},"created_date":{"type":"string","format":"date-time","description":"The date the location was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the location was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":["string","null"],"description":"The name of the location.","example":"Location Name"},"warehouse_id":{"type":"string","description":"The ID of the warehouse the location is in.","example":"warehouse_id"},"type":{"type":["string","null"],"description":"The location type","example":"pallet"},"measurements":{"$ref":"#/components/schemas/LocationMeasurements"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsWarehouseLocationsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsWarehouseLocationsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["warehouse-location.updated"],"description":"","example":"warehouse-location.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsWarehouseLocationsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsWarehouseLocationsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsWarehouseLocationsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsWarehouseLocationsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsWarehouseLocationsUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsWarehouseLocationsUpdatedTruncatedWebhook"}]},"WmsInventoryLedgerCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryLedgerApiItemSchema"},"event_type":{"type":"string","enum":["inventory_ledger.created"],"description":"","example":"inventory_ledger.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsInventoryLedgerCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryLedgerCreatedTruncatedData"},"event_type":{"type":"string","enum":["inventory_ledger.created"],"description":"","example":"inventory_ledger.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"WmsInventoryLedgerCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsInventoryLedgerCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsInventoryLedgerCreatedFullWebhook"},{"$ref":"#/components/schemas/WmsInventoryLedgerCreatedTruncatedWebhook"}]},"WmsInventoryLedgerUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryLedgerApiItemSchema"},"event_type":{"type":"string","enum":["inventory_ledger.updated"],"description":"","example":"inventory_ledger.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsInventoryLedgerUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsInventoryLedgerUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item.","example":"inv_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"entry_date":{"type":"string","format":"date-time","description":"The timestamp of the inventory ledger entry.","example":"2025-01-01T00:00:00Z"},"inventory_item_id":{"type":"string","description":"The unique ID of the inventory item.","example":"inventory_item_id"},"sku":{"type":"string","description":"The SKU of the inventory item.","example":"sku"},"quantity":{"type":"integer","description":"The quantity of the inventory item being added or removed.","example":1},"raw_event_type":{"type":["string","null"],"description":"The raw event that occurred resulting in the inventory ledger entry.","example":"receipt_into_system"},"event_type":{"type":"string","enum":["adjustment","return_receipt","inbound_receipt","order_shipment","supplier_return","movement","other"],"description":"The event that occurred resulting in the inventory ledger entry.","example":"inbound_receipt"},"reason":{"type":["string","null"],"description":"The reason for the inventory ledger entry.","example":"reason"},"object_id":{"type":["string","null"],"description":"The unique ID of the object that caused the inventory ledger entry.","example":"inbound_shipment_id"},"object_type":{"type":["string","null"],"enum":["order","inbound_shipment","return"],"description":"The type of object that caused the inventory ledger entry.","example":"inbound_shipment"},"warehouse_id":{"type":["string","null"],"description":"The unique ID of the source warehouse.","example":"source_warehouse_id"},"location_id":{"type":["string","null"],"description":"The unique ID of the source location.","example":"source_location_id"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"WmsInventoryLedgerUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/WmsInventoryLedgerUpdatedTruncatedData"},"event_type":{"type":"string","enum":["inventory_ledger.updated"],"description":"","example":"inventory_ledger.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/WmsInventoryLedgerUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"WmsInventoryLedgerUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"WmsInventoryLedgerUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"WmsInventoryLedgerUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/WmsInventoryLedgerUpdatedFullWebhook"},{"$ref":"#/components/schemas/WmsInventoryLedgerUpdatedTruncatedWebhook"}]},"FreightShipmentsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/FreightShipmentApiItemSchema"},"event_type":{"type":"string","enum":["freight-shipment.created"],"description":"","example":"freight-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"freight"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"FreightShipmentsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/FreightShipmentsCreatedTruncatedData"},"event_type":{"type":"string","enum":["freight-shipment.created"],"description":"","example":"freight-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"freight"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"FreightShipmentsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"FreightShipmentsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/FreightShipmentsCreatedFullWebhook"},{"$ref":"#/components/schemas/FreightShipmentsCreatedTruncatedWebhook"}]},"FreightShipmentsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/FreightShipmentApiItemSchema"},"event_type":{"type":"string","enum":["freight-shipment.updated"],"description":"","example":"freight-shipment.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"freight"},"previous_attributes":{"$ref":"#/components/schemas/FreightShipmentsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"FreightShipmentsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the shipment.","example":"shipment_id"},"eta_date":{"type":["string","null"],"format":"date-time","description":"The estimated arrival date of the shipment.","example":"2021-01-01T00:00:00Z"},"created_date":{"type":"string","format":"date-time","description":"The date the freight shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the freight shipment was last updated.","example":"2022-01-02T05:05:05Z"},"cost":{"type":["number","null"],"description":"The cost of the shipment.","example":1.0},"shipment_date":{"type":["string","null"],"format":"date-time","description":"The date the shipment was sent from its origin.","example":"2021-01-01T00:00:00Z"},"arrival_date":{"type":["string","null"],"format":"date-time","description":"The actual date the shipment arrived at its destination.","example":"2021-01-01T00:00:00Z"},"raw_status":{"type":["string","null"],"description":"The raw status of the shipment from the freight forwarder.","example":"status"},"status":{"type":"string","enum":["pre_transit","in_transit","arrival_port","en_route_to_destination","final_destination"],"description":"The status of the freight shipment. See the [freight shipment information](info) for more details.","example":"pre_transit"},"shipment_method":{"type":"string","description":"The mode by which the shipment was transported (e.g. air, ocean)","example":"shipment_method"},"external_system_url":{"type":["string","null"],"description":"URL link to the freight shipment in the external system (WMS/Freight etc).","example":"https://example.com/freightshipment/123"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"FreightShipmentsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/FreightShipmentsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["freight-shipment.updated"],"description":"","example":"freight-shipment.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"freight"},"previous_attributes":{"$ref":"#/components/schemas/FreightShipmentsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"FreightShipmentsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"FreightShipmentsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"FreightShipmentsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/FreightShipmentsUpdatedFullWebhook"},{"$ref":"#/components/schemas/FreightShipmentsUpdatedTruncatedWebhook"}]},"CartWarehousesCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartWarehouseApiItemSchema"},"event_type":{"type":"string","enum":["cart-warehouse.created"],"description":"","example":"cart-warehouse.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"CartWarehousesCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartWarehousesCreatedTruncatedData"},"event_type":{"type":"string","enum":["cart-warehouse.created"],"description":"","example":"cart-warehouse.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"CartWarehousesCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CartWarehousesCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CartWarehousesCreatedFullWebhook"},{"$ref":"#/components/schemas/CartWarehousesCreatedTruncatedWebhook"}]},"CartWarehousesUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartWarehouseApiItemSchema"},"event_type":{"type":"string","enum":["cart-warehouse.updated"],"description":"","example":"cart-warehouse.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/CartWarehousesUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CartWarehousesUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the warehouse.","example":"warehouse_id"},"created_date":{"type":"string","format":"date-time","description":"The date the warehouse was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the warehouse was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the warehouse.","example":"Bethlehem (PA)"},"code":{"type":["string","null"],"description":"The warehouse code.","example":"ABE-1"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"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":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"CartWarehousesUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartWarehousesUpdatedTruncatedData"},"event_type":{"type":"string","enum":["cart-warehouse.updated"],"description":"","example":"cart-warehouse.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/CartWarehousesUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CartWarehousesUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CartWarehousesUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"CartWarehousesUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CartWarehousesUpdatedFullWebhook"},{"$ref":"#/components/schemas/CartWarehousesUpdatedTruncatedWebhook"}]},"CartProductsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartProductApiItemSchema"},"event_type":{"type":"string","enum":["cart-product.created"],"description":"","example":"cart-product.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"CartProductsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartProductsCreatedTruncatedData"},"event_type":{"type":"string","enum":["cart-product.created"],"description":"","example":"cart-product.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"CartProductsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CartProductsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CartProductsCreatedFullWebhook"},{"$ref":"#/components/schemas/CartProductsCreatedTruncatedWebhook"}]},"CartProductsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartProductApiItemSchema"},"event_type":{"type":"string","enum":["cart-product.updated"],"description":"","example":"cart-product.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/CartProductsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CartProductsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the product.","example":"product_id"},"created_date":{"type":"string","format":"date-time","description":"The date the cart product was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the cart product was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the product.","example":"product_name"},"sku":{"type":["string","null"],"description":"The SKU of the product.","example":"sku"},"gtin":{"type":["string","null"],"description":"The GTIN of the product.","example":"gtin"},"parent_product_id":{"type":"string","description":"If this is a variant, the ID of the parent product. If this is a parent product, this field should be the same as ID.","example":"parent_product_id"},"is_kit":{"type":"boolean","description":"","example":true},"active":{"type":"boolean","description":"Whether the product is active.","example":true},"image_url":{"type":["string","null"],"description":"The URL of the product's image.","example":"https://example.com/image.jpg"},"price":{"type":["number","null"],"description":"The price of the product if it is a variant. Not the source of truth for parent products.","example":10.0},"unit_cost":{"type":["number","null"],"description":"The unit cost of the product if it is a variant. Not the source of truth for parent products.","example":10.0},"inventory":{"type":["integer","null"],"description":"The inventory of the product if it is a variant. Not the source of truth for parent products.","example":10},"inventory_by_warehouse_id":{"type":"object","description":"Inventory broken down by warehouse.","example":{"warehouse_id_1":6,"warehouse_id_2":4},"additionalProperties":{"type":"integer","description":"Inventory for that warehouse.","example":5}},"measurements":{"$ref":"#/components/schemas/ProductMeasurements"},"tags":{"type":"array","description":"A list of tags associated with the product. Tags that are represented as key-value pairs in the underlying system will be represented as a single string formatted as `key:value`.","example":["tag_0"],"items":{"type":"string","description":"A tag associated with the product.","example":"tag_0"}},"categories":{"type":"array","description":"A list of category names the product belongs to. For platforms with a hierarchical category tree, each level is a separate element with the leaf last (e.g. [\"Apparel\", \"Shoes\", \"Running\"]). For platforms with a single scalar product type, a single-element list.","example":["Apparel","Shoes","Running"],"items":{"type":"string","description":"A category name.","example":"Apparel"}},"external_system_url":{"type":["string","null"],"description":"URL link to the cart product in the external system (WMS/Freight etc).","example":"https://example.com/cartproduct/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"CartProductsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartProductsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["cart-product.updated"],"description":"","example":"cart-product.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/CartProductsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CartProductsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CartProductsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"CartProductsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CartProductsUpdatedFullWebhook"},{"$ref":"#/components/schemas/CartProductsUpdatedTruncatedWebhook"}]},"CartOrdersCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartOrderApiItemSchema"},"event_type":{"type":"string","enum":["cart-order.created"],"description":"","example":"cart-order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"CartOrdersCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartOrdersCreatedTruncatedData"},"event_type":{"type":"string","enum":["cart-order.created"],"description":"","example":"cart-order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"CartOrdersCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CartOrdersCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CartOrdersCreatedFullWebhook"},{"$ref":"#/components/schemas/CartOrdersCreatedTruncatedWebhook"}]},"CartOrdersUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartOrderApiItemSchema"},"event_type":{"type":"string","enum":["cart-order.updated"],"description":"","example":"cart-order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/CartOrdersUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CartOrdersUpdatedPreviousAttributes":{"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":"open"},"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":"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"}],"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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"CartOrdersUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartOrdersUpdatedTruncatedData"},"event_type":{"type":"string","enum":["cart-order.updated"],"description":"","example":"cart-order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/CartOrdersUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CartOrdersUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CartOrdersUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"CartOrdersUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CartOrdersUpdatedFullWebhook"},{"$ref":"#/components/schemas/CartOrdersUpdatedTruncatedWebhook"}]},"CartOrdersCart-Shipment.CreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartOrderApiItemSchema"},"event_type":{"type":"string","enum":["cart-order.cart-shipment.created"],"description":"","example":"cart-order.cart-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/cart-shipment.createdPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"cart-shipment.createdPreviousAttributes":{"type":"object","properties":{"shipments":{"type":"array","description":"List of the shipments sent out to the customer.","items":{"$ref":"#/components/schemas/CartOrderShipment"}}},"required":["shipments"],"additionalProperties":false},"CartOrdersCart-Shipment.CreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CartOrdersCart-Shipment.CreatedTruncatedData"},"event_type":{"type":"string","enum":["cart-order.cart-shipment.created"],"description":"","example":"cart-order.cart-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"cart"},"previous_attributes":{"$ref":"#/components/schemas/CartOrdersCart-Shipment.CreatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CartOrdersCart-Shipment.CreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CartOrdersCart-Shipment.CreatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"CartOrdersCart-Shipment.CreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CartOrdersCart-Shipment.CreatedFullWebhook"},{"$ref":"#/components/schemas/CartOrdersCart-Shipment.CreatedTruncatedWebhook"}]},"CarrierInvoiceLineItemsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CarrierInvoiceLineItemApiItemSchema"},"event_type":{"type":"string","enum":["carrier-invoice-line-item.created"],"description":"","example":"carrier-invoice-line-item.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"carrier"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"CarrierInvoiceLineItemsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsCreatedTruncatedData"},"event_type":{"type":"string","enum":["carrier-invoice-line-item.created"],"description":"","example":"carrier-invoice-line-item.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"carrier"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"CarrierInvoiceLineItemsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CarrierInvoiceLineItemsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CarrierInvoiceLineItemsCreatedFullWebhook"},{"$ref":"#/components/schemas/CarrierInvoiceLineItemsCreatedTruncatedWebhook"}]},"CarrierInvoiceLineItemsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CarrierInvoiceLineItemApiItemSchema"},"event_type":{"type":"string","enum":["carrier-invoice-line-item.updated"],"description":"","example":"carrier-invoice-line-item.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"carrier"},"previous_attributes":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CarrierInvoiceLineItemsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the invoice line item.","example":"invoice_line_item_id"},"created_date":{"type":"string","format":"date-time","description":"The date the invoice line item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the invoice line item was last updated.","example":"2022-01-02T05:05:05Z"},"transaction_date":{"type":"string","format":"date-time","description":"The transaction date of the invoice line item.","example":"2025-11-15T00:00:00Z"},"account_id":{"type":"string","description":"The account ID associated with the invoice line item.","example":"account_id"},"invoice_id":{"type":"string","description":"The invoice ID.","example":"invoice_id"},"tracking_number":{"type":["string","null"],"description":"The tracking number associated with the invoice line item.","example":"tracking_number"},"gross_cost":{"type":"number","description":"The gross cost of the invoice line item.","example":10.0},"net_cost":{"type":"number","description":"The net cost of the invoice line item.","example":8.0},"charge_description":{"type":"string","description":"Description of the charge.","example":"Freight Charge"},"raw":{"description":"The raw invoice line item data."},"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":{}},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"CarrierInvoiceLineItemsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["carrier-invoice-line-item.updated"],"description":"","example":"carrier-invoice-line-item.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"carrier"},"previous_attributes":{"$ref":"#/components/schemas/CarrierInvoiceLineItemsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"CarrierInvoiceLineItemsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CarrierInvoiceLineItemsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"CarrierInvoiceLineItemsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CarrierInvoiceLineItemsUpdatedFullWebhook"},{"$ref":"#/components/schemas/CarrierInvoiceLineItemsUpdatedTruncatedWebhook"}]},"CarrierFilesCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CarrierFileApiItemSchema"},"event_type":{"type":"string","enum":["carrier-file.created"],"description":"","example":"carrier-file.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"carrier"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"CarrierFileApiItemSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the file.","example":"2025-11-15T00:00:00/crawl_id/invoice.csv"},"created_date":{"type":"string","format":"date-time","description":"The date the file was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the file was last updated.","example":"2022-01-02T05:05:05Z"},"file_name":{"type":"string","description":"The file name.","example":"invoice.csv"},"file_type":{"type":["string","null"],"description":"The file extension.","example":"csv"},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["created_date","file_name","file_type","id","trackstar_created_date","trackstar_updated_date","updated_date"],"additionalProperties":false},"CarrierFilesCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/CarrierFilesCreatedTruncatedData"},"event_type":{"type":"string","enum":["carrier-file.created"],"description":"","example":"carrier-file.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"carrier"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"CarrierFilesCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"CarrierFilesCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/CarrierFilesCreatedFullWebhook"},{"$ref":"#/components/schemas/CarrierFilesCreatedTruncatedWebhook"}]},"ErpInventoryCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpInventoryItemApiItemSchema"},"event_type":{"type":"string","enum":["erp-inventory.created"],"description":"","example":"erp-inventory.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpInventoryCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpInventoryCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-inventory.created"],"description":"","example":"erp-inventory.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpInventoryCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpInventoryCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpInventoryCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpInventoryCreatedTruncatedWebhook"}]},"ErpInventoryUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpInventoryItemApiItemSchema"},"event_type":{"type":"string","enum":["erp-inventory.updated"],"description":"","example":"erp-inventory.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpInventoryUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpInventoryUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inventory item in the ERP.","example":"inv_id"},"created_date":{"type":"string","format":"date-time","description":"The date the inventory item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the inventory item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The display name of the inventory item.","example":"Apple - Fuji"},"sku":{"type":["string","null"],"description":"The SKU / item number of the inventory item.","example":"10000"},"upc":{"type":["string","null"],"description":"UPC / GTIN barcode for the item.","example":"012345678905"},"active":{"type":"boolean","description":"Whether the inventory item is active.","example":true},"description":{"type":["string","null"],"description":"A long-form description of the inventory item.","example":"Fuji apple, loose"},"unit_cost":{"type":["number","null"],"description":"Cost of a single unit of the inventory item, expressed in the ERP's base currency. The accounting meaning (e.g., standard, average, FIFO/LIFO) depends on `costing_method`.","example":1.0},"costing_method":{"type":["string","null"],"description":"How the ERP values this item for inventory accounting (e.g., Standard, Average, FIFO, LIFO).","example":"Standard"},"stock_unit":{"type":["string","null"],"description":"Unit of measure for on-hand quantities (e.g., EA, LB, CS).","example":"EA"},"onhand":{"type":["number","null"],"description":"Total physical on-hand quantity across all locations.","example":42.5},"committed":{"type":["number","null"],"description":"Total quantity committed / reserved against orders across all locations.","example":2.5},"available":{"type":["number","null"],"description":"Total quantity available to sell across all locations (typically onhand minus committed).","example":40.0},"inventory_by_location_id":{"type":"object","description":"Inventory broken down by location. A location can be a warehouse, retail store, production line, or consignment site depending on how the ERP is configured.","example":{"location_id_1":{"onhand":42.5,"committed":2.5,"available":40.0},"location_id_2":{"onhand":0.0,"committed":0.0,"available":0.0}},"additionalProperties":{"$ref":"#/components/schemas/ErpInventoryAtLocation"}},"vendors":{"type":"array","description":"Vendors from whom this item is purchased.","example":[{"vendor_id":"vendor_1","vendor_name":"Acme Produce Co."}],"items":{"$ref":"#/components/schemas/ErpItemVendor"}},"lots":{"type":"array","description":"A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.","example":[{"lot_id":"9821","lot_name":"LOT-20260418-A","onhand":240.0,"expiration_date":"2026-05-09T00:00:00Z","location_id":"114"}],"items":{"$ref":"#/components/schemas/ErpLot"}},"bins":{"type":"array","description":"Bins are physical storage slots within a location. For items also tracked by lot, each entry is a (lot, bin) pair \u2014 the same bin can appear across multiple entries (holding different lots) and the same lot can appear across multiple bins.","example":[{"bin_id":"157","bin_name":"C-03-L3-P2","onhand":240.0,"location_id":"114","lot_id":"9821"}],"items":{"$ref":"#/components/schemas/ErpBin"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the inventory item. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpInventoryItemCustomFieldEntry"}},"measurements":{"$ref":"#/components/schemas/InventoryItemMeasurementsErp"},"external_system_url":{"type":["string","null"],"description":"URL link to the inventory item in the external system (WMS/Freight etc).","example":"https://example.com/inventoryitem/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpInventoryUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpInventoryUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-inventory.updated"],"description":"","example":"erp-inventory.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpInventoryUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpInventoryUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpInventoryUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpInventoryUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpInventoryUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpInventoryUpdatedTruncatedWebhook"}]},"ErpSalesOrdersCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrderApiItemSchema"},"event_type":{"type":"string","enum":["erp-sales-order.created"],"description":"","example":"erp-sales-order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpSalesOrdersCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrdersCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-sales-order.created"],"description":"","example":"erp-sales-order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpSalesOrdersCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpSalesOrdersCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpSalesOrdersCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpSalesOrdersCreatedTruncatedWebhook"}]},"ErpSalesOrdersUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrderApiItemSchema"},"event_type":{"type":"string","enum":["erp-sales-order.updated"],"description":"","example":"erp-sales-order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpSalesOrdersUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpSalesOrdersUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the sales order in the ERP.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the sales order as assigned by the ERP.","example":"SO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the customer's PO number. Null if the ERP has no external reference.","example":"PO-9921"},"status":{"type":"string","enum":["pending_approval","open","partially_fulfilled","fulfilled","closed","cancelled","other"],"description":"The status of the sales order. See the [sales order information](info) for more details.","example":"pending_approval"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Fulfillment', 'Partially Fulfilled').","example":"Pending Fulfillment"},"order_date":{"type":"string","format":"date-time","description":"The date the order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_ship_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised ship date for the order.","example":"2024-05-03T00:00:00Z"},"customer_id":{"type":"string","description":"ID of the customer in the ERP.","example":"cust_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order ships from, when set at the order level.","example":"loc_1"},"subtotal":{"type":["number","null"],"description":"Sum of item line amounts before tax, shipping, and discount, in the order currency.","example":100.0},"total_tax":{"type":["number","null"],"description":"Total tax charged on the order, in the order currency.","example":8.5},"total_shipping":{"type":["number","null"],"description":"Total shipping charged on the order, in the order currency.","example":12.0},"total_discount":{"type":["number","null"],"description":"Total discount applied to the order, in the order currency.","example":5.0},"total_price":{"type":["number","null"],"description":"Grand total the customer will be billed for the order, in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_method_id":{"type":["string","null"],"description":"ID of the shipping method on the order.","example":"sm_1"},"shipping_method_name":{"type":["string","null"],"description":"Display name of the shipping method.","example":"UPS Ground"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Ship by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the sales order.","example":[{"line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0}],"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order in the external system (WMS/Freight etc).","example":"https://example.com/salesorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpSalesOrdersUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrdersUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-sales-order.updated"],"description":"","example":"erp-sales-order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpSalesOrdersUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpSalesOrdersUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpSalesOrdersUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpSalesOrdersUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpSalesOrdersUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpSalesOrdersUpdatedTruncatedWebhook"}]},"ErpSalesOrderShipmentsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrderShipmentApiItemSchema"},"event_type":{"type":"string","enum":["erp-sales-order-shipment.created"],"description":"","example":"erp-sales-order-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpSalesOrderShipmentsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-sales-order-shipment.created"],"description":"","example":"erp-sales-order-shipment.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpSalesOrderShipmentsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpSalesOrderShipmentsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpSalesOrderShipmentsCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpSalesOrderShipmentsCreatedTruncatedWebhook"}]},"ErpSalesOrderShipmentsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrderShipmentApiItemSchema"},"event_type":{"type":"string","enum":["erp-sales-order-shipment.updated"],"description":"","example":"erp-sales-order-shipment.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpSalesOrderShipmentsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the shipment transaction in the ERP.","example":"ship_1"},"sales_order_id":{"type":"string","description":"ID of the parent sales order this shipment fulfills.","example":"so_id"},"created_date":{"type":"string","format":"date-time","description":"The date the sales order shipment was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the sales order shipment was last updated.","example":"2022-01-02T05:05:05Z"},"shipment_number":{"type":["string","null"],"description":"The user-facing identifier of the shipment as assigned by the ERP.","example":"IF1001"},"shipped_date":{"type":"string","format":"date-time","description":"Date the shipment was sent.","example":"2024-05-04T00:00:00Z"},"location_id":{"type":["string","null"],"description":"ID of the location the shipment was sent from.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the shipment.","example":["First wave"],"items":{"type":"string","description":"Note","example":"notes"}},"packages":{"type":"array","description":"Per-parcel breakdown of the shipment. Mirrors the WMS shipment.packages shape \u2014 one entry per package shipped, carrying its own tracking number and measurements.","example":[{"package_id":"ship_1-1","tracking_number":"1Z999AA10123456784","measurements":{"length":12.0,"width":9.0,"height":4.0,"unit":"in","weight":2.5,"weight_unit":"lb"}}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentPackage"}},"line_items":{"type":"array","description":"Items included in this shipment. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit ship of one item drawn from two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"shipment_line_item_id":"shipment_line_item_id","line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"is_kit":false,"kit_components":[{"line_item_id":"1002","item_id":"610","sku":"10000","quantity":4.0,"lots":[{"lot_id":"78524","lot_name":"051326","bin_id":null,"bin_name":null,"quantity":4.0}]}],"lot_id":"lot_id","lot_name":"lot_name","expiration_date":"2023-03-15T13:45:30Z","bin_id":"bin_id","bin_name":"bin_name"}],"items":{"$ref":"#/components/schemas/ErpSalesOrderShipmentLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the sales order shipment. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpSalesOrderShipmentCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the sales order shipment in the external system (WMS/Freight etc).","example":"https://example.com/salesordershipment/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpSalesOrderShipmentsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-sales-order-shipment.updated"],"description":"","example":"erp-sales-order-shipment.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpSalesOrderShipmentsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpSalesOrderShipmentsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpSalesOrderShipmentsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpSalesOrderShipmentsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpSalesOrderShipmentsUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpSalesOrderShipmentsUpdatedTruncatedWebhook"}]},"ErpLocationsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpLocationApiItemSchema"},"event_type":{"type":"string","enum":["erp-location.created"],"description":"","example":"erp-location.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpLocationsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpLocationsCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-location.created"],"description":"","example":"erp-location.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpLocationsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpLocationsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpLocationsCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpLocationsCreatedTruncatedWebhook"}]},"ErpLocationsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpLocationApiItemSchema"},"event_type":{"type":"string","enum":["erp-location.updated"],"description":"","example":"erp-location.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpLocationsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpLocationsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the location in the ERP.","example":"loc_1"},"created_date":{"type":"string","format":"date-time","description":"The date the location was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the location was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The name of the location as shown in the ERP.","example":"Fresno DC"},"code":{"type":["string","null"],"description":"A short user-facing code for the location. Many ERPs do not distinguish a code from the name.","example":"FRE"},"active":{"type":["boolean","null"],"description":"Whether the location is active in the ERP.","example":true},"location_type":{"type":["string","null"],"description":"The ERP's classification for the location (e.g., Warehouse, Store, Office).","example":"Warehouse"},"full_path":{"type":["string","null"],"description":"The hierarchical path of the location (e.g., 'North America : West : Fresno DC'). Populated when the ERP nests locations under parents.","example":"North America : West : Fresno DC"},"parent_location_id":{"type":["string","null"],"description":"ID of the parent location in the ERP's location hierarchy.","example":"loc_parent_1"},"parent_location_name":{"type":["string","null"],"description":"Display name of the parent referenced by parent_location_id.","example":"West"},"address":{"$ref":"#/components/schemas/ShipFromAddress"},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the location. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpLocationCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the location in the external system (WMS/Freight etc).","example":"https://example.com/location/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpLocationsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpLocationsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-location.updated"],"description":"","example":"erp-location.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpLocationsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpLocationsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpLocationsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpLocationsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpLocationsUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpLocationsUpdatedTruncatedWebhook"}]},"ErpItemsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpItemApiItemSchema"},"event_type":{"type":"string","enum":["erp-item.created"],"description":"","example":"erp-item.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpItemsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpItemsCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-item.created"],"description":"","example":"erp-item.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpItemsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpItemsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpItemsCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpItemsCreatedTruncatedWebhook"}]},"ErpItemsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpItemApiItemSchema"},"event_type":{"type":"string","enum":["erp-item.updated"],"description":"","example":"erp-item.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpItemsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpItemsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the item in the ERP.","example":"item_id"},"created_date":{"type":"string","format":"date-time","description":"The date the item was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the item was last updated.","example":"2022-01-02T05:05:05Z"},"name":{"type":"string","description":"The display name of the item.","example":"Apple - Fuji"},"sku":{"type":["string","null"],"description":"The SKU / item number of the item.","example":"10000"},"description":{"type":["string","null"],"description":"A long-form description of the item.","example":"Fuji apple, loose"},"active":{"type":"boolean","description":"Whether the item is active.","example":true},"is_kit":{"type":"boolean","description":"Whether this item is a kit. A kit is not stocked itself; its components carry the inventory and ship in its place.","example":false},"kit_components":{"type":"array","description":"The items that make up this kit, and how many of each go into a single kit. Empty for items that are not kits.","example":[{"item_id":"610","sku":"10000","unit_quantity":2.0}],"items":{"$ref":"#/components/schemas/ErpKitComponent"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the item. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpItemCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the item in the external system (WMS/Freight etc).","example":"https://example.com/item/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpItemsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpItemsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-item.updated"],"description":"","example":"erp-item.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpItemsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpItemsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpItemsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpItemsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpItemsUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpItemsUpdatedTruncatedWebhook"}]},"ErpCustomersCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpCustomerApiItemSchema"},"event_type":{"type":"string","enum":["erp-customer.created"],"description":"","example":"erp-customer.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpCustomersCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpCustomersCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-customer.created"],"description":"","example":"erp-customer.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpCustomersCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpCustomersCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpCustomersCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpCustomersCreatedTruncatedWebhook"}]},"ErpCustomersUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpCustomerApiItemSchema"},"event_type":{"type":"string","enum":["erp-customer.updated"],"description":"","example":"erp-customer.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpCustomersUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpCustomersUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the customer in the ERP.","example":"cust_1"},"created_date":{"type":"string","format":"date-time","description":"The date the customer was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the customer was last updated.","example":"2022-01-02T05:05:05Z"},"customer_number":{"type":["string","null"],"description":"The user-facing identifier of the customer as assigned by the ERP.","example":"CUS0001"},"name":{"type":"string","description":"Display name of the customer (company name for businesses, full name for individuals).","example":"Acme Co."},"email":{"type":["string","null"],"description":"Primary email address recorded on the customer.","example":"buyer@example.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the customer.","example":"415-555-0142"},"is_individual":{"type":["boolean","null"],"description":"Whether the customer is a person (B2C) rather than a company (B2B).","example":false},"active":{"type":["boolean","null"],"description":"Whether the customer is active in the ERP.","example":true},"billing_address":{"$ref":"#/components/schemas/BillToAddress"},"shipping_address":{"$ref":"#/components/schemas/ShipToAddress"},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the customer. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpCustomerCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the customer in the external system (WMS/Freight etc).","example":"https://example.com/customer/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpCustomersUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpCustomersUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-customer.updated"],"description":"","example":"erp-customer.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpCustomersUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpCustomersUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpCustomersUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpCustomersUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpCustomersUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpCustomersUpdatedTruncatedWebhook"}]},"ErpVendorsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpVendorApiItemSchema"},"event_type":{"type":"string","enum":["erp-vendor.created"],"description":"","example":"erp-vendor.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpVendorsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpVendorsCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-vendor.created"],"description":"","example":"erp-vendor.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpVendorsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpVendorsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpVendorsCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpVendorsCreatedTruncatedWebhook"}]},"ErpVendorsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpVendorApiItemSchema"},"event_type":{"type":"string","enum":["erp-vendor.updated"],"description":"","example":"erp-vendor.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpVendorsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpVendorsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the vendor in the ERP.","example":"vend_1"},"created_date":{"type":"string","format":"date-time","description":"The date the vendor was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the vendor was last updated.","example":"2022-01-02T05:05:05Z"},"vendor_number":{"type":["string","null"],"description":"The user-facing identifier of the vendor as assigned by the ERP.","example":"V0001"},"name":{"type":"string","description":"Display name of the vendor (company name for businesses, full name for individuals).","example":"Acme Supply Co."},"email":{"type":["string","null"],"description":"Primary email address recorded on the vendor.","example":"ap@acme-supply.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the vendor.","example":"415-555-0193"},"is_individual":{"type":["boolean","null"],"description":"Whether the vendor is a person rather than a company.","example":false},"active":{"type":["boolean","null"],"description":"Whether the vendor is active in the ERP.","example":true},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the vendor. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpVendorCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the vendor in the external system (WMS/Freight etc).","example":"https://example.com/vendor/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpVendorsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpVendorsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-vendor.updated"],"description":"","example":"erp-vendor.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpVendorsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpVendorsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpVendorsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpVendorsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpVendorsUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpVendorsUpdatedTruncatedWebhook"}]},"ErpEmployeesCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpEmployeeApiItemSchema"},"event_type":{"type":"string","enum":["erp-employee.created"],"description":"","example":"erp-employee.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpEmployeesCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpEmployeesCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-employee.created"],"description":"","example":"erp-employee.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpEmployeesCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpEmployeesCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpEmployeesCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpEmployeesCreatedTruncatedWebhook"}]},"ErpEmployeesUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpEmployeeApiItemSchema"},"event_type":{"type":"string","enum":["erp-employee.updated"],"description":"","example":"erp-employee.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpEmployeesUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpEmployeesUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the employee in the ERP.","example":"emp_1"},"created_date":{"type":"string","format":"date-time","description":"The date the employee was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the employee was last updated.","example":"2022-01-02T05:05:05Z"},"employee_number":{"type":["string","null"],"description":"The user-facing identifier of the employee as assigned by the ERP.","example":"E0001"},"name":{"type":"string","description":"Display name of the employee (firstname + lastname, or entityid fallback).","example":"Jane Smith"},"first_name":{"type":["string","null"],"description":"Employee's first name.","example":"Jane"},"last_name":{"type":["string","null"],"description":"Employee's last name.","example":"Smith"},"email":{"type":["string","null"],"description":"Primary email address recorded on the employee.","example":"jane.smith@example.com"},"phone":{"type":["string","null"],"description":"Primary phone number recorded on the employee.","example":"415-555-0193"},"title":{"type":["string","null"],"description":"Job title of the employee.","example":"Warehouse Manager"},"active":{"type":["boolean","null"],"description":"Whether the employee is active in the ERP.","example":true},"supervisor_id":{"type":["string","null"],"description":"Internal ID of the employee's supervisor.","example":"42"},"approver_id":{"type":["string","null"],"description":"Internal ID of the employee's general approver.","example":"43"},"location_id":{"type":["string","null"],"description":"Internal ID of the employee's primary location.","example":"309"},"subsidiary_id":{"type":["string","null"],"description":"Internal ID of the employee's subsidiary.","example":"1"},"purchase_order_limit":{"type":["number","null"],"description":"Maximum purchase order amount this employee can author. Units vary by account configuration.","example":10.0},"purchase_order_approver_id":{"type":["string","null"],"description":"Internal ID of the employee who approves this employee's purchase orders.","example":"44"},"purchase_order_approval_limit":{"type":["number","null"],"description":"Maximum purchase order amount this employee can approve for others. Units vary by account configuration.","example":10.0},"expense_limit":{"type":["number","null"],"description":"Maximum expense report amount for this employee. Units vary by account configuration.","example":500.0},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the employee. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpEmployeeCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the employee in the external system (WMS/Freight etc).","example":"https://example.com/employee/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpEmployeesUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpEmployeesUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-employee.updated"],"description":"","example":"erp-employee.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpEmployeesUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpEmployeesUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpEmployeesUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpEmployeesUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpEmployeesUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpEmployeesUpdatedTruncatedWebhook"}]},"ErpPurchaseOrdersCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrderApiItemSchema"},"event_type":{"type":"string","enum":["erp-purchase-order.created"],"description":"","example":"erp-purchase-order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpPurchaseOrdersCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrdersCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-purchase-order.created"],"description":"","example":"erp-purchase-order.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpPurchaseOrdersCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpPurchaseOrdersCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpPurchaseOrdersCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpPurchaseOrdersCreatedTruncatedWebhook"}]},"ErpPurchaseOrdersUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrderApiItemSchema"},"event_type":{"type":"string","enum":["erp-purchase-order.updated"],"description":"","example":"erp-purchase-order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpPurchaseOrdersUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpPurchaseOrdersUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the purchase order in the ERP.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order was last updated.","example":"2022-01-02T05:05:05Z"},"order_number":{"type":"string","description":"The user-facing identifier of the purchase order as assigned by the ERP.","example":"PO1001"},"reference_id":{"type":["string","null"],"description":"An external reference on the order, such as the supplier's quote number. Null if the ERP has no external reference.","example":"QTE-7741"},"status":{"type":"string","enum":["pending_approval","pending_supplier","open","partially_received","received","closed","cancelled","other"],"description":"The status of the purchase order. See the [purchase order information](info) for more details.","example":"pending_approval"},"raw_status":{"type":["string","null"],"description":"The raw status label returned directly from the ERP (e.g., 'Pending Receipt', 'Partially Received').","example":"Pending Receipt"},"order_date":{"type":"string","format":"date-time","description":"The date the purchase order was placed or booked in the ERP.","example":"2024-05-01T00:00:00Z"},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"The expected or promised receipt date for the order.","example":"2024-05-10T00:00:00Z"},"vendor_id":{"type":"string","description":"ID of the vendor in the ERP.","example":"vend_1"},"employee_id":{"type":["string","null"],"description":"ID of the internal employee (requestor / buyer) on the order. Optional on writes; passed through to the ERP when provided. When omitted, the ERP's own enforcement applies \u2014 accounts that require an employee will reject the request.","example":"emp_1"},"location_id":{"type":["string","null"],"description":"ID of the ERP location the order will be received into, when set at the order level.","example":"loc_1"},"total_price":{"type":["number","null"],"description":"Grand total the supplier will be paid for the order (item subtotal plus tax and shipping minus discount), in the order currency.","example":115.5},"ship_to_address":{"$ref":"#/components/schemas/ShipToAddress"},"bill_to_address":{"$ref":"#/components/schemas/BillToAddress"},"notes":{"type":"array","description":"List of free-form notes recorded on the order.","example":["Need by Friday"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"List of line items on the purchase order.","example":[{"id":"id","item_id":"item_id","sku":"sku","quantity":0.0,"unit_price":0.0,"location_id":"location_id"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorder/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpPurchaseOrdersUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrdersUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-purchase-order.updated"],"description":"","example":"erp-purchase-order.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpPurchaseOrdersUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpPurchaseOrdersUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpPurchaseOrdersUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpPurchaseOrdersUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpPurchaseOrdersUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpPurchaseOrdersUpdatedTruncatedWebhook"}]},"ErpPurchaseOrderReceiptsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptApiItemSchema"},"event_type":{"type":"string","enum":["erp-purchase-order-receipt.created"],"description":"","example":"erp-purchase-order-receipt.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpPurchaseOrderReceiptsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsCreatedTruncatedData"},"event_type":{"type":"string","enum":["erp-purchase-order-receipt.created"],"description":"","example":"erp-purchase-order-receipt.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"ErpPurchaseOrderReceiptsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpPurchaseOrderReceiptsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsCreatedFullWebhook"},{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsCreatedTruncatedWebhook"}]},"ErpPurchaseOrderReceiptsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptApiItemSchema"},"event_type":{"type":"string","enum":["erp-purchase-order-receipt.updated"],"description":"","example":"erp-purchase-order-receipt.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpPurchaseOrderReceiptsUpdatedPreviousAttributes":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the receipt transaction in the ERP.","example":"rcpt_1"},"purchase_order_id":{"type":"string","description":"ID of the parent purchase order this receipt records against.","example":"po_id"},"created_date":{"type":"string","format":"date-time","description":"The date the purchase order receipt was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the purchase order receipt was last updated.","example":"2022-01-02T05:05:05Z"},"receipt_number":{"type":["string","null"],"description":"The user-facing identifier of the receipt as assigned by the ERP.","example":"RCPT1001"},"received_date":{"type":"string","format":"date-time","description":"Date the receipt was recorded in the ERP.","example":"2024-05-08T00:00:00Z"},"location_id":{"type":["string","null"],"description":"ID of the location the receipt was booked into.","example":"loc_1"},"notes":{"type":"array","description":"List of free-form notes recorded on the receipt.","example":["First partial"],"items":{"type":"string","description":"Note","example":"notes"}},"line_items":{"type":"array","description":"Items included in this receipt. Splits into one entry per (item, lot, bin) triple \u2014 a 100-unit receipt of one item booked into two lots (60 + 40) across two bins emits one entry per (lot, bin).","example":[{"receipt_line_item_id":"receipt_line_item_id","line_item_id":"line_item_id","item_id":"item_id","sku":"sku","quantity":0.0,"lot_id":"lot_id","lot_name":"lot_name","expiration_date":"2023-03-15T13:45:30Z","bin_id":"bin_id","bin_name":"bin_name"}],"items":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptLineItem"}},"custom_fields":{"type":"object","description":"Per-account custom fields defined on the purchase order receipt. Keys are the field names as defined in the ERP; each value carries the raw value, its declared type, and a human-readable label.","example":{"custom_field_example":{"value":"example_value","type":"string","title":"Example Field"}},"additionalProperties":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptCustomFieldEntry"}},"external_system_url":{"type":["string","null"],"description":"URL link to the purchase order receipt in the external system (WMS/Freight etc).","example":"https://example.com/purchaseorderreceipt/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":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"ErpPurchaseOrderReceiptsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["erp-purchase-order-receipt.updated"],"description":"","example":"erp-purchase-order-receipt.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"erp"},"previous_attributes":{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"ErpPurchaseOrderReceiptsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"ErpPurchaseOrderReceiptsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"ErpPurchaseOrderReceiptsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsUpdatedFullWebhook"},{"$ref":"#/components/schemas/ErpPurchaseOrderReceiptsUpdatedTruncatedWebhook"}]},"GeneralConnectionErrorsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/Connection_Error.PyConnectionErrorApiItemSchema"},"event_type":{"type":"string","enum":["connection-error.created"],"description":"","example":"connection-error.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"Connection_Error.PyConnectionErrorApiItemSchema":{"type":"object","properties":{"failed_url":{"type":"string","description":"The URL that failed.","example":"failed_url"},"affected_endpoints":{"type":"array","description":"A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.","example":[{"endpoint":"GET /wms/inventory","preventing_sync":true},{"endpoint":"GET /wms/orders","preventing_sync":false}],"items":{"$ref":"#/components/schemas/AffectedEndpoints"}},"integration_name":{"type":"string","description":"The name of the affected integration.","example":"integration_name"},"error_message":{"type":"string","description":"The error message.","example":"Missing integration_name permissions for URL: failed_url."},"created_date":{"type":"string","format":"date-time","description":"The date the connection error was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the connection error was last updated.","example":"2022-01-02T05:05:05Z"},"last_seen":{"type":"string","format":"date-time","description":"The last time this connection error was seen.","example":"2021-01-01T00:00:00Z"},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"required":["affected_endpoints","created_date","error_message","failed_url","integration_name","last_seen","trackstar_created_date","trackstar_updated_date","updated_date"],"additionalProperties":false},"GeneralConnectionErrorsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionErrorsCreatedTruncatedData"},"event_type":{"type":"string","enum":["connection-error.created"],"description":"","example":"connection-error.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionErrorsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionErrorsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionErrorsCreatedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionErrorsCreatedTruncatedWebhook"}]},"GeneralConnectionErrorsUpdatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/Connection_Error.PyConnectionErrorApiItemSchema"},"event_type":{"type":"string","enum":["connection-error.updated"],"description":"","example":"connection-error.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/GeneralConnectionErrorsUpdatedPreviousAttributes"}},"required":["connection_id","data","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"GeneralConnectionErrorsUpdatedPreviousAttributes":{"type":"object","properties":{"failed_url":{"type":"string","description":"The URL that failed.","example":"failed_url"},"affected_endpoints":{"type":"array","description":"A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.","example":[{"endpoint":"GET /wms/inventory","preventing_sync":true},{"endpoint":"GET /wms/orders","preventing_sync":false}],"items":{"$ref":"#/components/schemas/AffectedEndpoints"}},"integration_name":{"type":"string","description":"The name of the affected integration.","example":"integration_name"},"error_message":{"type":"string","description":"The error message.","example":"Missing integration_name permissions for URL: failed_url."},"created_date":{"type":"string","format":"date-time","description":"The date the connection error was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the connection error was last updated.","example":"2022-01-02T05:05:05Z"},"last_seen":{"type":"string","format":"date-time","description":"The last time this connection error was seen.","example":"2021-01-01T00:00:00Z"},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z"}},"additionalProperties":false},"GeneralConnectionErrorsUpdatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionErrorsUpdatedTruncatedData"},"event_type":{"type":"string","enum":["connection-error.updated"],"description":"","example":"connection-error.updated"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"previous_attributes":{"$ref":"#/components/schemas/GeneralConnectionErrorsUpdatedTruncatedPreviousAttributes"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type","previous_attributes"],"additionalProperties":false},"GeneralConnectionErrorsUpdatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionErrorsUpdatedTruncatedPreviousAttributes":{"type":"object","properties":{},"additionalProperties":false},"GeneralConnectionErrorsUpdatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionErrorsUpdatedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionErrorsUpdatedTruncatedWebhook"}]},"GeneralConnectionErrorsDeletedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ConnectionErrorSchema"},"event_type":{"type":"string","enum":["connection-error.deleted"],"description":"","example":"connection-error.deleted"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ConnectionErrorSchema":{"type":"object","properties":{"failed_url":{"type":"string","description":"The URL that failed.","example":"failed_url"},"affected_endpoints":{"type":"array","description":"A list of endpoints that were affected by the error and whether the error is preventing the sync from completing.","example":[{"endpoint":"GET /wms/inventory","preventing_sync":true},{"endpoint":"GET /wms/orders","preventing_sync":false}],"items":{"$ref":"#/components/schemas/AffectedEndpoints"}},"integration_name":{"type":"string","description":"The name of the affected integration.","example":"integration_name"},"error_message":{"type":"string","description":"The error message.","example":"Missing integration_name permissions for URL: failed_url."},"created_date":{"type":"string","format":"date-time","description":"The date the connection error was created.","example":"2022-01-01T00:00:00Z"},"updated_date":{"type":"string","format":"date-time","description":"The date the connection error was last updated.","example":"2022-01-02T05:05:05Z"},"last_seen":{"type":"string","format":"date-time","description":"The last time this connection error was seen.","example":"2021-01-01T00:00:00Z"}},"required":["affected_endpoints","created_date","error_message","failed_url","integration_name","last_seen","updated_date"],"additionalProperties":false},"GeneralConnectionErrorsDeletedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionErrorsDeletedTruncatedData"},"event_type":{"type":"string","enum":["connection-error.deleted"],"description":"","example":"connection-error.deleted"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionErrorsDeletedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionErrorsDeletedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionErrorsDeletedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionErrorsDeletedTruncatedWebhook"}]},"GeneralConnectionsCreatedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ConnectionCreatedSchema"},"event_type":{"type":"string","enum":["connection.created"],"description":"","example":"connection.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ConnectionCreatedSchema":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","description":"The date the connection was created.","example":"2022-01-01T00:00:00Z"},"access_token":{"type":"string","description":"","example":"trackstar_eyABC"}},"required":["access_token","created_date"],"additionalProperties":false},"GeneralConnectionsCreatedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionsCreatedTruncatedData"},"event_type":{"type":"string","enum":["connection.created"],"description":"","example":"connection.created"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionsCreatedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionsCreatedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionsCreatedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionsCreatedTruncatedWebhook"}]},"GeneralConnectionsDeletedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ConnectionDeletedSchema"},"event_type":{"type":"string","enum":["connection.deleted"],"description":"","example":"connection.deleted"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ConnectionDeletedSchema":{"type":"object","properties":{"deleted_date":{"type":"string","format":"date-time","description":"The date the connection was created.","example":"2022-01-01T00:00:00Z"}},"required":["deleted_date"],"additionalProperties":false},"GeneralConnectionsDeletedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionsDeletedTruncatedData"},"event_type":{"type":"string","enum":["connection.deleted"],"description":"","example":"connection.deleted"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionsDeletedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionsDeletedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionsDeletedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionsDeletedTruncatedWebhook"}]},"GeneralConnectionsHistorical-Sync-CompletedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/HistoricalSyncCompletedSchema"},"event_type":{"type":"string","enum":["connection.historical-sync-completed"],"description":"","example":"connection.historical-sync-completed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"HistoricalSyncCompletedSchema":{"type":"object","properties":{"oldest_data_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"newest_data_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"resource":{"type":"string","description":"","example":"orders"}},"required":["newest_data_date","oldest_data_date","resource"],"additionalProperties":false},"GeneralConnectionsHistorical-Sync-CompletedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionsHistorical-Sync-CompletedTruncatedData"},"event_type":{"type":"string","enum":["connection.historical-sync-completed"],"description":"","example":"connection.historical-sync-completed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionsHistorical-Sync-CompletedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionsHistorical-Sync-CompletedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionsHistorical-Sync-CompletedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionsHistorical-Sync-CompletedTruncatedWebhook"}]},"GeneralConnectionsSync-Job-CompletedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/SyncJobCompletedSchema"},"event_type":{"type":"string","enum":["connection.sync-job-completed"],"description":"","example":"connection.sync-job-completed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"SyncJobCompletedSchema":{"type":"object","properties":{"sync_job_id":{"type":"string","description":"","example":"sync_abc123"},"sync_start_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"sync_end_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"resource":{"type":"string","description":"","example":"orders"}},"required":["resource","sync_end_date","sync_job_id","sync_start_date"],"additionalProperties":false},"GeneralConnectionsSync-Job-CompletedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-CompletedTruncatedData"},"event_type":{"type":"string","enum":["connection.sync-job-completed"],"description":"","example":"connection.sync-job-completed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionsSync-Job-CompletedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionsSync-Job-CompletedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-CompletedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-CompletedTruncatedWebhook"}]},"GeneralConnectionsForce-Sync-CompletedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ForceSyncCompletedSchema"},"event_type":{"type":"string","enum":["connection.force-sync-completed"],"description":"","example":"connection.force-sync-completed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ForceSyncCompletedSchema":{"type":"object","properties":{"sync_start_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"sync_end_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"resource":{"type":"string","description":"","example":"orders"}},"required":["resource","sync_end_date","sync_start_date"],"additionalProperties":false},"GeneralConnectionsForce-Sync-CompletedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionsForce-Sync-CompletedTruncatedData"},"event_type":{"type":"string","enum":["connection.force-sync-completed"],"description":"","example":"connection.force-sync-completed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionsForce-Sync-CompletedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionsForce-Sync-CompletedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionsForce-Sync-CompletedFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionsForce-Sync-CompletedTruncatedWebhook"}]},"GeneralConnectionsSync-Job-StuckFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/SyncStuckSchema"},"event_type":{"type":"string","enum":["connection.sync-job-stuck"],"description":"","example":"connection.sync-job-stuck"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"SyncStuckSchema":{"type":"object","properties":{"stuck_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"requested_start_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"requested_end_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"resource":{"type":"string","description":"","example":"orders"}},"required":["requested_end_date","requested_start_date","resource","stuck_date"],"additionalProperties":false},"GeneralConnectionsSync-Job-StuckTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-StuckTruncatedData"},"event_type":{"type":"string","enum":["connection.sync-job-stuck"],"description":"","example":"connection.sync-job-stuck"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionsSync-Job-StuckTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionsSync-Job-StuckWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-StuckFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionsSync-Job-StuckTruncatedWebhook"}]},"GeneralConnectionsSchedule-StuckFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/ScheduleStuckSchema"},"event_type":{"type":"string","enum":["connection.schedule-stuck"],"description":"","example":"connection.schedule-stuck"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"ScheduleStuckSchema":{"type":"object","properties":{"stuck_date":{"type":"string","format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"latest_data":{"type":["string","null"],"format":"date-time","description":"","example":"2021-01-01T00:00:00Z"},"resource":{"type":"string","description":"","example":"orders"}},"required":["latest_data","resource","stuck_date"],"additionalProperties":false},"GeneralConnectionsSchedule-StuckTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralConnectionsSchedule-StuckTruncatedData"},"event_type":{"type":"string","enum":["connection.schedule-stuck"],"description":"","example":"connection.schedule-stuck"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralConnectionsSchedule-StuckTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralConnectionsSchedule-StuckWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralConnectionsSchedule-StuckFullWebhook"},{"$ref":"#/components/schemas/GeneralConnectionsSchedule-StuckTruncatedWebhook"}]},"GeneralFailedInstallsFailedFullWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/FailedInstallSchema"},"event_type":{"type":"string","enum":["install.failed"],"description":"","example":"install.failed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"}},"required":["connection_id","data","event_type","integration_name","integration_type"],"additionalProperties":false},"FailedInstallSchema":{"type":"object","properties":{"id":{"type":"string","description":"The unique id of the failed install attempt.","example":"id"},"integration_name":{"type":"string","description":"The integration the customer tried to connect.","example":"integration_name"},"integration_type":{"type":"string","description":"The integration type (wms, cart, carrier, etc.).","example":"wms"},"customer_id":{"type":["string","null"],"description":"Your identifier for the end customer who attempted the connection.","example":"customer_id"},"link_token":{"type":"string","description":"The link token the install attempt was made with.","example":"link_token"},"error_message":{"type":"string","description":"Why the install failed.","example":"Invalid credentials."},"created_at":{"type":"string","format":"date-time","description":"When the install attempt failed.","example":"2021-01-01T00:00:00Z"}},"required":["created_at","customer_id","error_message","id","integration_name","integration_type","link_token"],"additionalProperties":false},"GeneralFailedInstallsFailedTruncatedWebhook":{"type":"object","properties":{"connection_id":{"type":"string","description":"","example":"connection_id"},"data":{"$ref":"#/components/schemas/GeneralFailedInstallsFailedTruncatedData"},"event_type":{"type":"string","enum":["install.failed"],"description":"","example":"install.failed"},"integration_name":{"type":"string","description":"","example":"integration_name"},"integration_type":{"type":"string","description":"","example":"wms"},"data_truncated":{"type":"boolean","description":"Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.","example":true},"data_url":{"type":"string","description":"Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.","example":"https://production.trackstarhq.com/webhooks/payloads/payload_id"}},"required":["connection_id","data","data_truncated","data_url","event_type","integration_name","integration_type"],"additionalProperties":false},"GeneralFailedInstallsFailedTruncatedData":{"type":"object","properties":{"id":{"type":"string","description":"The record this event is about. Absent on connection webhooks, which carry dates rather than a row.","example":"id"}},"additionalProperties":false},"GeneralFailedInstallsFailedWebhookSchema":{"oneOf":[{"$ref":"#/components/schemas/GeneralFailedInstallsFailedFullWebhook"},{"$ref":"#/components/schemas/GeneralFailedInstallsFailedTruncatedWebhook"}]}}}}