receipt

Get list of receipt items by order item

Return a list of receipt items representing individual receiving actions.

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
order_by
string

Which field to use when ordering the results.

order_item
integer

The ID of an order item to retrieve receipt items (receiving actions) for.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

Responses
200
Response Schema:
object
Array of objects (ItemRead)
get/api/v3/receipt/items/
Response samples
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a receipt item for an order item

Perform a receiving action for order items within a single purchase order.

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
pass_quantity
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$
fail_quantity
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$
order_item
required
integer

The ID of an order item that you wish to create a receipt for. This will be the id property found in the PO or Order Items responses for this item.

Responses
201
Response Schema:
pass_quantity
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$
fail_quantity
required
string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$
order_item
required
integer

The ID of an order item that you wish to create a receipt for. This will be the id property found in the PO or Order Items responses for this item.

post/api/v3/receipt/items/
Request samples
{
  • "pass_quantity": "string",
  • "fail_quantity": "string",
  • "order_item": 0
}
Response samples
{
  • "pass_quantity": "string",
  • "fail_quantity": "string",
  • "order_item": 0
}