Prod Devloper portal
  • Home
  • Retail Express API
  • Financial Summary API
  • Legacy APIs
Search · ⌘K
Retail Express API 2.1
v2.1
  • Overview
      • Searches Countries by parametersget
      • Gets Country by idget
      • Search Credit Notes by parametersget
      • Get Credit Note by idget
      • Searches Credit Note Items by parametersget
      • Gets Credit Note Item by idget
      • Searches Currencies by parametersget
      • Gets Currency by idget
      • Searches Customer Logs by parametersget
      • Gets specific Customer Logs by unique idget
      • Searches Customers by parametersget
      • Creates Customerpost
      • Gets specific Customer by unique idget
      • Updates Customerput
      • Searches Delivery Addresses by Customer id and other parametersget
      • Creates Customer Delivery Addresspost
      • Gets specific Delivery Address by unique Customer id and Delivery Address idget
      • Deletes specific Delivery Address by unique Customer id and Delivery Address iddelete
      • Updates Delivery Addressput
      • Searches Loyalty History by Customer id and other parametersget
      • Gets specific Loyalty History by unique Customer id and Loyalty History idget
      • Searches Customer Survey Segments by parametersget
      • Gets Customer Survey Segment by idget
      • Searches Options by Customer Survey Segment id and other parametersget
      • Gets specific Option by unique Customer Survey Segment id and Option idget
      • Searches Customer Types by parametersget
      • Creates Customer Typepost
      • Gets specific Customer Type by unique idget
      • Deletes specific Customer Type by iddelete
      • Updates Customer Typeput
      • Creates Freight Typepost
      • Searches Freight Types by parametersget
      • Deletes specific Freight Type by iddelete
      • Gets specific Freight Type by unique idget
      • Updates Freight Typeput
      • Searches fulfilment orders by parametersget
      • Get specific fulfilment order by fulfilment idget
      • Searches Inventories by parametersget
      • Gets specific Inventory Movement Log by unique idget
      • Searches Inventory Movement Logsget
      • Searches Loyalty Adjustment Reasons by parametersget
      • Creates Loyalty Adjustment Reasonpost
      • Gets specific Loyalty Adjustment Reason by unique idget
      • Updates Loyalty Adjustment Reasonput
      • Deletes Loyalty Adjustment Reason by iddelete
      • Creates Loyalty Adjustmentpost
      • Searches Loyalty Historyget
      • Searches Max Discount Rules by parametersget
      • Gets specific Max Discount Rule by unique idget
      • Searches Order Fulfilments by parametersget
      • Gets specific Order Fulfilmentget
      • Searches Order Items by parametersget
      • Gets specific Order Itemget
      • Searches Order Payments by parametersget
      • Gets specific Order Paymentget
      • Searches Order Fulfilments by parametersget
      • Gets specific Order Fulfilmentget
      • Searches Order Items by parametersget
      • Gets specific Order Itemget
      • Searches Order Payments by parametersget
      • Gets specific Order Paymentget
      • Searches Orders by parametersget
      • Gets specific Order by unique idget
      • Searches Outlets by parametersget
      • Gets specific Outlet by unique idget
      • Searches PriceGroups by parametersget
      • Searches Fixed Price Groups by parametersget
      • Creates Fixed Price Grouppost
      • Updates specific Fixed Price Group by idput
      • Deletes specific Fixed Price Group by iddelete
      • Gets all Product Attribute Values, existing in the system for provided Product Attributeget
      • Creates new Product Attribute Value entity in the systempost
      • Gets specific Product Attribute Value by unique idget
      • Updates Product Attribute Value entity in the system.put
      • Gets all Product Attributes, existing in the systemget
      • Gets specific Product Attribute by unique idget
      • Searches Barcodes by parametersget
      • Searches Product Details Logsget
      • Gets specific Product Details Log by unique idget
      • Searches Product Estimated Times of Arrival by parametersget
      • Searches Product Pricings by parametersget
      • Searches Product Replenishment Methods by parametersget
      • Gets specific Product Replenishment Method by unique idget
      • Searches Products by parametersget
      • Creates productspost
      • Gets specific Product by unique idget
      • Disables specific Product by id 1) Hides the product from reports and Stocktake by default 2) Turns off communication between Retail Express and eCommerce/Web Store integrations 3) Excluded from Product Search in POSdelete
      • Updates Productput
      • Searches Product Barcodes by Product id and other parametersget
      • Creates Product Barcodepost
      • Gets specific Product Barcode by unique Product Barcode id and Product idget
      • Updates Product Barcode by Product id and Product Barcode id.put
      • Deletes specific Product Barcode by iddelete
      • Creates product suppliers for a specific productpost
      • Gets all suppliers for a specific productget
      • Deletes all Product Supplier by product iddelete
      • Bulk updates product suppliers for a specific productput
      • Gets a specific supplier for a productget
      • Deletes specific Product Supplier by supplier codedelete
      • Updates a specific product supplier by product ID and supplier codeput
      • Searches Product Types by parametersget
      • Creates new Product Type entity in the systempost
      • Gets specific Product Type by unique idget
      • Creates Purchase Order Receiptpost
      • Searches Purchase Order Receiptsget
      • Updates specific Purchase Order Receipt by idput
      • Deletes specific Purchase Order Receipt by iddelete
      • Gets specific Purchase Order Receipt by unique idget
      • Creates a Purchase Order Receipt Itempost
      • Searches Purchase Order Receipt Items by Purchase Order Receipt id and other parametersget
      • Gets specific Purchase Order Receipt Item by unique Purchase Order Receipt id and Purchase Order Receipt Item idget
      • Deletes specific Purchase Order Receipt Item by iddelete
      • Updates Purchase Order Receipt Itemput
      • Applies a discount during Purchase Order Receiptpost
      • Gets Purchase Orderget
      • Creates Purchase Orderpost
      • Searches Purchase Orders by parametersget
      • Searches Purchase Order Items by Purchase Order id and other parametersget
      • Deletes specific Purchase Order Item by iddelete
      • Gets Receipt Variance Reason by idget
      • Updates specific Receipt Variance Reason by idput
      • Searches Receipt Variance Reasons by parametersget
      • Creates Receipt Variance Reasonpost
      • Searches Return Reasons by parametersget
      • Gets specific Return Reason by unique idget
      • Searches Shipment Types by parametersget
      • Creates Shipment Typepost
      • Gets Shipment Type by idget
      • Updates Shipment Typeput
      • Deletes Shipment Type by iddelete
      • Searches Shipping Ports by parametersget
      • Creates Shipping Portpost
      • Gets specific Shipping Port by unique idget
      • Deletes Shipping Port by iddelete
      • Updates Shipping Port by idput
      • Searches Shipping Statuses by parametersget
      • Creates Shipping Statuspost
      • Gets Shipping Status by idget
      • Updates Shipping Statusput
      • Deletes Shipping Status by iddelete
      • Creates Stock Adjustment Reasonpost
      • Searches Stock Adjustment Reasons by parametersget
      • Updates Stock Adjustment Reasonput
      • Deletes Stock Adjustment Reason by id when not used in any stock adjustmentdelete
      • Gets specific Stock Adjustment Reason by unique idget
      • Creates Stock Receiptpost
      • Searches Stock Receipts by parametersget
      • Gets Stock Receipt by idget
      • Gets Supplier Invoice by idget
      • Updates Supplier Invoiceput
      • Searches Supplier Invoices by parametersget
      • Creates Supplier Invoicepost
      • Updates Supplier Invoice Direct Costsput
      • Searches Supplier Return Item Sources by parametersget
      • Gets specific Supplier Return Item Source by unique idget
      • Searches Supplier Return Item Statuses by parametersget
      • Gets specific Supplier Return Item Status by unique idget
      • Creates Supplier Return Reasonpost
      • Searches Supplier Return Reasons by parametersget
      • Updates Supplier Return Reasonput
      • Deletes Supplier Return Reason by iddelete
      • Gets specific Supplier Return Reason by unique idget
      • Searches Supplier Returns by parametersget
      • Creates Supplier Returnpost
      • Gets specific Supplier Return by unique idget
      • Updates Supplier Returnput
      • Searches Supplier Return Items by Supplier Return id and other parametersget
      • Creates Supplier Return Itempost
      • Get specific Supplier Return Item by Supplier Return id and Supplier Return Item idget
      • Deletes specific Supplier Return Item by iddelete
      • Updates Supplier Return Itemput
      • Creates Credit Note with Credit Note Itemspost
      • Searches Supplier Return Credit Notes by parametersget
      • Gets a Credit Note with Credit Note Items by Supplier Return id and Credit Note idget
      • Updates Credite Note by Supplier Return id and Credit Note idput
      • Searches Supplier Return Statuses by parametersget
      • Gets specific Supplier Return Status by unique idget
      • Searches Suppliers by parametersget
      • Creates Supplierpost
      • Gets Supplier by idget
      • Updates Supplier by idput
      • Deletes Supplier by iddelete
      • Acquires tokenget
      • Searches Transfer Items by parametersget
      • Searches Transfersget
      • Creates Transferpost
      • Gets specific Transfer by unique idget
      • Searches Transfer Items by parametersget
      • Creates Transfer Itempost
      • Gets specific Transfer Item by unique idget
      • Searches Transfer Statuses by parametersget
      • Gets specific Transfer Status by unique idget
      • Searches Transfer Types by parametersget
      • Gets specific Transfer Type by unique idget
      • Searches Users by parametersget
      • Gets specific User by unique idget
      • Searches vouchers by parametersget
      • Get specific voucher by unique idget
      • Searches Voucher Types by parametersget
      • Gets specific Voucher Type by unique idget
    • AccountCustomer
    • Attribute
    • Attribute.PagingResponse
    • AttributeValue
    • AttributeValue.PagingResponse
    • AttributeValueLimited
    • auth.AuthenticationResult
    • BillingAddress
    • Boolean.BeforeAfter
    • Campaign
    • Country
    • Country.PagingResponse
    • CountryLimited
    • CreditNote
    • CreditNote.PagingResponse
    • CreditNoteItem
    • CreditNoteItem.PagingResponse
    • CreditNoteItemExtended
    • CreditNoteItemLimited
    • CreditNoteProduct
    • Currency
    • Currency.PagingResponse
    • CurrencyLimited
    • Customer
    • Customer.PagingResponse
    • CustomerBillingAddress
    • CustomerLimited
    • CustomerLogVM
    • CustomerLogVM.PagingResponse
    • CustomerLoyaltyHistory
    • CustomerLoyaltyHistory.PagingResponse
    • CustomerSalesChannel
    • CustomerSegmentGroup
    • CustomerSegmentGroup.PagingResponse
    • CustomerSegmentOption
    • CustomerSegmentOption.PagingResponse
    • CustomerType
    • CustomProperty
    • Decimal.BeforeChangeAfter
    • DeliveryAddress
    • DeliveryAddress.PagingResponse
    • DeliveryDriver
    • DeliveryTime
    • DeliveryZone
    • DirectCosts
    • DirectCostsItem
    • ExtendedFulfilment
    • ExtendedFulfilment.PagingResponse
    • ExtendedOrderItem
    • ExtendedOrderItem.PagingResponse
    • ExtendedOrderPayment
    • ExtendedOrderPayment.PagingResponse
    • FixedPriceGroup
    • FixedPriceGroup.PagingResponse
    • FreightType
    • FreightType.PagingResponse
    • FreightTypeLimited
    • Fulfilment
    • fulfilment.Order
    • fulfilment.Order.PagingResponse
    • Fulfilment.PagingResponse
    • fulfilment.ShippitOrder
    • Inventory
    • Inventory.PagingResponse
    • InventoryMovementLogs
    • InventoryMovementLogs.PagingResponse
    • InventoryMovementLogsChange
    • InventoryMovementLogsDelta
    • InventoryMovementLogsProduct
    • LandedCostsCalculation
    • LogoLimited
    • LoyaltyAdjustmentReason
    • LoyaltyAdjustmentReason.PagingResponse
    • LoyaltyHistory
    • LoyaltyHistory.PagingResponse
    • LoyaltyProgram
    • Marketing
    • MaxDiscountRule
    • MaxDiscountRule.PagingResponse
    • Order
    • Order.PagingResponse
    • OrderItem
    • OrderItem.PagingResponse
    • OrderLimited
    • OrderPayment
    • OrderPayment.PagingResponse
    • OrderStatus
    • OrderVoucher
    • Outlet
    • Outlet.PagingResponse
    • OutletAddress
    • OutletBankDetails
    • OutletEmailFromTemplate
    • OutletExtended
    • OutletLimited
    • PaymentMethod
    • PriceGroup
    • PriceGroupRule
    • ProblemDetails
    • Product
    • Product.PagingResponse
    • ProductBarcode
    • ProductBarcode.PagingResponse
    • ProductDetailLog
    • ProductDetailLog.PagingResponse
    • ProductDetailLogProduct
    • ProductETA
    • ProductETA.PagingResponse
    • ProductExtended
    • ProductExternalLinks
    • ProductFixedPriceGroupVM
    • ProductInventory
    • ProductInventoryOutlet
    • ProductLimited
    • ProductPriceGroupVM
    • ProductPricing
    • ProductPricing.PagingResponse
    • ProductPricingLimited
    • ProductReplenishmentMethod
    • ProductReplenishmentMethod.PagingResponse
    • ProductSalesChannelVM
    • ProductSupplier
    • ProductType
    • ProductType.PagingResponse
    • PurchaseOrder
    • PurchaseOrder.PagingResponse
    • PurchaseOrderItem
    • PurchaseOrderItem.PagingResponse
    • PurchaseOrderItemInventory
    • PurchaseOrderItemVarianceReason
    • PurchaseOrderLimited
    • PurchaseOrderReceiptItem
    • PurchaseOrderReceiptItem.PagingResponse
    • PurchaseOrderReceiptItemVarianceReason
    • PurchaseOrderReceipts
    • PurchaseOrderReceipts.PagingResponse
    • PurchaseOrderReceiptStatusName
    • PurchaseOrderShippingPort
    • PurchaseOrderShippingStatus
    • PurchaseOrderShippingType
    • PurchaseOrderStatus
    • PurchaseOrderSupplier
    • ReceiptVarianceReason
    • ReceiptVarianceReason.PagingResponse
    • ReturnReason
    • ReturnReason.PagingResponse
    • ReturnReasonLimited
    • SalesChannelLimited
    • ShipmentType
    • ShipmentType.PagingResponse
    • ShippingStatus
    • ShippingStatus.PagingResponse
    • SourceGroupVM
    • StandardPriceGroup
    • StandardPriceGroup.PagingResponse
    • StockAdjustmentReason
    • StockAdjustmentReason.PagingResponse
    • StockReceipt
    • StockReceipt.PagingResponse
    • StoreType
    • String.BeforeAfter
    • Supplier
    • Supplier.PagingResponse
    • SupplierAddress
    • SupplierInvoice
    • SupplierInvoice.PagingResponse
    • SupplierInvoiceDirectCosts
    • SupplierInvoiceLimited
    • SupplierInvoicePurchaseOrderReceipt
    • SupplierInvoicePurchaseOrderReceiptItem
    • SupplierLimited
    • SupplierReturnItem
    • SupplierReturnItem.PagingResponse
    • SupplierReturnItemProduct
    • SupplierReturnItemSource
    • SupplierReturnItemSource.PagingResponse
    • SupplierReturnItemStatus
    • SupplierReturnItemStatus.PagingResponse
    • SupplierReturnReasons
    • SupplierReturnReasons.PagingResponse
    • SupplierReturns
    • SupplierReturns.PagingResponse
    • SupplierReturnsCreditNote
    • SupplierReturnsCreditNote.PagingResponse
    • SupplierReturnStatus
    • SupplierReturnStatus.PagingResponse
    • SupplierShippingPort
    • SupplierShippingPort.PagingResponse
    • SurveyResponse
    • Transfer
    • Transfer.PagingResponse
    • TransferItem
    • TransferItem.PagingResponse
    • TransferStatus
    • TransferStatus.PagingResponse
    • TransferType
    • TransferType.PagingResponse
    • User
    • User.PagingResponse
    • UserExtended
    • UserLimited
    • UserOutlet
    • UserSecurityProfile
    • V2.CustomerType
    • V2.CustomerType.PagingResponse
    • VarianceAction
    • Voucher
    • Voucher.PagingResponse
    • VoucherType
    • VoucherType.PagingResponse
    • VoucherTypeLimited
    • VoucherVoucherType
Retail Express API 2.1

Retail Express API

  • Download spec
Retail Express API
  • Download spec