/v23.1/SaleOrders
  • 05 Jun 2024
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/SaleOrders

  • Dark
    Light
  • PDF

Article summary

Get
/v23.1/SaleOrders
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
StoreId
integer (int32)
InboundMessageId
integer (int32)
WebshopId
integer (int32)
SaleChannelId
integer (int32)
SaleOrderId
integer (int32)
RowsAttachedToPurchaseOrderId
integer (int32)
CustomerId
integer (int32)
ParentSaleOrderId
integer (int32)
FiscalCountryId
integer (int32)
LoyaltyCard
string
DeliveryCustomerId
integer (int32)
DebtorId
integer (int32)
MobileDeviceId
integer (int32)
UserId
integer (int32)
ReservationId
integer (int32)
QuoteId
integer (int32)
ZipCode
string
Description
string
ReferenceCode
string
OrderNumber
integer (int32)
OrderNumberFrom
integer (int32)
OrderNumberTo
integer (int32)
OrderStatus
array of string
TransportTypeId
integer (int32)
SaleOrderClassId
integer (int32)
SaleOrderType
string
Valid values[ "NotSpecified", "NormalSaleOrder", "BlanketOrder", "CreditOrder", "ResendOrder" ]
PurchaseOrderId
integer (int32)
OrderCreatedDateFrom
string (date-time)
OrderCreatedDateTo
string (date-time)
RequestedDeliveryRouteId
integer (int32)
RequestedDeliveryRouteDateId
integer (int32)
RequestedDeliveryDateFrom
string (date-time)
RequestedDeliveryDateTo
string (date-time)
ExpectedDeliveryDateFrom
string (date-time)
ExpectedDeliveryDateTo
string (date-time)
UtmostDeliveryDateFrom
string (date-time)
UtmostDeliveryDateTo
string (date-time)
LastModifiedSinceDateTime
string (date-time)
PrePaymentRequestNumber
integer (int32)
PrePaymentNumber
integer (int32)
IsCancelledOnly
string
Valid values[ "All", "Yes", "No" ]
HasPendingPrePaymentsOnly
string
Valid values[ "All", "Yes", "No" ]
OpenSaleOrdersOnly
string
Valid values[ "All", "Yes", "No" ]
OrdersWithRowsOnly
string
Valid values[ "All", "Yes", "No" ]
IsOrderResponseSentOnly
string
Valid values[ "All", "Yes", "No" ]
IsEdiSaleOrdersOnly
string
Valid values[ "All", "Yes", "No" ]
IsExportedOnly
string
Valid values[ "All", "Yes", "No" ]
IsVatFreeOnly
string
Valid values[ "All", "Yes", "No" ]
RemainingAmountEqual0Only
string
Valid values[ "All", "Yes", "No" ]
ReservedAmountEqual0Only
string
Valid values[ "All", "Yes", "No" ]
WithReservationsOnly
string
Valid values[ "All", "Yes", "No" ]
ActiveSuppressedOnly
string
Valid values[ "All", "Yes", "No" ]
PartialDeliveryAllowedOnly
string
Valid values[ "All", "Yes", "No" ]
AllRowsMarkedDropshipmentOnly
string
Valid values[ "All", "Yes", "No" ]
WithInboundMessagesOnly
string
Valid values[ "All", "Yes", "No" ]
PurchaseOrderBoundOnly
string
Valid values[ "All", "Yes", "No" ]
CustomerApprovalStatus
string
Valid values[ "NotSpecified", "Pending", "Accepted", "Rejected" ]
SuppliersApprovalStatus
string
Valid values[ "NotSpecified", "Pending", "AcceptedWithOrWithoutChange", "AcceptedWithAmountChange", "AcceptedWithDeliveryChange", "AcceptedWithNotes", "AcceptedWithAnyChange", "AcceptedWithoutChange", "Rejected" ]
ApprovedWhenNeededOnly
boolean
InterbrancheOnly
string
Valid values[ "All", "Yes", "No" ]
ConversionId
integer (int64)
PickupPointIdentifier
string
OpenCustomerServiceRowsOnly
string
Valid values[ "All", "Yes", "No" ]
Offset
integer (int32)
RecordCount
integer (int32)
ItemId
integer (int32)
IncludeItemId
integer (int32)
ExcludeItemId
integer (int32)
ModifiedSinceDateTime
string (date-time)
Responses
200

