List Sales Orders
Retrieves List of Sales Orders from the database. The data returned from this API will be paged Paging supported.
get
Authorizations
AuthorizationstringRequired
Query parameters
idnumberOptional
A comma-separated list of sales order ids
order_numberstringOptional
A comma-separated list of sales order numbers
customer_namestringOptional
A comma-separated list of customer names
store_namestringOptional
A comma-separated list of store names
third_party_ref_nostringOptional
A comma-separated list of third party reference numbers
ref_nostringOptional
A comma-separated list of sales order reference numbers
since_idstringOptional
Restrict results to after the specified ID
created_at_minstringOptional
Show sales orders created at or after date (format: 2014-04-25T16:15:47-04:00)
updated_at_minstringOptional
Show sales orders updated at or after date (format: 2014-04-25T16:15:47-04:00)
created_at_maxstringOptional
Show sales orders created at or before date (format: 2014-04-25T16:15:47-04:00)
updated_at_maxstringOptional
Show sales orders updated at or before date (format: 2014-04-25T16:15:47-04:00)
statusstringOptional
A comma-separated list of statuses
pagenumberRequired
Page number for the query result set. Default = 1
sale_store_namestringOptional
Sales store name used to filter or assign the transaction.
account3pl_idstringOptional
3PL account identifier.
exclude_processedbooleanOptionalDefault:
When true, excludes records already marked as processed.
falsethird_party_sourcestringOptional
Name of the external system or channel that supplied the transaction.
customer_idstringOptional
Customer identifier in Xorosoft ERP.
querystringOptional
Search text used by the endpoint where supported.
Responses
200
OK
application/json
IsForwardRequestbooleanOptional
MessagestringOptional
MessageTitlestring · nullableOptional
ResultbooleanOptional
get/api/xerp/salesorder/getsalesorder
GET /api/xerp/salesorder/getsalesorder?page=1 HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*
200
OK
{
"Data": [
{
"SoEstimateHeader": {
"AllocatableAmount": 0,
"AllocationPercentage": 0,
"AllocationPercentagePreview": 0,
"AllocationStatusId": null,
"AllocationStatusName": null,
"ApplyPricingRule": false,
"ApprovalStatusChangeDttm": null,
"ApprovalStatusChangeSource": null,
"ApprovalStatusName": null,
"AuthorizationDetailList": null,
"AutoCreateCarrierFlag": false,
"AutoDepositTotalAmount": null,
"BillToAddr": "1312 Seymour Cir",
"BillToAddr2": "",
"BillToAddrName": null,
"BillToCity": "Lincoln",
"BillToCompanyName": "",
"BillToCountry": "USA",
"BillToCountryISO2": null,
"BillToEmail": "",
"BillToFirstName": "",
"BillToLastName": "",
"BillToName": "",
"BillToPhoneNumber": "",
"BillToState": "CA",
"BillToStateAbbr": null,
"BillToZpCode": "95648",
"BrandId": null,
"BrandName": null,
"BuyerId": null,
"BuyerName": null,
"CampaignId": null,
"CampaignName": null,
"CancelledFlag": false,
"CaptureLater": false,
"CardId": null,
"CardNumber": null,
"CardPaymentProcessedFlag": false,
"CarrierId": 1321,
"CarrierName": "UPS",
"ChargeId": null,
"ChargeTypeId": null,
"CreateDttm": "03/03/2020 10:31:22 PM",
"CreateSource": "xtest10012",
"CurrencyCode": "USD",
"CurrencyId": 1001,
"CurrencyName": "United States Dollar",
"CurrencySymbol": "$ ",
"CustomFieldH1": null,
"CustomFieldH10": null,
"CustomFieldH11": null,
"CustomFieldH12": null,
"CustomFieldH13": null,
"CustomFieldH14": null,
"CustomFieldH15": null,
"CustomFieldH16": null,
"CustomFieldH17": null,
"CustomFieldH18": null,
"CustomFieldH19": null,
"CustomFieldH2": null,
"CustomFieldH20": null,
"CustomFieldH21": null,
"CustomFieldH22": null,
"CustomFieldH23": null,
"CustomFieldH24": null,
"CustomFieldH25": null,
"CustomFieldH26": null,
"CustomFieldH27": null,
"CustomFieldH28": null,
"CustomFieldH29": null,
"CustomFieldH3": null,
"CustomFieldH30": null,
"CustomFieldH4": null,
"CustomFieldH5": null,
"CustomFieldH6": null,
"CustomFieldH7": null,
"CustomFieldH8": null,
"CustomFieldH9": null,
"CustomerContact": "",
"CustomerDefaultBillingEmail": null,
"CustomerDefaultShipmentupdatesEmail": null,
"CustomerEmailCC": null,
"CustomerEmailMain": "",
"CustomerFirstName": null,
"CustomerFullName": "Customer 1",
"CustomerGroupId": 9,
"CustomerId": 6113,
"CustomerLastName": null,
"CustomerMainPhone": "",
"CustomerMessage": "",
"CustomerName": "Customer 1",
"CustomerPO": "123456",
"CustomerServiceRepFullName": null,
"CustomerServiceRepId": null,
"CustomerTaxCodeId": null,
"Cvc": null,
"DateFirstShip": null,
"DateFulFilled": null,
"DateLastShip": null,
"DateRelease": null,
"DateTimeCancelled": null,
"DateToBeCancelled": null,
"DateToBeShipped": "10/20/2019",
"DefaultLocationId": null,
"DefaultLocationName": null,
"DepositAccountName": null,
"DepositAmount": null,
"DepositDue": 73.93,
"DepositEmailSentCount": 0,
"DepositEmailSentFlag": false,
"DepositRequiredAmount": 20,
"DepositRequiredFlag": true,
"DepositRequiredType": 20,
"DepositRequiredTypeName": null,
"DiscountAmount": 0,
"Email": null,
"EstimateFollowUpDate": null,
"EstimateToSoFlag": false,
"EstimateValidUntilDate": null,
"ExchangeRate": 1,
"ExchangeRateFormula": null,
"ExpirationMonth": null,
"ExpirationYear": null,
"FobId": 20,
"FobName": "Destination",
"FullfillmentPercentage": 0,
"HasRestrictionFlag": false,
"Id": 23897,
"ImageList": null,
"IntAccntId": null,
"InvoiceCounter": 0,
"IsClosed": false,
"IsCreatedFromB2BFlag": false,
"IsEstimateModule": false,
"IsOrderTaxExempt": false,
"IsTaxableFlag": 0,
"LastDateToBeShipped": null,
"LastDepositEmailSentDttm": null,
"LastDepositEmailSentSource": "",
"LiabilityAccountName": null,
"Memo": "This is a memo",
"MerchantResponseData": null,
"MerchantReturnRefNumber": null,
"MerchantTypeId": null,
"ModifyDttm": "03/22/2020 09:58:09 PM",
"ModifySource": "kunalx",
"NameOnCard": null,
"NoTaxCompareFlag": false,
"OrderClassCode": "ON",
"OrderClassName": "Online",
"OrderDate": "10/03/2018",
"OrderNumber": "MAIN-S003607",
"OrderRefNumber": null,
"OrderTypeCode": null,
"OrderTypeName": null,
"PaymentAmount": 0,
"PaymentCurrencyId": 0,
"PaymentMethodName": null,
"PaymentProcessed": false,
"PaymentReceipt": null,
"PaymentServiceAccountId": 0,
"PaymentTermsId": 10,
"PaymentTermsName": "COD",
"PresentationCode": null,
"PresentationId": 0,
"PresentationName": null,
"PriorityId": null,
"PriorityName": "",
"ProcessCreditCard": false,
"ProjectClassId": 1,
"ProjectClassName": "Online",
"QtyToAllocateAfter": 0,
"QtyToAllocateBefore": 0,
"ReCalcShippingTaxesFlag": false,
"ReCalcTaxesFlag": false,
"RecalculateTaxes": false,
"RefId": null,
"RefNo": "RefNo203892-1",
"ReportDataObj": {
"EntityAccntId": "C7A82F0E-53F2-4934-875F-BBA04F907FCB",
"EntityName": "Customer 1",
"ReportEntityId": 103,
"TxnRefId": 23897,
"TxnRefNumber": "MAIN-S003607",
"TxnTypeId": 116
},
"ResidentialFlag": null,
"RiskAnalysis": null,
"SaleStoreId": 10002,
"SaleStoreName": "Main Warehouse",
"SalesRepFullName": "Derek Brad",
"SalesRepId": "dbrad",
"SaveCreditCardInfo": false,
"ShipMethodId": 30,
"ShipMethodName": "Delivery (Third Party)",
"ShipPackageTypeId": null,
"ShipServiceCode": "UPSG",
"ShipServiceId": 58,
"ShipServiceName": "UPS Ground",
"ShipToAddr": "1312 Seymour Cir",
"ShipToAddr2": "",
"ShipToAddrName": "",
"ShipToCity": "Lincoln",
"ShipToCompanyName": "",
"ShipToCountry": "USA",
"ShipToCountryISO2": null,
"ShipToEmail": "",
"ShipToFirstName": "",
"ShipToLastName": "",
"ShipToName": "",
"ShipToPhoneNumber": "",
"ShipToState": "CA",
"ShipToStateAbbr": null,
"ShipToZpCode": "95648",
"ShippingAccountNumber": "",
"ShippingAmount": 107.25,
"ShippingCost": 100,
"ShippingCostInvoiced": null,
"ShippingCostRemaining": 100,
"ShippingNotes": "This is Shipping Notes",
"ShippingTaxCodeId": 1000,
"ShippingTaxCodeName": "CA TAX 7.25%",
"ShippingTaxData": {
"taxItems": [
{
"itemAmount": 7.25,
"itemId": 1000,
"itemName": "CA TAX 7.25%",
"itemRatePerc": 7.25,
"lineAmount": 100
}
],
"totalAmount": 7.25
},
"ShippingTaxItems": [
{
"Id": 1000,
"Name": "CA TAX 7.25%",
"Rate": 0.0725,
"RateType": "percentage",
"TotalAmount": 7.25
}
],
"ShippingTermsId": 30,
"ShippingTermsName": "Prepaid & Billed",
"ShippingTypeId": null,
"ShippingTypeName": "",
"SoSubTypeId": 1,
"SoSubTypeName": "SS18 D3",
"StatusId": 10,
"StatusName": "Open",
"StoreId": 10002,
"StoreName": "Main Warehouse",
"SubTotal": 0,
"SubTotalExclDiscount": 0,
"Tags": "TagX,TagY",
"TaxCalcByAddress": false,
"TaxCalcType": null,
"TaxOperationCountryCode": null,
"TaxSummaryDataText": null,
"TemplateId": null,
"ThirdPartyDefaultSKU": null,
"ThirdPartyDisplayName": " Shopify",
"ThirdPartyFulfillmentAccount": null,
"ThirdPartyFulfillmentRefId": null,
"ThirdPartyFulfillmentStatus": null,
"ThirdPartyIconUrl": "https://image-url-for-source",
"ThirdPartyRefNo": "Order123",
"ThirdPartyShippingRefNo": "",
"ThirdPartySource": "Shopify-Account1",
"ThirdPartyTotalAmount": null,
"ThirdPartyTotalTaxAmount": 0,
"ToBeEmailedFlag": null,
"ToBeMailedFlag": null,
"ToBePrintedFlag": null,
"TotalAmount": 519.63,
"TotalDeposit": 30,
"TotalQty": 0,
"TotalTaxAmount": 35.13,
"TotalWaveCount": 0,
"TotalWeight": null,
"TrackingNumbers": null,
"TransactionComplete": false,
"TransferFromStoreId": null,
"TransferFromStoreName": null,
"TransferPoId": null,
"TransferPoNumber": "",
"TransferProcessedFlag": false,
"TransferToStoreId": null,
"TransferToStoreName": "",
"TxnId": null,
"TxnNumber": 0,
"TxnTypeId": null,
"TypeId": 20,
"TypeName": "Sale",
"UpdateExchangeRateFlag": false,
"UseDefaultSKUWhenError": false,
"UseDifferentPaymentServiceAccount": false,
"VendorPO": "",
"WeightUomId": 2,
"cardLast4Digits": null
},
"SoEstimateItemLineArr": [
{
"AmountAllocatedBefore": 0,
"AmountAllocatedPreview": 0,
"AuthorizationDetailList": null,
"AutoVoidWaveLine": false,
"BasePartNumber": "BC",
"BaseUomId": 4,
"BaseUomName": "Each",
"CloseFlag": null,
"CreateDttm": "03/03/2020 10:31:22 PM",
"CreateSource": null,
"CurrencySymbol": null,
"CustomFieldD1": "",
"CustomFieldD10": "",
"CustomFieldD11": "",
"CustomFieldD12": "",
"CustomFieldD13": "",
"CustomFieldD14": "",
"CustomFieldD15": "",
"CustomFieldD16": "",
"CustomFieldD17": "",
"CustomFieldD18": "",
"CustomFieldD19": "",
"CustomFieldD2": "",
"CustomFieldD20": "",
"CustomFieldD21": "",
"CustomFieldD22": "",
"CustomFieldD23": "",
"CustomFieldD24": "",
"CustomFieldD25": "",
"CustomFieldD26": "",
"CustomFieldD27": "",
"CustomFieldD28": "",
"CustomFieldD29": "",
"CustomFieldD3": "",
"CustomFieldD30": "",
"CustomFieldD4": "",
"CustomFieldD5": "",
"CustomFieldD6": "",
"CustomFieldD7": "",
"CustomFieldD8": "",
"CustomFieldD9": "",
"DateFirstShip": null,
"DateFulfilled": null,
"DateLastShip": null,
"DateRelease": null,
"DateToBeShipped": "10/20/2019",
"DefaultVendorId": null,
"DefaultVendorName": "",
"DeleteFlag": false,
"Description": "Battery Connector",
"Discount": 50,
"DiscountTypeId": 10,
"DiscountTypeName": "percentage",
"EditState": true,
"EffectiveUnitPrice": 384.5,
"ExternalItemNumber": "",
"ForceSalesTaxCode": false,
"HasRestriction": false,
"Id": 40668,
"ImageList": null,
"ImagePath": "",
"IsKitHeader": false,
"IsKitItem": false,
"IsTaxableFlag": true,
"IsoCode2": "",
"IsoCountryName": "",
"ItemId": 30111,
"ItemNotes": null,
"ItemNumber": "BC",
"ItemTypeId": 10,
"ItemTypeName": "Inventory",
"ItemUpc": "",
"KitItemFactor": 1,
"LastDateToBeShipped": null,
"LineNumber": 1,
"MasterKitId": null,
"MasterKitKey": "",
"MoRefNumbers": "",
"ModifyDttm": null,
"ModifySource": null,
"Notes": "Test notes",
"OpenFLag": null,
"Option1Name": "",
"Option1Value": "",
"Option1ValueCode": "",
"Option2Name": "",
"Option2Value": "",
"Option2ValueCode": "",
"ProductHeaderId": 4669,
"ProjectClassId": null,
"ProjectClassName": "",
"Qty": 1,
"QtyAllocated": 0,
"QtyAllocatedPreview": null,
"QtyDecimalFlag": false,
"QtyOrdered": 1,
"QtyRemainingToShip": 1,
"QtyShipped": 0,
"RefId": null,
"RestrictionOverrideFlag": false,
"RestrictionOverridePrice": null,
"RestrictionOverrideUser": "",
"SellUomId": 4,
"SellUomName": "Each",
"SoId": 23897,
"StatusId": 10,
"StatusName": "Open",
"TaxAmount": 27.8763,
"TaxCodeId": 1000,
"TaxCodeName": "CA TAX 7.25%",
"TaxData": {
"taxItems": [
{
"itemAmount": 27.8763,
"itemId": 1000,
"itemName": "CA TAX 7.25%",
"itemRatePerc": 7.25,
"lineAmount": 384.5
}
],
"totalAmount": 27.8763
},
"TaxItems": [
{
"Id": 1000,
"Name": "CA TAX 7.25%",
"Rate": 0.0725,
"RateType": "percentage",
"TotalAmount": 27.8763
}
],
"ThirdPartyRefNo": "",
"ThirdPartySourceHeader": null,
"TotalAmount": 384.5,
"TxnTypeId": null,
"UnitPrice": 769,
"UomFactor": null,
"VASItemCost": null,
"VASItemId": null,
"VASItemName": "",
"VariantInfo": "",
"VariantInfoColored": "",
"WaveLineId": 0,
"Weight": null,
"WeightUomId": 2
}
]
}
],
"IsForwardRequest": false,
"Message": "Order data loaded successfully",
"MessageTitle": null,
"Result": true
}Last updated
Was this helpful?