/v23.1/PurchaseOrders
  • 05 Jun 2024
  • 4 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/PurchaseOrders

  • Dark
    Light
  • PDF

Article summary

Get
/v23.1/PurchaseOrders
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
StoreId
integer (int32)
TaskId
integer (int32)
DepartmentId
integer (int32)
PurchasePriceGroupId
integer (int32)
InboundMessageId
integer (int32)
OrderStatus
array of string
SupplierId
integer (int32)
CountryId
integer (int32)
SaleOrderId
integer (int32)
OrderNumber
integer (int32)
OrderReference
string
CreatedDateTimeFrom
string (date-time)
CreatedDateTimeTo
string (date-time)
OrderSentDateFrom
string (date-time)
OrderSentDateTo
string (date-time)
ExpectedDeliveryDateFrom
string (date-time)
ExpectedDeliveryDateTo
string (date-time)
ExportDateFrom
string (date-time)
ExportDateTo
string (date-time)
TransportTypeId
integer (int32)
PurchaseOrderClassId
integer (int32)
PurchaseOrderType
string
Valid values[ "NotSpecified", "NormalOrder", "CreditOrder", "BlanketOrder", "OrderRaisedBySupplier", "Dropshipment" ]
ConfirmationSupplierOrderNumber
string
ConfirmationReference
string
OrderConfirmationStatus
string
Valid values[ "NotSpecified", "Changed", "NotAccepted", "Accepted" ]
ConfirmationMessageDateFrom
string (date-time)
ConfirmationMessageDateTo
string (date-time)
ConfirmationMessageDateLastDays
integer (int32)
ConfirmationPlannedDeliveryDateFrom
string (date-time)
ConfirmationPlannedDeliveryDateTo
string (date-time)
ConfirmationPlannedDeliveryDateNextDays
integer (int32)
RowsEqualAcceptedOnly
string
Valid values[ "All", "Yes", "No" ]
OrdersWithConfirmationFreeInfoOnly
string
Valid values[ "All", "Yes", "No" ]
IsAutoFillOrderOnly
string
Valid values[ "All", "Yes", "No" ]
IsShowOpenPurchaseOrdersOnly
string
Valid values[ "All", "Yes", "No" ]
IsCancelledOnly
string
Valid values[ "All", "Yes", "No" ]
IsExportedOnly
string
Valid values[ "All", "Yes", "No" ]
IsExportedToWmsOnly
string
Valid values[ "All", "Yes", "No" ]
IsElectronicOrdersOnly
string
Valid values[ "All", "Yes", "No" ]
IsFreeDeliveryOnly
string
Valid values[ "All", "Yes", "No" ]
IsEdiFreeDeliveryOnly
string
Valid values[ "All", "Yes", "No" ]
IsTestOrdersOnly
string
Valid values[ "All", "Yes", "No" ]
HighPriorityOnly
string
Valid values[ "All", "Yes", "No" ]
DropshipmentOnly
string
Valid values[ "All", "Yes", "No" ]
SaleOrdersBoundOnly
string
Valid values[ "All", "Yes", "No" ]
DepartmentAssignedOnly
string
Valid values[ "All", "Yes", "No" ]
PurchasePriceGroupAssignedOnly
string
Valid values[ "All", "Yes", "No" ]
SentOrdersOnly
string
Valid values[ "All", "Yes", "No" ]
CreatedByScannerOnly
string
Valid values[ "All", "Yes", "No" ]
ConversionId
integer (int64)
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)
taskId
integer (int32)
departmentId
integer (int32)
purchasePriceGroupId
integer (int32)
supplierId
integer (int32)
countryId
integer (int32)
mobileDeviceId
integer (int32)
userId
integer (int32)
saleOrderId
integer (int32)
orderStatus
string
Valid values[ "NotSpecified", "New", "EntryCompleted", "EntryVerified", "Approved", "Final", "Closed" ]
isAutoFillOrder
boolean
Default"False"
isCancelled
boolean
Default"False"
digitalOrderType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
isTestOrder
boolean
Default"False"
rowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
requestedDeliveryDate
string (date-time)
expectedDeliveryDate
string (date-time)
exportDate
string (date-time)
orderSentDate
string (date-time)
priceLevelDate
string (date-time)
exportLog
string
exportToWmsDateTime
string (date-time)
orderNumber
integer (int32)
orderReference
string
description
string
miscInfo
string
textOnOrder
string
transportTypeId
integer (int32)
purchaseOrderClassId
integer (int32)
purchaseOrderType
string
Valid values[ "NotSpecified", "NormalOrder", "CreditOrder", "BlanketOrder", "OrderRaisedBySupplier", "Dropshipment" ]
totalGrossPrice
number (double)
discountPrice
number (double)
totalNetPrice
number (double)
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountPercentage
number (double)
orderDiscountNetNet
boolean
Default"False"
ediDiscountPercentage
number (double)
ediDiscountNetNet
boolean
Default"False"
performanceDiscountPercentage
number (double)
performanceDiscountNetNet
boolean
Default"False"
paymentDiscountPercentage
number (double)
paymentDiscountAfterVat
boolean
Default"False"
freeDiscount1Percentage
number (double)
freeDiscount1NetNet
boolean
Default"False"
freeDiscount1Description
string
freeDiscount2Percentage
number (double)
freeDiscount2NetNet
boolean
Default"False"
freeDiscount2Description
string
freeDeliveryValue
number (double)
ediFreeDeliveryValue
number (double)
smallOrderValue
number (double)
smallOrderCosts
number (double)
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
confirmationStatus
string
Valid values[ "NotSpecified", "Changed", "NotAccepted", "Accepted" ]
confirmationSupplierOrderNumber
string
confirmationOrderReceivedDateTime
string (date-time)
confirmationReference
string
confirmationMessageDateTime
string (date-time)
confirmationPlannedDeliveryDateTime
string (date-time)
confirmationFirstDeliveryDateTime
string (date-time)
confirmationLastDeliveryDateTime
string (date-time)
confirmationFreeInfo
string
inboundMessageId
integer (int32)
highPriority
boolean
Default"False"
dropshipment
boolean
Default"False"
conversionId
integer (int64)
taskNumber
integer (int32)
purchasePriceGroupDescription
string
createdByUserLoginName
string
createdByUserUserFullName
string
purchaseUserLoginName
string
purchaseUserFullName
string
supplierName
string
supplierNumber
integer (int64)
supplierExternalCode
string
transportTypeDescription
string
purchaseOrderClassDescription
string
countryDescription
string
storeDescription
string
generatedForSaleOrderNumber
integer (int32)
departmentDescription
string
totalReceivedAmount
number (double)
totalReceivedValue
number (double)
totalCalculatedConsumerUnits
number (double)
lastDateReceivedProducts
string (date-time)
totalNetValueBlanketSaleOrders
number (double)
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)
taskId
integer (int32)
departmentId
integer (int32)
purchasePriceGroupId
integer (int32)
supplierId
integer (int32)
countryId
integer (int32)
mobileDeviceId
integer (int32)
userId
integer (int32)
saleOrderId
integer (int32)
orderStatus
string
Valid values[ "NotSpecified", "New", "EntryCompleted", "EntryVerified", "Approved", "Final", "Closed" ]
isAutoFillOrder
boolean
Default"False"
isCancelled
boolean
Default"False"
digitalOrderType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
isTestOrder
boolean
Default"False"
rowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
requestedDeliveryDate
string (date-time)
expectedDeliveryDate
string (date-time)
exportDate
string (date-time)
orderSentDate
string (date-time)
priceLevelDate
string (date-time)
exportLog
string
exportToWmsDateTime
string (date-time)
orderNumber
integer (int32)
orderReference
string
description
string
miscInfo
string
textOnOrder
string
transportTypeId
integer (int32)
purchaseOrderClassId
integer (int32)
purchaseOrderType
string
Valid values[ "NotSpecified", "NormalOrder", "CreditOrder", "BlanketOrder", "OrderRaisedBySupplier", "Dropshipment" ]
totalGrossPrice
number (double)
discountPrice
number (double)
totalNetPrice
number (double)
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountPercentage
number (double)
orderDiscountNetNet
boolean
Default"False"
ediDiscountPercentage
number (double)
ediDiscountNetNet
boolean
Default"False"
performanceDiscountPercentage
number (double)
performanceDiscountNetNet
boolean
Default"False"
paymentDiscountPercentage
number (double)
paymentDiscountAfterVat
boolean
Default"False"
freeDiscount1Percentage
number (double)
freeDiscount1NetNet
boolean
Default"False"
freeDiscount1Description
string
freeDiscount2Percentage
number (double)
freeDiscount2NetNet
boolean
Default"False"
freeDiscount2Description
string
freeDeliveryValue
number (double)
ediFreeDeliveryValue
number (double)
smallOrderValue
number (double)
smallOrderCosts
number (double)
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
confirmationStatus
string
Valid values[ "NotSpecified", "Changed", "NotAccepted", "Accepted" ]
confirmationSupplierOrderNumber
string
confirmationOrderReceivedDateTime
string (date-time)
confirmationReference
string
confirmationMessageDateTime
string (date-time)
confirmationPlannedDeliveryDateTime
string (date-time)
confirmationFirstDeliveryDateTime
string (date-time)
confirmationLastDeliveryDateTime
string (date-time)
confirmationFreeInfo
string
inboundMessageId
integer (int32)
highPriority
boolean
Default"False"
dropshipment
boolean
Default"False"
conversionId
integer (int64)
taskNumber
integer (int32)
purchasePriceGroupDescription
string
createdByUserLoginName
string
createdByUserUserFullName
string
purchaseUserLoginName
string
purchaseUserFullName
string
supplierName
string
supplierNumber
integer (int64)
supplierExternalCode
string
transportTypeDescription
string
purchaseOrderClassDescription
string
countryDescription
string
storeDescription
string
generatedForSaleOrderNumber
integer (int32)
departmentDescription
string
totalReceivedAmount
number (double)
totalReceivedValue
number (double)
totalCalculatedConsumerUnits
number (double)
lastDateReceivedProducts
string (date-time)
totalNetValueBlanketSaleOrders
number (double)
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)
taskId
integer (int32)
departmentId
integer (int32)
purchasePriceGroupId
integer (int32)
supplierId
integer (int32)
countryId
integer (int32)
mobileDeviceId
integer (int32)
userId
integer (int32)
saleOrderId
integer (int32)
orderStatus
string
Valid values[ "NotSpecified", "New", "EntryCompleted", "EntryVerified", "Approved", "Final", "Closed" ]
isAutoFillOrder
boolean
Default"False"
isCancelled
boolean
Default"False"
digitalOrderType
string
Valid values[ "NotSpecified", "RetailLink", "Email" ]
isTestOrder
boolean
Default"False"
rowOrderType
string
Valid values[ "NotSpecified", "OrderCode", "ConsumerBarcode", "PurchaseUnitBarcode" ]
requestedDeliveryDate
string (date-time)
expectedDeliveryDate
string (date-time)
exportDate
string (date-time)
orderSentDate
string (date-time)
priceLevelDate
string (date-time)
exportLog
string
exportToWmsDateTime
string (date-time)
orderNumber
integer (int32)
orderReference
string
description
string
miscInfo
string
textOnOrder
string
transportTypeId
integer (int32)
purchaseOrderClassId
integer (int32)
purchaseOrderType
string
Valid values[ "NotSpecified", "NormalOrder", "CreditOrder", "BlanketOrder", "OrderRaisedBySupplier", "Dropshipment" ]
totalGrossPrice
number (double)
discountPrice
number (double)
totalNetPrice
number (double)
discountCalculationMethod
string
Valid values[ "NotSpecified", "MultiplyDiscountValues", "AddDiscountValues" ]
orderDiscountPercentage
number (double)
orderDiscountNetNet
boolean
Default"False"
ediDiscountPercentage
number (double)
ediDiscountNetNet
boolean
Default"False"
performanceDiscountPercentage
number (double)
performanceDiscountNetNet
boolean
Default"False"
paymentDiscountPercentage
number (double)
paymentDiscountAfterVat
boolean
Default"False"
freeDiscount1Percentage
number (double)
freeDiscount1NetNet
boolean
Default"False"
freeDiscount1Description
string
freeDiscount2Percentage
number (double)
freeDiscount2NetNet
boolean
Default"False"
freeDiscount2Description
string
freeDeliveryValue
number (double)
ediFreeDeliveryValue
number (double)
smallOrderValue
number (double)
smallOrderCosts
number (double)
orderDiscountExecuteOrder
integer (int32)
ediDiscountExecuteOrder
integer (int32)
performanceDiscountExecuteOrder
integer (int32)
freeDiscount1ExecuteOrder
integer (int32)
freeDiscount2ExecuteOrder
integer (int32)
confirmationStatus
string
Valid values[ "NotSpecified", "Changed", "NotAccepted", "Accepted" ]
confirmationSupplierOrderNumber
string
confirmationOrderReceivedDateTime
string (date-time)
confirmationReference
string
confirmationMessageDateTime
string (date-time)
confirmationPlannedDeliveryDateTime
string (date-time)
confirmationFirstDeliveryDateTime
string (date-time)
confirmationLastDeliveryDateTime
string (date-time)
confirmationFreeInfo
string
inboundMessageId
integer (int32)
highPriority
boolean
Default"False"
dropshipment
boolean
Default"False"
conversionId
integer (int64)
taskNumber
integer (int32)
purchasePriceGroupDescription
string
createdByUserLoginName
string
createdByUserUserFullName
string
purchaseUserLoginName
string
purchaseUserFullName
string
supplierName
string
supplierNumber
integer (int64)
supplierExternalCode
string
transportTypeDescription
string
purchaseOrderClassDescription
string
countryDescription
string
storeDescription
string
generatedForSaleOrderNumber
integer (int32)
departmentDescription
string
totalReceivedAmount
number (double)
totalReceivedValue
number (double)
totalCalculatedConsumerUnits
number (double)
lastDateReceivedProducts
string (date-time)
totalNetValueBlanketSaleOrders
number (double)
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.