> For the complete documentation index, see [llms.txt](https://docs.xorosoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xorosoft.com/developers-api/fulfillment-and-wave-management/ship-sales-order.md). # Ship Sales Order This API is used to ship the order and generate invoice. | Field | Data Type | Default Value | Description | | ----------------------- | ----------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `OrderNumber` | string | NA | Sales order number. Only this order's lines will be closed on the Wave. | | `Freight` | decimal | 0 | This will update Freight amount, excluding tax, within the invoice (Custom markup can be applied to freight amount through configuration in Xorosoft ERP). | | `CarrierCost` | decimal | 0 | This will update carrier cost value on the Invoice. | | `TrackingNumber` | string | NA | This will attach the carrier's tracking number(s) for the shipped order. You can also include a TrackingNumber at the carton level. | | `FreightIdentifierCode` | number | 0 | This will decide if the freight provided in the API request will be charged to the Invoice or to be used from the Sales Order. Available Codes - 0: Use Global, 1: Use Freight From Sales Order, 2: Use API Provided Freight. | | `IsMarkupExempt` | boolean | false | This will enable/disable the markup up % provided the system app configuration. | | `CarrierCode` | string | NA | The carrier for this order. | | `ShipServiceCode` | string | NA | Identifies the shipping service to be used for this label. | | `ShippingCostCharged` | decimal | 0 | Freight cost per carton. | | `InvoiceDate` | date | NA | This will set the Invoice date (GL date) of the order shipped. | | `ShipDate` | date | NA | This will set the ship date of the order shipped. | | `ForceOverrideShipping` | boolean | false | This will decide if the override Shipping checkbox will be enabled or not for this shipment. | | `Cartons` | carton list | NA | This will accept the carton level details for the shipment (optional) Refer to request preview for carton model. | | `ShipAll` | boolean | false | This will mark all the wave lines for the order as shipped (closed or not) with the current quantity picked. Please note, any line with zero qty picked will be shipped as 0. | | `CustomFieldH1` | string | NA | Sets the value of custom field 1 on the Invoice. | | `CustomFieldH2` | string | NA | Sets the value of custom field 2 on the Invoice. | | `CustomFieldH3` | string | NA | Sets the value of custom field 3 on the Invoice. | | `CustomFieldH4` | string | NA | Sets the value of custom field 4 on the Invoice. | | `CustomFieldH5` | string | NA | Sets the value of custom field 5 on the Invoice. | ```json {"openapi":"3.0.3","info":{"title":"Xorosoft ERP Public API","version":"2026.07"},"tags":[{"name":"Fulfillment and Wave Management","description":"Use Fulfillment and Wave Management APIs to retrieve waves, create waves, fulfill waves, ship waves, confirm shipments, manage carriers and shipping terms, and support warehouse execution workflows. These APIs are designed for WMS, shipping, 3PL, and fulfillment integrations that need to move orders from allocation through picking, packing, shipping, and confirmation."}],"servers":[{"url":"https://res.xorosoft.io","description":"Xorosoft ERP API server"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"scheme":"basic","type":"http"}}},"paths":{"/api/xerp/wave/ship":{"post":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Data":{"properties":{"DepositInfo":{"items":{"properties":{"AmountApplied":{"type":"number"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string"},"CustomerId":{"type":"number"},"CustomerName":{"type":"string"},"DepositId":{"type":"number"},"DepositNumber":{"type":"string"},"Id":{"type":"number"},"InvoiceId":{"type":"number"},"InvoiceNumber":{"type":"string"},"Memo":{"type":"string"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"RefNo":{"type":"string"},"StatusId":{"type":"number"},"StoreId":{"type":"number"},"StoreName":{"type":"string"},"TxnDate":{"type":"string"},"TxnId":{"type":"string"},"TxnNumber":{"type":"number"}},"type":"object"},"type":"array"},"InvoiceNumber":{"type":"string"},"InvoiceObj":{"properties":{"ImportError":{"type":"string","nullable":true},"IsBeingAutoCreated":{"type":"boolean"},"SimulatationFlag":{"type":"boolean"},"invoiceHeader":{"properties":{"AccntReceivableId":{"type":"string"},"AccntReceivableName":{"type":"string","nullable":true},"AmountDue":{"type":"number"},"AmountPaid":{"type":"number"},"AmountToPay":{"type":"number"},"AuthorizationDetailList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"AutoCreateCarrierFlag":{"type":"boolean"},"BatchUploadFlag":{"type":"boolean"},"BillToAddr":{"type":"string"},"BillToAddr2":{"type":"string"},"BillToAddrName":{"type":"string"},"BillToCity":{"type":"string"},"BillToCompanyName":{"type":"string"},"BillToCountry":{"type":"string"},"BillToEmail":{"type":"string"},"BillToFirstName":{"type":"string"},"BillToLastName":{"type":"string"},"BillToName":{"type":"string"},"BillToPhoneNumber":{"type":"string"},"BillToState":{"type":"string"},"BillToZpCode":{"type":"string"},"BrandId":{"type":"number","nullable":true},"BrandName":{"type":"string","nullable":true},"BuyerId":{"type":"number","nullable":true},"BuyerName":{"type":"string","nullable":true},"CarrierId":{"type":"number"},"CarrierName":{"type":"string","nullable":true},"CounterNumber":{"type":"string"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string"},"CreditApplied":{"type":"number"},"CurrencyCode":{"type":"string","nullable":true},"CurrencyId":{"type":"number"},"CurrencyName":{"type":"string"},"CurrencySymbol":{"type":"string","nullable":true},"CustomFieldH1":{"type":"string"},"CustomFieldH10":{"type":"string"},"CustomFieldH11":{"type":"string"},"CustomFieldH12":{"type":"string"},"CustomFieldH13":{"type":"string"},"CustomFieldH14":{"type":"string"},"CustomFieldH15":{"type":"string"},"CustomFieldH16":{"type":"string"},"CustomFieldH17":{"type":"string"},"CustomFieldH18":{"type":"string"},"CustomFieldH19":{"type":"string"},"CustomFieldH2":{"type":"string"},"CustomFieldH20":{"type":"string"},"CustomFieldH21":{"type":"string"},"CustomFieldH22":{"type":"string"},"CustomFieldH23":{"type":"string"},"CustomFieldH24":{"type":"string"},"CustomFieldH25":{"type":"string"},"CustomFieldH26":{"type":"string"},"CustomFieldH27":{"type":"string"},"CustomFieldH28":{"type":"string"},"CustomFieldH29":{"type":"string"},"CustomFieldH3":{"type":"string"},"CustomFieldH30":{"type":"string"},"CustomFieldH4":{"type":"string"},"CustomFieldH5":{"type":"string"},"CustomFieldH6":{"type":"string"},"CustomFieldH7":{"type":"string"},"CustomFieldH8":{"type":"string"},"CustomFieldH9":{"type":"string"},"CustomerDefaultBillingEmail":{"type":"string","nullable":true},"CustomerDefaultShipmentEmail":{"type":"string","nullable":true},"CustomerEmailCC":{"type":"string","nullable":true},"CustomerEmailMain":{"type":"string","nullable":true},"CustomerFirstName":{"type":"string","nullable":true},"CustomerFullName":{"type":"string","nullable":true},"CustomerGroupId":{"type":"number","nullable":true},"CustomerId":{"type":"number"},"CustomerLastName":{"type":"string","nullable":true},"CustomerMainPhone":{"type":"string","nullable":true},"CustomerMessage":{"type":"string"},"CustomerName":{"type":"string"},"CustomerPO":{"type":"string"},"CustomerServiceRepFullName":{"type":"string","nullable":true},"CustomerServiceRepId":{"type":"string"},"CustomerTaxCodeId":{"type":"number"},"DepositApplied":{"type":"number"},"DiscountAccntId":{"type":"number","nullable":true},"DiscountAccntName":{"type":"string","nullable":true},"DiscountAmount":{"type":"number"},"DiscountApplied":{"type":"number"},"DiscountDate":{"type":"string","nullable":true},"DiscountToUse":{"type":"number"},"DiscountableAmount":{"type":"number"},"DueDate":{"type":"string"},"EmailedFlag":{"type":"boolean"},"ErrorOnTaxMismatch":{"type":"boolean"},"ExchangeRate":{"type":"number"},"ExchangeRateFormula":{"type":"string","nullable":true},"FobId":{"type":"number"},"FobName":{"type":"string","nullable":true},"FullPaymentDate":{"type":"string","nullable":true},"Id":{"type":"number"},"ImportError":{"type":"string","nullable":true},"IntAccntId":{"type":"number","nullable":true},"InvoiceNumber":{"type":"string"},"ItemIncomeAccountId":{"type":"number","nullable":true},"ItemIncomeAccountName":{"type":"string","nullable":true},"LastEmailDttm":{"type":"string","nullable":true},"LastOverdueEmailDttm":{"type":"string","nullable":true},"MatchedFlag":{"type":"boolean"},"MaxDiscountAllowed":{"type":"number"},"Memo":{"type":"string"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"NoTaxCompareFlag":{"type":"boolean"},"OldTxnDate":{"type":"string"},"OpeningBalanceFlag":{"type":"boolean"},"PaymentTermsId":{"type":"number"},"PaymentTermsName":{"type":"string","nullable":true},"ProjectClassId":{"type":"number"},"ProjectClassName":{"type":"string","nullable":true},"ReCalcShippingTaxesFlag":{"type":"boolean"},"ReCalcTaxesFlag":{"type":"boolean"},"RefId":{"type":"number","nullable":true},"RefNo":{"type":"string"},"ReportDataObj":{"properties":{"EntityAccntId":{"type":"string"},"EntityName":{"type":"string"},"ReportEntityId":{"type":"number"},"TxnRefId":{"type":"number"},"TxnRefNumber":{"type":"string"},"TxnTypeId":{"type":"number"}},"type":"object"},"ReportingDataText":{"type":"string","nullable":true},"RiskAnalysis":{"type":"string","nullable":true},"SaleStoreCode":{"type":"string","nullable":true},"SaleStoreId":{"type":"number"},"SaleStoreName":{"type":"string"},"SalesRepEmail":{"type":"string","nullable":true},"SalesRepFullName":{"type":"string","nullable":true},"SalesRepId":{"type":"string"},"ShipDate":{"type":"string"},"ShipMethodId":{"type":"number"},"ShipMethodName":{"type":"string","nullable":true},"ShipServiceId":{"type":"number"},"ShipServiceName":{"type":"string","nullable":true},"ShipToAddr":{"type":"string"},"ShipToAddr2":{"type":"string"},"ShipToAddrName":{"type":"string"},"ShipToCity":{"type":"string"},"ShipToCompanyName":{"type":"string"},"ShipToCountry":{"type":"string"},"ShipToEmail":{"type":"string"},"ShipToFirstName":{"type":"string"},"ShipToLastName":{"type":"string"},"ShipToName":{"type":"string"},"ShipToPhoneNumber":{"type":"string"},"ShipToState":{"type":"string"},"ShipToZpCode":{"type":"string"},"ShipmentId":{"type":"number","nullable":true},"ShippingAmount":{"type":"number"},"ShippingCost":{"type":"number"},"ShippingCostCarrier":{"type":"number"},"ShippingCostCredited":{"type":"string","nullable":true},"ShippingNotes":{"type":"string"},"ShippingTaxCodeId":{"type":"number"},"ShippingTaxCodeName":{"type":"string","nullable":true},"ShippingTaxData":{"properties":{"taxItems":{"items":{"properties":{"itemAmount":{"type":"number"},"itemId":{"type":"number"},"itemName":{"type":"string"},"itemRatePerc":{"type":"number"},"lineAmount":{"type":"number"}},"type":"object"},"type":"array"},"totalAmount":{"type":"number"}},"type":"object"},"ShippingTaxDataSerialized":{"type":"string","nullable":true},"ShippingTaxItems":{"type":"string","nullable":true},"ShippingTermsId":{"type":"number"},"ShippingTermsName":{"type":"string","nullable":true},"ShippingTypeId":{"type":"number"},"ShippingTypeName":{"type":"string","nullable":true},"SoId":{"type":"number"},"SoNumber":{"type":"string"},"SoSubTypeId":{"type":"number","nullable":true},"SoToInvoice":{"type":"boolean"},"StatusId":{"type":"number"},"StatusName":{"type":"string","nullable":true},"StoreCode":{"type":"string","nullable":true},"StoreId":{"type":"number"},"StoreName":{"type":"string"},"SubTotal":{"type":"number"},"SubTotalExclDiscount":{"type":"number"},"SysLockFlag":{"type":"boolean"},"Tags":{"type":"string"},"TaxCalcByAddress":{"type":"boolean"},"TaxCalcType":{"type":"string","nullable":true},"TaxOperationCountryCode":{"type":"string","nullable":true},"TaxSummaryDataText":{"type":"string"},"ThirdPartyDefaultSKU":{"type":"string","nullable":true},"ThirdPartyDisplayName":{"type":"string"},"ThirdPartyIconUrl":{"type":"string"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartySource":{"type":"string"},"ThirdPartyTotalAmount":{"type":"number","nullable":true},"ThirdPartyTotalTaxAmount":{"type":"number","nullable":true},"TotalAmount":{"type":"number"},"TotalPaidAmount":{"type":"number"},"TotalQty":{"type":"number"},"TotalTaxAmount":{"type":"number"},"TrackingNumbers":{"type":"string"},"TxnDate":{"type":"string"},"TxnId":{"type":"string"},"TxnNumber":{"type":"number"},"TxnTypeId":{"type":"number","nullable":true},"TypeId":{"type":"number"},"UnPostTranFlag":{"type":"boolean"},"UseDefaultSKUWhenError":{"type":"boolean"},"WaveNumbers":{"type":"string","nullable":true},"searchField":{"type":"string","nullable":true}},"type":"object"},"invoiceItemLineArr":{"items":{"properties":{"AuthorizationDetailList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"BaseUomId":{"type":"number"},"BaseUomName":{"type":"string","nullable":true},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string","nullable":true},"CreditQty":{"type":"number","nullable":true},"CustomFieldD1":{"type":"string"},"CustomFieldD10":{"type":"string"},"CustomFieldD11":{"type":"string"},"CustomFieldD12":{"type":"string"},"CustomFieldD13":{"type":"string"},"CustomFieldD14":{"type":"string"},"CustomFieldD15":{"type":"string"},"CustomFieldD16":{"type":"string"},"CustomFieldD17":{"type":"string"},"CustomFieldD18":{"type":"string"},"CustomFieldD19":{"type":"string"},"CustomFieldD2":{"type":"string"},"CustomFieldD20":{"type":"string"},"CustomFieldD21":{"type":"string"},"CustomFieldD22":{"type":"string"},"CustomFieldD23":{"type":"string"},"CustomFieldD24":{"type":"string"},"CustomFieldD25":{"type":"string"},"CustomFieldD26":{"type":"string"},"CustomFieldD27":{"type":"string"},"CustomFieldD28":{"type":"string"},"CustomFieldD29":{"type":"string"},"CustomFieldD3":{"type":"string"},"CustomFieldD30":{"type":"string"},"CustomFieldD4":{"type":"string"},"CustomFieldD5":{"type":"string"},"CustomFieldD6":{"type":"string"},"CustomFieldD7":{"type":"string"},"CustomFieldD8":{"type":"string"},"CustomFieldD9":{"type":"string"},"DeleteFlag":{"type":"boolean"},"Description":{"type":"string"},"Discount":{"type":"number"},"DiscountTypeId":{"type":"number"},"DiscountTypeName":{"type":"string","nullable":true},"EditState":{"type":"boolean"},"EffectiveUnitPrice":{"type":"number"},"ExternalItemNumber":{"type":"string"},"ForceSalesTaxCode":{"type":"boolean"},"HasRestriction":{"type":"boolean","nullable":true},"Id":{"type":"number"},"InventoryLocChangeList":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"InvoiceId":{"type":"number"},"IsTaxableFlag":{"type":"boolean"},"IsoCode2":{"type":"string"},"IsoCountryName":{"type":"string"},"ItemId":{"type":"number"},"ItemNumber":{"type":"string"},"ItemTypeId":{"type":"number"},"ItemTypeName":{"type":"string"},"LineNumber":{"type":"number"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"OldQty":{"type":"number","nullable":true},"ProjectClassId":{"type":"number","nullable":true},"ProjectClassName":{"type":"string","nullable":true},"Qty":{"type":"number"},"QtyDecimalFlag":{"type":"boolean"},"RefId":{"type":"number","nullable":true},"RestrictionOverrideFlag":{"type":"boolean","nullable":true},"RestrictionOverridePrice":{"type":"number","nullable":true},"RestrictionOverrideUser":{"type":"string","nullable":true},"SellUomId":{"type":"number"},"SellUomName":{"type":"string"},"SoId":{"type":"number"},"SoLineId":{"type":"number"},"SoNumber":{"type":"string"},"StatusId":{"type":"number","nullable":true},"TaxAmount":{"type":"number"},"TaxCodeId":{"type":"number"},"TaxCodeName":{"type":"string"},"TaxData":{"properties":{"taxItems":{"items":{"properties":{"itemAmount":{"type":"number"},"itemId":{"type":"number"},"itemName":{"type":"string"},"itemRatePerc":{"type":"number"},"lineAmount":{"type":"number"}},"type":"object"},"type":"array"},"totalAmount":{"type":"number"}},"type":"object"},"TaxItems":{"type":"string","nullable":true},"ThirdPartyRefNo":{"type":"string","nullable":true},"ThirdPartySource":{"type":"string","nullable":true},"TotalAmount":{"type":"number"},"TxnId":{"type":"string"},"TxnNumber":{"type":"number"},"TxnTypeId":{"type":"number","nullable":true},"UnitPrice":{"type":"number"},"UomFactor":{"type":"number"},"VASItemCost":{"type":"number","nullable":true},"VASItemId":{"type":"number","nullable":true},"VASItemName":{"type":"string","nullable":true}},"type":"object"},"type":"array"},"shipCartonArr":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true}},"type":"object"},"InvoiceSoRef":{"type":"string"},"_soId":{"type":"number"},"packingSlipObj":{"properties":{"PackingSlipHeader":{"properties":{"AccntReceivableId":{"type":"string"},"AmountDue":{"type":"string","nullable":true},"AmountPaid":{"type":"number","nullable":true},"AutoCreateCarrierFlag":{"type":"boolean"},"BillToAddr":{"type":"string"},"BillToAddr2":{"type":"string"},"BillToCity":{"type":"string"},"BillToCompanyName":{"type":"string"},"BillToCountry":{"type":"string"},"BillToEmail":{"type":"string"},"BillToFirstName":{"type":"string"},"BillToLastName":{"type":"string"},"BillToName":{"type":"string"},"BillToPhoneNumber":{"type":"string"},"BillToState":{"type":"string"},"BillToZipPostalCode":{"type":"string"},"BrandId":{"type":"number","nullable":true},"CarrierId":{"type":"number"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string"},"CreditApplied":{"type":"string","nullable":true},"CurrencyId":{"type":"number"},"CustomerId":{"type":"number"},"CustomerMessage":{"type":"string"},"CustomerPo":{"type":"string"},"CustomerServiceRepId":{"type":"string"},"CustomerTaxCodeId":{"type":"number"},"DepositApplied":{"type":"string","nullable":true},"DiscountApplied":{"type":"string","nullable":true},"DiscountDate":{"type":"string","nullable":true},"DiscountableTotal":{"type":"number","nullable":true},"DueDate":{"type":"string"},"ExchangeRate":{"type":"number"},"FobPointId":{"type":"number"},"Id":{"type":"number"},"InvoiceId":{"type":"number"},"InvoiceNumber":{"type":"string"},"MatchedFlag":{"type":"boolean","nullable":true},"MaxDiscountAllowed":{"type":"string","nullable":true},"Memo":{"type":"string"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"OpeningBalanceFlag":{"type":"boolean"},"PackingSlipNumber":{"type":"string"},"PaymentTermsId":{"type":"number"},"ProjectClassId":{"type":"number"},"RefNo":{"type":"string"},"ReportDataObj":{"properties":{"EntityAccntId":{"type":"string"},"EntityName":{"type":"string"},"ReportEntityId":{"type":"number"},"TxnRefId":{"type":"number"},"TxnRefNumber":{"type":"string"},"TxnTypeId":{"type":"number"}},"type":"object"},"ReportingData":{"type":"string","nullable":true},"ReportingDataText":{"type":"string","nullable":true},"SaleStoreId":{"type":"number"},"SalesRepId":{"type":"string"},"ShipDate":{"type":"string"},"ShipMethodId":{"type":"number"},"ShipServiceId":{"type":"number"},"ShipToAddr":{"type":"string"},"ShipToAddr2":{"type":"string"},"ShipToCity":{"type":"string"},"ShipToCompanyName":{"type":"string"},"ShipToCountry":{"type":"string"},"ShipToEmail":{"type":"string"},"ShipToFirstName":{"type":"string"},"ShipToLastName":{"type":"string"},"ShipToName":{"type":"string"},"ShipToPhoneNumber":{"type":"string"},"ShipToState":{"type":"string"},"ShipToZipPostalCode":{"type":"string"},"ShippingAmount":{"type":"number"},"ShippingAmountCredited":{"type":"string","nullable":true},"ShippingCost":{"type":"number"},"ShippingCostCarrier":{"type":"number"},"ShippingNotes":{"type":"string"},"ShippingTaxCode":{"type":"number"},"ShippingTaxData":{"properties":{"taxItems":{"items":{"properties":{"itemAmount":{"type":"number"},"itemId":{"type":"number"},"itemName":{"type":"string"},"itemRatePerc":{"type":"number"},"lineAmount":{"type":"number"}},"type":"object"},"type":"array"},"totalAmount":{"type":"number"}},"type":"object"},"ShippingTermsId":{"type":"number"},"ShippingTypeId":{"type":"number","nullable":true},"SoId":{"type":"number"},"SoNumber":{"type":"string"},"StatusId":{"type":"number"},"StoreId":{"type":"number"},"StoreName":{"type":"string","nullable":true},"TaxSummaryData":{"type":"string","nullable":true},"TaxSummaryDataText":{"type":"string"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartySource":{"type":"string"},"TotalAmount":{"type":"number"},"TotalTaxAmount":{"type":"number"},"TrackingNumbers":{"type":"string"},"TransferToStore":{"type":"number"},"TxnDate":{"type":"string"},"TxnId":{"type":"string"},"TxnNo":{"type":"number"},"TypeId":{"type":"number"}},"type":"object"},"PackingSlipItemLineArr":{"items":{"properties":{"BaseUomId":{"type":"number"},"BaseUomName":{"type":"string","nullable":true},"CreateDttm":{"type":"string","nullable":true},"CreateSource":{"type":"string","nullable":true},"Description":{"type":"string"},"Discount":{"type":"number"},"DiscountTypeId":{"type":"number"},"EffectiveUnitPrice":{"type":"number"},"HasRestrictionFlag":{"type":"boolean","nullable":true},"Id":{"type":"number"},"IsoCountryName":{"type":"string"},"ItemId":{"type":"number"},"ItemNumber":{"type":"string"},"ItemTypeId":{"type":"number"},"ItemTypeName":{"type":"string"},"LineNumber":{"type":"number"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"PackingSlipId":{"type":"number"},"Qty":{"type":"number"},"QtyDecimalFlag":{"type":"boolean"},"RestrictionOverrideFlag":{"type":"boolean","nullable":true},"RestrictionOverridePrice":{"type":"number","nullable":true},"RestrictionOverrideUser":{"type":"string","nullable":true},"SellUomId":{"type":"number"},"SellUomName":{"type":"string"},"SoId":{"type":"number"},"SoLineId":{"type":"number"},"SoNumber":{"type":"string"},"StatusId":{"type":"number","nullable":true},"TaxAmount":{"type":"number"},"TaxCodeId":{"type":"number"},"TaxCodeName":{"type":"string"},"TaxData":{"properties":{"taxItems":{"items":{"properties":{"itemAmount":{"type":"number"},"itemId":{"type":"number"},"itemName":{"type":"string"},"itemRatePerc":{"type":"number"},"lineAmount":{"type":"number"}},"type":"object"},"type":"array"},"totalAmount":{"type":"number"}},"type":"object"},"TaxableFlag":{"type":"boolean","nullable":true},"TotalAmount":{"type":"number"},"TxnId":{"type":"string"},"TxnNo":{"type":"number"},"UnitPrice":{"type":"number"},"UomFactor":{"type":"number"}},"type":"object"},"type":"array"}},"type":"object"},"salesOrderNumber":{"type":"string"}},"type":"object"},"IsForwardRequest":{"type":"boolean"},"Message":{"type":"string"},"MessageTitle":{"type":"string","nullable":true},"Result":{"type":"boolean"}},"type":"object"}}},"description":"OK","headers":{}}},"tags":["Fulfillment and Wave Management"],"description":"This API is used to ship the order and generate invoice.\nField |Data Type |Default Value |Description\n-------------------|-------------------|-------------------|--------------\n``OrderNumber``|string|NA|Sales order number. Only this order's lines will be closed on the Wave.\n``Freight``|decimal|0|This will update Freight amount, excluding tax, within the invoice (Custom markup can be applied to freight amount through configuration in Xorosoft ERP).\n``CarrierCost``|decimal|0|This will update carrier cost value on the Invoice.\n``TrackingNumber``|string|NA|This will attach the carrier's tracking number(s) for the shipped order. You can also include a TrackingNumber at the carton level.\n``FreightIdentifierCode``|number|0|This will decide if the freight provided in the API request will be charged to the Invoice or to be used from the Sales Order. Available Codes - 0: Use Global, 1: Use Freight From Sales Order, 2: Use API Provided Freight.\n``IsMarkupExempt``|boolean|false|This will enable/disable the markup up % provided the system app configuration.\n``CarrierCode``|string|NA|The carrier for this order.\n``ShipServiceCode``|string|NA|Identifies the shipping service to be used for this label.\n``ShippingCostCharged``|decimal|0|Freight cost per carton.\n``InvoiceDate``|date|NA|This will set the Invoice date (GL date) of the order shipped.\n``ShipDate``|date|NA|This will set the ship date of the order shipped.\n``ForceOverrideShipping``|boolean|false|This will decide if the override Shipping checkbox will be enabled or not for this shipment.\n``Cartons``|carton list|NA|This will accept the carton level details for the shipment (optional) Refer to request preview for carton model.\n``ShipAll``|boolean|false|This will mark all the wave lines for the order as shipped (closed or not) with the current quantity picked. Please note, any line with zero qty picked will be shipped as 0.\n``CustomFieldH1``|string|NA|Sets the value of custom field 1 on the Invoice.\n``CustomFieldH2``|string|NA|Sets the value of custom field 2 on the Invoice.\n``CustomFieldH3``|string|NA|Sets the value of custom field 3 on the Invoice.\n``CustomFieldH4``|string|NA|Sets the value of custom field 4 on the Invoice.\n``CustomFieldH5``|string|NA|Sets the value of custom field 5 on the Invoice.","operationId":"post_wave_ship","requestBody":{"content":{"application/json":{"schema":{"properties":{"CarrierCode":{"type":"string"},"Cartons":{"items":{"properties":{"ShipCartonDetailList":{"items":{"properties":{"ItemNumber":{"type":"string"},"Qty":{"type":"number"}},"type":"object"},"type":"array"},"ShipCartonHeaderObj":{"properties":{"CarrierConfCode":{"type":"string"},"CartonLabel":{"type":"string"},"DeclaredCost":{"type":"number"},"Height":{"type":"number"},"LabelCreatedFlag":{"type":"boolean"},"LabelUrl":{"type":"string"},"Length":{"type":"number"},"PackageTypeCode":{"type":"string"},"ShippingCostCarrier":{"type":"number"},"ShippingCostCharged":{"type":"number"},"SizeUomCode":{"type":"string"},"Sscc":{"type":"string"},"TrackingNumber":{"type":"string"},"Weight":{"type":"number"},"WeightUomCode":{"type":"string"},"Width":{"type":"number"}},"type":"object"}},"type":"object"},"type":"array"},"CustomFieldH1":{"type":"string"},"CustomFieldH2":{"type":"string"},"CustomFieldH3":{"type":"string"},"CustomFieldH4":{"type":"string"},"CustomFieldH5":{"type":"string"},"Freight":{"type":"number"},"OrderNumber":{"type":"string"},"ShipServiceCode":{"type":"string"},"TrackingNumber":{"type":"string"}},"type":"object"}}}},"summary":"Ship Sales Order"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.xorosoft.com/developers-api/fulfillment-and-wave-management/ship-sales-order.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.