Search
K
Retail Express API 2.1

Searches Purchase Order Receipt Items by Purchase Order Receipt id and other parameters

Searches Purchase Order Receipt Items by Purchase Order Receipt id and other parameters

get
https://api.retailexpress.com.au/v2.1/purchaseorderreceipts/{id}/purchaseorderreceiptitems

Query Parameters

filter_bystring | null

Filter by.

Available field name values: id, product_id, product_supplier_sku, product_manufacturer_sku, product_supplier_sku2, product_short_description, product_type, size mapped to value name, colour mapped to value name, brand mapped to value name, season mapped to value name, attribute:id, plu, purchase_order_receipt_id, purchase_order_item_id, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, quantity_expected, quantity_received, quantity_faulty, quantity_invoiced, buy_price_ex, supplier_buy_ex, unit_discount_ex, total_buy_price_ex, cogs_ex, bin, include_tax, variance_reason_id, variance_reason_name, variance_action, notes, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc, direct_costs_ex, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end,quantity_received_variance,total_tax,total_buy_price_inc.

In string values: ‘|’ and ‘,’ characters have to be escaped with slash, i.e. ‘\,’ ‘\|’

For operators that support multiple values (in, notin): multiple values are delimited using ‘|’ character

Available operators:

eq - Equal

neq - Not equals

lt - Less

lte - Less or equal

gt - Greater

gte - Greater or equal

in - In

notin - Not In

contains - Contains

isnull - Is Null

isnullorempty - Is Null Or Empty

isnotnull - Is Not Null

startswith - Starts with

endswith - Ends with

doesnotcontain - Does not contain

For non-nullable fields operators isnull and isnotnull are unavailable

For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable

For strings operators: lt, lte, gt, gte are unavailable

Example: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432, attribute:101:isnotnull, attribute:101:eq:Custom Attribute Value 123

order_bystring | null

Order by.

Available field name values: id, product_id, product_supplier_sku, product_manufacturer_sku, product_supplier_sku2, product_short_description, product_type, size, colour, brand, season, attribute:id, purchase_order_receipt_id, purchase_order_item_id, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, quantity_expected, quantity_received, quantity_faulty, quantity_invoiced, buy_price_ex, supplier_buy_ex, unit_discount_ex, total_buy_price_ex, cogs_ex, bin, include_tax, total_tax, total_buy_price_inc, variance_reason_id, variance_reason_name, variance_action, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc, direct_costs_ex, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end.

Available direction values: asc, desc.

Example: id asc, product_supplier_sku desc, attribute:101

selectstring | null

Select fields.

Available field name values: id, product_id, quantity_expected, quantity_received

Example: id

page_numberinteger(int32)

>= 1<= 100000

page_sizeinteger(int32)

>= 1<= 2147483647

Path Parameters

idinteger(int32)required

Purchase Order Receipt id

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

application/json

Paging Response with Purchase Order Receipt Items data

PurchaseOrderReceiptItem.PagingResponse

* Additional properties are NOT allowed.
dataarray | null[object]

Purchase order receipt item

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/purchaseorderreceipts/{id}/purchaseorderreceiptitems
 
application/json

Gets specific Purchase Order Receipt Item by unique Purchase Order Receipt id and Purchase Order Receipt Item id

Gets specific Purchase Order Receipt Item by unique Purchase Order Receipt id and Purchase Order Receipt Item id

get
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 )

Response

application/json

Returns found 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

get/purchaseorderreceipts/{id}/purchaseorderreceiptitems/{item_id}
 
application/json

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

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 )

Response

Purchase Order Receipt Item was deleted

delete/purchaseorderreceipts/{id}/purchaseorderreceiptitems/{item_id}
 

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

Purchase Order Item model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

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}

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

Purchase Order Receipt discount model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

Success

post/purchaseorderreceipts/{id}/discount

Body

{}