Success

Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
customerId
integer (int32)
customerContactId
integer (int32)
parentSaleOrderId
integer (int32)
fiscalCountryId
integer (int32)
loyaltyCard
string
deliveryCustomerId
integer (int32)
deliveryAddressId
integer (int32)
debtorId
integer (int32)
transportTypeId
integer (int32)
transportProperties
string
saleOrderClassId
integer (int32)
saleOrderType
string
Valid values[ "NotSpecified", "NormalSaleOrder", "BlanketOrder", "CreditOrder", "ResendOrder" ]
purchaseOrderId
integer (int32)
mobileDeviceId
integer (int32)
userId
integer (int32)
costCenterId
integer (int32)
orderNumber
integer (int32)
orderStatus
string
Valid values[ "NotSpecified", "New", "EntryCompleted", "EntryVerified", "Final", "Closed" ]
description
string
isVatFree
boolean
Default"False"
isRaise
boolean
Default"False"
isCancelled
boolean
Default"False"
referenceCode
string
miscInfo
string
discountPrice
number (double)
discountPercentage
number (double)
secureDiscounts
boolean
Default"False"
loyaltyWithdrawalPoints
number (double)
loyaltyWithdrawalPrice
number (double)
totalGrossPrice
number (double)
totalNetPrice
number (double)
totalWeightedNetPrice
number (double)
suppressUntilDate
string (date-time)
printedDateTime
string (date-time)
exportDateTime
string (date-time)
onHoldUntilDateTime
string (date-time)
requestedDeliveryRouteId
integer (int32)
requestedDeliveryRouteDateId
integer (int32)
requestedDeliveryDate
string (date-time)
earliestDeliveryDate
string (date-time)
utmostDeliveryDate
string (date-time)
expectedDeliveryDate
string (date-time)
orderResponseDate
string (date-time)
orderResponseLog
string
inboundMessageId
integer (int32)
webshopId
integer (int32)
saleChannelId
integer (int32)
lockedForChanges
boolean
Default"False"
partialDeliveryAllowed
boolean
Default"False"
log
string
conversionId
integer (int64)
pickupPointIdentifier
string
emailAddressId
integer (int32)
webshopDescription
string
webshopCode
string
customerName
string
customerNumber
integer (int64)
deliveryCustomerName
string
deliveryCustomerNumber
integer (int64)
userFullName
string
saleOrderClassDescription
string
saleOrderClassCode
string
purchaseOrdernumber
integer (int32)
storeDescription
string
transportTypeDescription
string
transportTypeCode
string
totalPrepaymentRequests
number (double)
totalPrePaid
number (double)
totalPrePaidBalance
number (double)
totalPrepaymentRequestBalance
number (double)
totalReservationsValue
number (double)
totalSoldReservationsValue
number (double)
fiscalCountryDescription
string
inboundMessageNumber
integer (int32)
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
customerId
integer (int32)
customerContactId
integer (int32)
parentSaleOrderId
integer (int32)
fiscalCountryId
integer (int32)
loyaltyCard
string
deliveryCustomerId
integer (int32)
deliveryAddressId
integer (int32)
debtorId
integer (int32)
transportTypeId
integer (int32)
transportProperties
string
saleOrderClassId
integer (int32)
saleOrderType
string
Valid values[ "NotSpecified", "NormalSaleOrder", "BlanketOrder", "CreditOrder", "ResendOrder" ]
purchaseOrderId
integer (int32)
mobileDeviceId
integer (int32)
userId
integer (int32)
costCenterId
integer (int32)
orderNumber
integer (int32)
orderStatus
string
Valid values[ "NotSpecified", "New", "EntryCompleted", "EntryVerified", "Final", "Closed" ]
description
string
isVatFree
boolean
Default"False"
isRaise
boolean
Default"False"
isCancelled
boolean
Default"False"
referenceCode
string
miscInfo
string
discountPrice
number (double)
discountPercentage
number (double)
secureDiscounts
boolean
Default"False"
loyaltyWithdrawalPoints
number (double)
loyaltyWithdrawalPrice
number (double)
totalGrossPrice
number (double)
totalNetPrice
number (double)
totalWeightedNetPrice
number (double)
suppressUntilDate
string (date-time)
printedDateTime
string (date-time)
exportDateTime
string (date-time)
onHoldUntilDateTime
string (date-time)
requestedDeliveryRouteId
integer (int32)
requestedDeliveryRouteDateId
integer (int32)
requestedDeliveryDate
string (date-time)
earliestDeliveryDate
string (date-time)
utmostDeliveryDate
string (date-time)
expectedDeliveryDate
string (date-time)
orderResponseDate
string (date-time)
orderResponseLog
string
inboundMessageId
integer (int32)
webshopId
integer (int32)
saleChannelId
integer (int32)
lockedForChanges
boolean
Default"False"
partialDeliveryAllowed
boolean
Default"False"
log
string
conversionId
integer (int64)
pickupPointIdentifier
string
emailAddressId
integer (int32)
webshopDescription
string
webshopCode
string
customerName
string
customerNumber
integer (int64)
deliveryCustomerName
string
deliveryCustomerNumber
integer (int64)
userFullName
string
saleOrderClassDescription
string
saleOrderClassCode
string
purchaseOrdernumber
integer (int32)
storeDescription
string
transportTypeDescription
string
transportTypeCode
string
totalPrepaymentRequests
number (double)
totalPrePaid
number (double)
totalPrePaidBalance
number (double)
totalPrepaymentRequestBalance
number (double)
totalReservationsValue
number (double)
totalSoldReservationsValue
number (double)
fiscalCountryDescription
string
inboundMessageNumber
integer (int32)
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
customerId
integer (int32)
customerContactId
integer (int32)
parentSaleOrderId
integer (int32)
fiscalCountryId
integer (int32)
loyaltyCard
string
deliveryCustomerId
integer (int32)
deliveryAddressId
integer (int32)
debtorId
integer (int32)
transportTypeId
integer (int32)
transportProperties
string
saleOrderClassId
integer (int32)
saleOrderType
string
Valid values[ "NotSpecified", "NormalSaleOrder", "BlanketOrder", "CreditOrder", "ResendOrder" ]
purchaseOrderId
integer (int32)
mobileDeviceId
integer (int32)
userId
integer (int32)
costCenterId
integer (int32)
orderNumber
integer (int32)
orderStatus
string
Valid values[ "NotSpecified", "New", "EntryCompleted", "EntryVerified", "Final", "Closed" ]
description
string
isVatFree
boolean
Default"False"
isRaise
boolean
Default"False"
isCancelled
boolean
Default"False"
referenceCode
string
miscInfo
string
discountPrice
number (double)
discountPercentage
number (double)
secureDiscounts
boolean
Default"False"
loyaltyWithdrawalPoints
number (double)
loyaltyWithdrawalPrice
number (double)
totalGrossPrice
number (double)
totalNetPrice
number (double)
totalWeightedNetPrice
number (double)
suppressUntilDate
string (date-time)
printedDateTime
string (date-time)
exportDateTime
string (date-time)
onHoldUntilDateTime
string (date-time)
requestedDeliveryRouteId
integer (int32)
requestedDeliveryRouteDateId
integer (int32)
requestedDeliveryDate
string (date-time)
earliestDeliveryDate
string (date-time)
utmostDeliveryDate
string (date-time)
expectedDeliveryDate
string (date-time)
orderResponseDate
string (date-time)
orderResponseLog
string
inboundMessageId
integer (int32)
webshopId
integer (int32)
saleChannelId
integer (int32)
lockedForChanges
boolean
Default"False"
partialDeliveryAllowed
boolean
Default"False"
log
string
conversionId
integer (int64)
pickupPointIdentifier
string
emailAddressId
integer (int32)
webshopDescription
string
webshopCode
string
customerName
string
customerNumber
integer (int64)
deliveryCustomerName
string
deliveryCustomerNumber
integer (int64)
userFullName
string
saleOrderClassDescription
string
saleOrderClassCode
string
purchaseOrdernumber
integer (int32)
storeDescription
string
transportTypeDescription
string
transportTypeCode
string
totalPrepaymentRequests
number (double)
totalPrePaid
number (double)
totalPrePaidBalance
number (double)
totalPrepaymentRequestBalance
number (double)
totalReservationsValue
number (double)
totalSoldReservationsValue
number (double)
fiscalCountryDescription
string
inboundMessageNumber
integer (int32)
401

Unauthorized

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403

Forbidden

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
404

Not Found

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.