Create Sales Order
Creates a new sales order in the system corresponding to the provided 3PL account token.
AccountToken
string
A unique authentication token generated specifically for a 3PL account. It is used as a parameter in API requests to authenticate and access resources related to the corresponding 3PL account.
ThirdPartyRefNo
string, required
A reference number for the order. If an order in Xorosoft ERP exists with the same ThirdPartyRefNo, it will be detected as a duplicate and will not be created.
ThirdPartySource
string
If the order came from a third party platform, it can be indicated here.
ThirdPartyIconUrl
string
Use a URL that ends with .png or .jpg for an image of the third party source.For example, a Joor order would have a Joor icon.
ThirdPartyDisplayName
string
It represents the name of third party source.
CheckThirdPartySource
bool
Property, when set to true, checks if a third-party reference number exists with the same third-party source
SaleStoreName
string, required
It is Sale Store's (inventory set) name here exactly as it is in Xorosoft ERP.
StoreName
string
It is Ship Store's (inventory set) name here exactly as it is in Xorosoft ERP. If this is left blank, then **SaleStoreName will be used.
CurrencyCode
string, required
It represents the currency for the order. This must match with the customer's currency. Choose from: USD,CAD,EUR,AUD.
CustomerName
string, required
It represents the name of customer.
CustomerFirstName
string
First Name of the customer.
CustomerLastName
string
Last Name of the customer.
CustomerMainPhone
string
Customer main Phone Number
CustomerEmailMain
string
The customer's email address.
CustomerPO
string
Customer PO field.
OrderDate
DateTime, required
The date the order was placed.
DateToBeShipped
DateTime, required
The date the order is to be shipped before or on.
LastDateToBeShipped
DateTime
The date the order should be shipped.
DateToBeCancelled
DateTime
If the order hasn't been fulfilled by this date, then it can be cancelled, MM-DD-YYYY
OrderClassCode
string
It represents the Code categorize your orders.
OrderClassName
string
It represents the name of the Class to categorize your orders.
OrderTypeCode
string
It represents the code for type of order.
OrderTypeName
string
It represents the name for type of order.
ExchangeRate
double, required
It represents the exchange rate betweeen currencies. If currency is the same as home currency, then put 1 here. Otherwise put the exchange rate for the order.
Memo
string
A memo for the order can be entered here.
PaymentTermsName
string
It is a payment term from the system for this order. This must match up exactly to a Payment Term in Xorosoft ERP.
PaymentTermsType
string
It represents the code for type of payment terms.
RefNo
string
It is a reference number for the order here. This can be an internal reference number, as opposed to a third-party reference number.
Tags
string
It represents tags here for the order and multiple tags can be separated by a comma.
SalesRepId
string
Please refer to the User Centre in your Xorosoft ERP system and enter the UserID of the sales rep for this Sales Order.
ShipMethodName
string
It is a ship method for the order here. Choose from: Pick Up, Delivery(Own Truck) and Delivery(Third Party)
CarrierName
string
If ShipMethodName is not Pick Up, then enter a carrier.
CarrierCode
string
The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).
ShipServiceName
string
It represents the name of ship service for the order.
ShipServiceCode
string
The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).
FobName
string
It represents the FobName for the order.
IsOrderTaxExempt
bool
It represents the boolean represented in the form of N for Exempt tax and Y for Active Tax.
ShippingTaxItemCode1
string
It represents the ShippingTaxItemCode1 for the Order.
ShippingTaxItemValue1
double
It represents the ShippingTaxItemValue1 for the Order.
ShippingTaxItemCode2
string
It represents the ShippingTaxItemCode2 for the Order.
ShippingTaxItemValue2
double
It represents the ShippingTaxItemValue2 for the Order.
ShippingTaxItemCode3
string
It represents the ShippingTaxItemCode3 for the Order.
ShippingTaxItemValue3
double
It represents the ShippingTaxItemValue3 for the Order.
ShippingTaxItemCode4
string
It represents the ShippingTaxItemCode4 for the Order.
ShippingTaxItemValue4
double
It represents the ShippingTaxItemValue5 for the Order.
ShippingTermsName
string
It represents the shipping terms.Choose from: Prepaid, Collect, Prepaid& Billed, Collect& Allowed and Third Party Billing.
ShippingAccountNumber
string
It represents the shipping account number here.
ShippingCost
double
It represents the shipping cost for the Order.
ShippingNotes
string
It represents the shipping notes for the Order.
ShipToFirstName
string
It represents the first name of ship to for the Order.
ShipToLastName
string
It represents the last name of ship to for the Order.
ShipToName
string
It represents the Main address name of ship to for the Order.
ShipToCompanyName
string
It represents the company name of ship to for the Order.
ShipToAddr
string
It represents the address line 1 of ship to for the Order.
ShipToAddr2
string
It represents the address line 2 of ship to for the Order.
ShipToCity
string
It represents the city of ship to for the Order.
ShipToCountry
string
It represents the country name of ship to for the Order.
ShipToCountryISO2
string
It is a code to Identify a Country of ship to for the Order
ShipToState
string
It represents the state name of ship to for the Order.
ShipToStateAbbr
string
It is the abbrevation of state of ship to for the Order.
ShipToZpCode
string
It represents the zip code of ship to for the Order.
ShipToPhoneNumber
string
It represents the phone number of ship to for the Order.
ShipToEmail
string
It represents the email of ship to for the Order.
BuyerName
string
It is a name of Buyer.
BillToFirstName
string
It represents the first name of bill to for the Order.
BillToLastName
string
It represents the last name of bill to for the Order.
BillToName
string
It represents the Main address name of bill to for the Order.
BillToAddr
string
It represents the address line 1 of bill to for the Order.
BillToAddr2
string
It represents the address line 2 of bill to for the Order.
BillToCity
string
It represents the city of bill to for the Order.
BillToCountry
string
It represents the country name of bill to for the Order.
BillToCountryISO2
string
It is a code to Identify a Country of bill to for the Order
BillToState
string
It represents the state name of bill to for the Order.
BillToStateAbbr
string
It is the abbrevation of state name of bill to for the Order.
BillToZpCode
string
It represents the zip code of bill to for the Order.
BillToCompanyName
string
It represents the company name of bill to for the Order.
BillToPhoneNumber
string
It represents the phone number of bill to for the Order.
BillToEmail
string
It represents the email of bill to for the Order.
CustomerGroupName
string
It represents the customer group name for the Order.
DepositRequiredTypeName
string
It represents the deposit on the order, whether that deposit is Amount or a Percentage.
DepositRequiredAmount
double
It is percentage or amount of deposit required for this order.
DepositAmount
double
It represents the deposit amount for the Deposit.
DepositAccountName
string
It represents the deposit account name for the Account.
LiabilityAccountName
string
It represents the liability account name for the Account.
PaymentMethodName
string
It represents the payment method name for the Method.
AutoDepositTotalAmount
string
It represents the auto deposit total amount for the Total.
CustomerServiceRepId
string
It represents the customer service representative id.
ThirdPartyTotalAmount
double
It represents the third party total amount.
CustomFieldH1
string
Custom Fields (CustomFieldH1 - CustomFieldH30).
ItemNumber
string, required
The item's (SKU) number. This property is unique to this item, another item cannot be created with the same Item Number.
ItemUpc
string
The item's UPC code.
ItemBrand
string
The item's Brand.
Description
string
The item's description.
UnitPrice
double, required
The item's Unit Price.
Qty
double, required
The item's Qty.
Discount
double
The item's Discount.
DiscountTypeName
string
Percentage or Amount.
SellUomName
string
Selling unit of measurement of the item
ItemNotes
string
It represents the item notes for the Item.
TaxItemCode1
string
It represents the TaxItemCode1 for the Item.
TaxItemValue1
double
It represents the TaxItemValue1 for the Item.
TaxItemCode2
string
It represents the TaxItemCode2 for the Item.
TaxItemValue2
double
It represents the TaxItemValue2 for the Item.
TaxItemCode3
string
It represents the TaxItemCode3 for the Item.
TaxItemValue3
double
It represents the TaxItemValue3 for the Item.
TaxItemCode4
string
It represents the TaxItemCode4 for the Item.
TaxItemValue4
double
It represents the TaxItemValue4 for the Item.
ItemCategoryName
string
It represents the name of item category here.
ItemGroupName
string
It represents the name of item group here.
ItemShippingCost
double
It represents the item shipping cost.
ItemShippingTaxItemCode1
string
It represents the ItemShippingTaxItemCode1.
ItemShippingTaxItemValue1
double
It represents the ItemShippingTaxItemValue1.
ItemShippingTaxItemCode2
string
It represents the ItemShippingTaxItemCode2.
ItemShippingTaxItemValue2
double
It represents the ItemShippingTaxItemValue2.
ItemShippingTaxItemCode3
string
It represents the ItemShippingTaxItemCode3.
ItemShippingTaxItemValue3
double
It represents the ItemShippingTaxItemValue3.
ItemShippingTaxItemCode4
string
It represents the ItemShippingTaxItemCode4.
ItemShippingTaxItemValue4
double
It represents the ItemShippingTaxItemValue4.
BaseUomCode
string
It represents the code for base value of unit of measurement.
SellUomCode
string
It represents the code for unit of measurement used for selling.
VASItemName
string
Value added service name.
VASItemCost
double
Value added service item cost.
AutoReleaseSalesOrder
bool
This will auto release the sales order while creating sales order.
CustomFieldD1
string
Custom Fields (CustomFieldD1 - CustomFieldD30).
AccountCode3PL
string
The code associated with the 3PL account.
RequirePackAndHold
bool
Indicates whether packing and holding of items are required for the order.
IsPackAndHold
bool
Indicates whether the order is packed and held.
SoBatchId
int (nullable)
The ID of the sales order batch.
PackingSlipNumbers
string
The numbers associated with the packing slips for the order.
TotalCancelQty
double
The total quantity of canceled items.
Customer3plTypeName
string
The type name of the customer associated with the 3PL account.
IsVASRequired
bool
Indicates whether Value-Added Services (VAS) are required for the order.
VASInstruction
string
Instructions for Value-Added Services (VAS) associated with the order.
IsVASCompleted
bool
Indicates whether Value-Added Services (VAS) for the order are completed.
ExceptionFlag
bool
Indicates if there is an exception related to the order.
SoBatchNumber
string
The batch number associated with the sales order.
PackedDttm
DateTime (nullable)
The date and time when the order was packed.
ReadyToShipDttm
DateTime (nullable)
The date and time when the order is ready to be shipped.
StagedDttm
DateTime (nullable)
The date and time when the order is staged.
IsLeadOrder
bool
Indicates whether the order is a lead order.
IsPackAndHoldReleased
bool
Indicates whether the packed and held items are released.
CustomerAccountNumber
string
The account number of the customer associated with the 3PL account.
ShipToAddrHashCode
int
The hash code of the shipping address.
Account3plId
int
The ID of the 3PL account.
MinimumATSPercent
double
The minimum Available-to-Sell (ATS) percentage.
LockFlag
bool
Indicates if the order is locked.
FillRateFailedFlag
bool
Indicates if the fill rate for the order failed.
Account3plName
string
The name of the 3PL account.
EIN
string
The EIN associated with the account.
DutyPaymentTermsId
int (nullable)
The ID of the duty payment terms.
DutyPaymentTermsCode
string
The code for the duty payment terms.
DutyPaymentTerms
string
The duty payment terms.
CustomComment
string
Custom comments associated with the order.
PriorityCode
string
The priority code associated with the order.
IsAccount3plApiRequest
bool
Indicates if the request is made through the 3PL API.
CustomFieldD1
string
Custom Fields (CustomFieldD1 - CustomFieldD30).
CustomerDefaultOrderTypeName
string
The default order type associated with the customer.
CustomerDefaultProjectClassName
string
The default project class linked to the customer.
IsCustomerTaxExempt
bool
Indicates whether the customer is tax-exempt (true or false).
CustomerTaxNumber1
string
It represents the primary tax identification number of the customer.
CustomerTaxNumber2
string
It represents the secondary tax identification number of the customer (if applicable).
CustomerTags
string
Tags or labels associated with the customer for categorization or reporting purposes.
Request body for Create Sales Order.
A unique authentication token generated specifically for a 3PL account. It is used as a parameter in API requests to authenticate and access resources related to the corresponding 3PL account.
A reference number for the order. If an order in Xorosoft ERP exists with the same ThirdPartyRefNo, it will be detected as a duplicate and will not be created.
If the order came from a third party platform, it can be indicated here.
Use a URL that ends with .png or .jpg for an image of the third party source.For example, a Joor order would have a Joor icon.
It represents the name of third party source.
Property, when set to true, checks if a third-party reference number exists with the same third-party source
It is Sale Store's (inventory set) name here exactly as it is in Xorosoft ERP.
It is Ship Store's (inventory set) name here exactly as it is in Xorosoft ERP. If this is left blank, then **SaleStoreName will be used.
It represents the currency for the order. This must match with the customer's currency. Choose from: USD,CAD,EUR,AUD.
It represents the name of customer.
First Name of the customer.
Last Name of the customer.
Customer main Phone Number
The customer's email address.
Customer PO field.
The date the order was placed.
The date the order is to be shipped before or on.
The date the order should be shipped.
If the order hasn't been fulfilled by this date, then it can be cancelled, MM-DD-YYYY
It represents the Code categorize your orders.
It represents the name of the Class to categorize your orders.
It represents the code for type of order.
It represents the name for type of order.
It represents the exchange rate betweeen currencies. If currency is the same as home currency, then put 1 here. Otherwise put the exchange rate for the order.
A memo for the order can be entered here.
It is a payment term from the system for this order. This must match up exactly to a Payment Term in Xorosoft ERP.
It represents the code for type of payment terms.
It is a reference number for the order here. This can be an internal reference number, as opposed to a third-party reference number.
It represents tags here for the order and multiple tags can be separated by a comma.
Please refer to the User Centre in your Xorosoft ERP system and enter the UserID of the sales rep for this Sales Order.
It is a ship method for the order here. Choose from: Pick Up, Delivery(Own Truck) and Delivery(Third Party)
If ShipMethodName is not Pick Up, then enter a carrier.
The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).
It represents the name of ship service for the order.
The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).
It represents the FobName for the order.
It represents the boolean represented in the form of N for Exempt tax and Y for Active Tax.
It represents the ShippingTaxItemCode1 for the Order.
It represents the ShippingTaxItemValue1 for the Order.
It represents the ShippingTaxItemCode2 for the Order.
It represents the ShippingTaxItemValue2 for the Order.
It represents the ShippingTaxItemCode3 for the Order.
It represents the ShippingTaxItemValue3 for the Order.
It represents the ShippingTaxItemCode4 for the Order.
It represents the ShippingTaxItemValue5 for the Order.
It represents the shipping terms.Choose from: Prepaid, Collect, Prepaid& Billed, Collect& Allowed and Third Party Billing.
It represents the shipping account number here.
It represents the shipping cost for the Order.
It represents the shipping notes for the Order.
It represents the first name of ship to for the Order.
It represents the last name of ship to for the Order.
It represents the Main address name of ship to for the Order.
It represents the company name of ship to for the Order.
It represents the address line 1 of ship to for the Order.
It represents the address line 2 of ship to for the Order.
It represents the city of ship to for the Order.
It represents the country name of ship to for the Order.
It is a code to Identify a Country of ship to for the Order
It represents the state name of ship to for the Order.
It is the abbrevation of state of ship to for the Order.
It represents the zip code of ship to for the Order.
It represents the phone number of ship to for the Order.
It represents the email of ship to for the Order.
It is a name of Buyer.
It represents the first name of bill to for the Order.
It represents the last name of bill to for the Order.
It represents the Main address name of bill to for the Order.
It represents the address line 1 of bill to for the Order.
It represents the address line 2 of bill to for the Order.
It represents the city of bill to for the Order.
It represents the country name of bill to for the Order.
It is a code to Identify a Country of bill to for the Order
It represents the state name of bill to for the Order.
It is the abbrevation of state name of bill to for the Order.
It represents the zip code of bill to for the Order.
It represents the company name of bill to for the Order.
It represents the phone number of bill to for the Order.
It represents the email of bill to for the Order.
It represents the customer group name for the Order.
It represents the deposit on the order, whether that deposit is Amount or a Percentage.
It is percentage or amount of deposit required for this order.
It represents the deposit amount for the Deposit.
It represents the deposit account name for the Account.
It represents the liability account name for the Account.
It represents the payment method name for the Method.
It represents the auto deposit total amount for the Total.
It represents the customer service representative id.
It represents the third party total amount.
Custom Fields (CustomFieldH1 - CustomFieldH30).
The item's (SKU) number. This property is unique to this item, another item cannot be created with the same Item Number.
The item's UPC code.
The item's Brand.
The item's Unit Price.
The item's Qty.
The item's Discount.
Percentage or Amount.
Selling unit of measurement of the item
It represents the item notes for the Item.
It represents the TaxItemCode1 for the Item.
It represents the TaxItemValue1 for the Item.
It represents the TaxItemCode2 for the Item.
It represents the TaxItemValue2 for the Item.
It represents the TaxItemCode3 for the Item.
It represents the TaxItemValue3 for the Item.
It represents the TaxItemCode4 for the Item.
It represents the TaxItemValue4 for the Item.
It represents the name of item category here.
It represents the name of item group here.
It represents the item shipping cost.
It represents the ItemShippingTaxItemCode1.
It represents the ItemShippingTaxItemValue1.
It represents the ItemShippingTaxItemCode2.
It represents the ItemShippingTaxItemValue2.
It represents the ItemShippingTaxItemCode3.
It represents the ItemShippingTaxItemValue3.
It represents the ItemShippingTaxItemCode4.
It represents the ItemShippingTaxItemValue4.
It represents the code for base value of unit of measurement.
It represents the code for unit of measurement used for selling.
Value added service name.
Value added service item cost.
This will auto release the sales order while creating sales order.
Custom Fields (CustomFieldD1 - CustomFieldD30).
The code associated with the 3PL account.
Indicates whether packing and holding of items are required for the order.
Indicates whether the order is packed and held.
The ID of the sales order batch.
The numbers associated with the packing slips for the order.
The total quantity of canceled items.
The type name of the customer associated with the 3PL account.
Indicates whether Value-Added Services (VAS) are required for the order.
Instructions for Value-Added Services (VAS) associated with the order.
Indicates whether Value-Added Services (VAS) for the order are completed.
Indicates if there is an exception related to the order.
The batch number associated with the sales order.
The date and time when the order was packed.
The date and time when the order is ready to be shipped.
The date and time when the order is staged.
Indicates whether the order is a lead order.
Indicates whether the packed and held items are released.
The account number of the customer associated with the 3PL account.
The hash code of the shipping address.
The ID of the 3PL account.
The minimum Available-to-Sell (ATS) percentage.
Indicates if the order is locked.
Indicates if the fill rate for the order failed.
The name of the 3PL account.
The EIN associated with the account.
The ID of the duty payment terms.
The code for the duty payment terms.
The duty payment terms.
Custom comments associated with the order.
The priority code associated with the order.
Indicates if the request is made through the 3PL API.
The default order type associated with the customer.
The default project class linked to the customer.
Indicates whether the customer is tax-exempt (true or false).
It represents the primary tax identification number of the customer.
It represents the secondary tax identification number of the customer (if applicable).
Tags or labels associated with the customer for categorization or reporting purposes.
OK
No content
POST /api/xerp/account3pl/createsalesorder HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 147
{
"SoEstimateHeader": {
"ThirdPartyRefNo": "SO-EXT-1001",
"CustomerName": "Example Customer"
},
"SoEstimateItemLineArr": [
{
"ItemNumber": "SKU-001",
"Qty": 1
}
]
}OK
No content
Last updated
Was this helpful?