idinteger(int32)required
Purchase Order Receipt Id
item_idinteger(int32)required
Purchase Order Receipt Item Id
Deletes specific Purchase Order Receipt Item by id
Deletes specific Purchase Order Receipt Item by id
delete
https://api.retailexpress.com.au/v2.1/purchaseorderreceipts/{id}/purchaseorderreceiptitems/{item_id}
Path Parameters
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
Response
Purchase Order Receipt Item was deleted
delete/purchaseorderreceipts/{id}/purchaseorderreceiptitems/{item_id}
Path Parameters
Headers
Updates Purchase Order Receipt Item
Sample request:
PUT /purchaseorderreceipts/1/purchaseorderreceiptitems/1
{
"quantity_expected": 1,
"buy_price_ex": 1.1,
"quantity_received": 3,
"quantity_faulty": 2,
"quantity_invoiced": 1,
"unit_discount_ex": 1.1,
"direct_costs_ex": 1.1,
"include_tax": true,
"variance_action": "Leave On-Order",
"variance_reason": {
"id": 1,
"name": "variance reason name"
},
"bin": "bin",
"notes": "notes"
}
put
https://api.retailexpress.com.au/v2.1/purchaseorderreceipts/{id}/purchaseorderreceiptitems/{item_id}
Path Parameters
idinteger(int32)required
Purchase Order Receipt id
item_idinteger(int32)required
Purchase Order Receipt Item id
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Body
application/json
Body
application/json
Purchase Order Item model
EmptyExample
EmptyExampleobject
* Additional properties are NOT allowed.
Response
application/json
Response
application/json
Returns updated Purchase Order Receipt Item
PurchaseOrderReceiptItem
Purchase order receipt item
* Additional properties are NOT allowed.
idinteger | null(int32)
Purchase order receipt item identifier
purchase_order_item_idinteger | null(int32)
Purchase order item identifier
pricingobject
* Additional properties are NOT allowed.
Show Child Parameters
purchase_order_receipt_idinteger | null(int32)
Purchase order receipt identifier
stock_receipt_idinteger | null(int32)
Stock receipt identifier
quantity_expectedinteger | null(int32)
Quantity expected
quantity_receivedinteger(int32)
Quantity received
quantity_faultyinteger(int32)
Quantity faulty
quantity_invoicedinteger | null(int32)
Quantity invoiced
buy_price_exnumber | null(double)
Buy price ex
supplier_buy_exnumber | null(double)
Supplier buy ex
unit_discount_exnumber | null(double)
Unit discount ex
direct_costs_exnumber(double)
Direct costs ex
include_taxboolean | null
Include tax
quantity_received_varianceinteger | null(int32)
Quantity received variance
productobject
* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)
Created on
created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_onstring(date-time)
Modified On
modified_byobject
* Additional properties are NOT allowed.
Show Child Parameters
made_available_onstring | null(date-time)
Made Available On
made_available_byobject
* Additional properties are NOT allowed.
Show Child Parameters
finalised_onstring | null(date-time)
Finalised on
finalised_byobject
* Additional properties are NOT allowed.
Show Child Parameters
total_buy_price_exnumber | null(double)
Total buy price ex
binstring | null
Bin
cogs_exnumber(double)
Cogs ex
total_taxnumber | null(double)
Total tax
total_buy_price_incnumber | null(double)
Total buy price inc
total_applied_buy_price_exnumber | null(double)
Total applied buy price ex
total_direct_costs_exnumber | null(double)
Total direct costs ex
total_cogs_exnumber | null(double)
Total cogs ex
total_cogs_incnumber | null(double)
Total cogs inc
variance_actionstring
Allowed values:Leave On-OrderCancel BalanceReceive BalanceReview LaterCreate Supplier Return
variance_reasonobject
Purchase order receipt item variance reason
* Additional properties are NOT allowed.
Show Child Parameters
notesstring | null
Notes
put/purchaseorderreceipts/{id}/purchaseorderreceiptitems/{item_id}
Path Parameters
Headers
Body
{}
application/json
Applies a discount during Purchase Order Receipt
Sample request:
POST /purchaseorderreceipts/1/discount
{
"discount_amount_type": "Amount",
"distribute_by": "Value",
"discount_amount": 1.1,
"purchase_order_receipt_item_ids": [1, 2]
}
post
https://api.retailexpress.com.au/v2.1/purchaseorderreceipts/{id}/discount
Path Parameters
idinteger(int32)required
Purchase Order Receipt id
Example:1
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Body
application/json
Body
application/json
Purchase Order Receipt discount model
EmptyExample
EmptyExampleobject
* Additional properties are NOT allowed.
Response
Response
Success
post/purchaseorderreceipts/{id}/discount
Path Parameters
Headers
Body
{}
purchaseorders
Gets Purchase Order
Gets Purchase Order
get
https://api.retailexpress.com.au/v2.1/purchaseorders/{id}
Query Parameters
include_itemsboolean
Include items
Path Parameters
idinteger(int32)required
Purchase Order id
Example:10000
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
application/json
Returns found Purchase Order
PurchaseOrder
Purchase order model
* Additional properties are NOT allowed.
idinteger | null(int32)
Purchase order id
external_purchase_order_idstring | null
External purchase order id
reference_purchase_order_idinteger | null(int32)
Reference purchase order id
statusobject
Purchase order status model
* Additional properties are NOT allowed.
Show Child Parameters
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
supplierobject
Purchase order supplier model
* Additional properties are NOT allowed.
Show Child Parameters
sailedstring | null(date-time)
Sailed date
deposit_duestring | null(date-time)
Deposit due date
balance_duestring | null(date-time)
balance due date
supplier_commentsstring | null
Supplier comments
purchase_order_templatestring | null
Purchase order template
update_linked_transfers_on_receipt_tostring | null
Update linked transfers on receipt to
Avalable values are: qty_allocated or Allocate, qty_picked or Pick, qty_dispatched or Dispatch
Can be updated only when PO has status Incomplete, OnOrder, ReceivingInProgress
autoreplenishment_invoice_numberstring | null
Autoreplenishment invoice number
autoreplenishment_invoice_referencestring | null
Autoreplenishment invoice reference
original_departurestring | null(date-time)
Original departure
etastring | null(date-time)
Eta
container_numberstring | null
Container number
deliver_tostring | null
Deliver to
shipping_statusobject
Purchase order shipping status model
* Additional properties are NOT allowed.
Show Child Parameters
shipping_typeobject
Purchase order shipping type model
* Additional properties are NOT allowed.
Show Child Parameters
shipping_portobject
Purchase order shipping port model
* Additional properties are NOT allowed.
Show Child Parameters
country_of_originobject
* Additional properties are NOT allowed.
Show Child Parameters
shipping_termsstring | null
Shipping terms
payment_termsstring | null
Payment terms
invoice_documentsstring | null
Invoice documents
packing_list_documentsstring | null
Packing list documents
packing_declaration_documentsstring | null
Packing declaration documents
fumes_documentsstring | null
Fumes documents
certificate_of_original_documentsstring | null
Certificate of original documents
bill_of_lading_documentsstring | null
Bill of lading documents
internal_commentsstring | null
Internal comments
supplier_invoice_numberstring | null
Supplier Invoice Number
depositnumber | null(double)
Deposit
purchase_order_itemsarray | null[object]
Purchase Order Item
* Additional properties are NOT allowed.
Show Child Parameters
total_weightnumber | null(double)
Total weight
total_cubicnumber | null(double)
Total cubic
total_quantity_special_orderinteger | null(int64)
Total quantity special order
total_quantity_receivedinteger | null(int64)
Total quantity received
total_quantity_remaininginteger | null(int64)
Total quantity remaining
total_quantity_cancelledinteger | null(int64)
Total quantity cancelled
total_quantity_orderedinteger | null(int64)
Total quantity ordered
total_supplier_buy_exnumber | null(double)
Total supplier buy ex
total_quantity_linked_transfersinteger(int32)
Total quantity linked transfers
fob_currencyobject
* Additional properties are NOT allowed.
Show Child Parameters
created_onstring | null(date-time)
Created on
modified_onstring(date-time)
Modified on
sent_onstring | null(date-time)
Sent on
received_onstring | null(date-time)
Received on
created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject
* Additional properties are NOT allowed.
Show Child Parameters
get/purchaseorders/{id}
Path Parameters
Query Parameters
Headers
application/json