Real Time Inventory Receipt API (1.0.0)

Download OpenAPI specification:Download

The Inventory Receipt API allows clients to be notified when a unit is received into Optiturn against an ASN. This requires that an ASN was sent to Optiturn for the inventory.

Create Inventory Receipt

It notifies when a unit is received into Optiturn against an ASN. Endpoint provided by the client to the Optoro account manager.

Request

Request Body schema: application/json

program_identifier

required

string

The program identifier under which this inventory was received. This value will be provided by your implementation team.

asn_number

required

string

The reference number for the ASN this item is being received against.

shipment_identifier

string

A reference number which may be used to identify multiple ASNs which were created against a single Order or RMA. This is the shipment_identifier that was passed on the Inbound ASN.

required

object (From)

identifier required	string The from location for the ASN this receipt is being sent for.
type required	string Type of the from location. Matches the Inbound ASN from.type.

required

object (To)

identifier required	integer Identifier for the to location. The internal OptiTurn warehouse identifier where this unit was received. This will be provided by your implementation team.
type required	string Type of the to location
original_identifier required	string Identifier for the original location. ie Numeric Warehouse ID, Store Number.

carton_identifier

string

The carton.identifier this unit was received in, if present on the inbound ASN.

object (Reference)

type	string Reference type, allowed values are: StockTransferOrder, RA, RMA or ForwardOrder. Enum: "StockTransferOrder" "RA" "RMA" "ForwardOrder"
identifier	string Reference identifier, often used to find the reference during receiving - for example: the RA Number associated with this shipment.
alternate_identifier	string Reference alternate identifier, should be scannable, used to locate the reference during receiving if the main identifier isn't always physically on the carton. Matches reference.alternate_identifier passed in Inbound ASN.

line_identifier

string

The line_identifer in the ASN which this unit was received against.

unit_identifier

required

string

The Optiturn LP.

reference_line_identifier

string

If present, the line in the reference which this unit was received against e.g. an RMA item.

sku

required

string

The SKU for this item.

upc

string

The UPC for this item.

serial_number

string

The serial number for this unit, if provided on the inbound ASN or collected.

initial_condition

required

string

Condition during receiving - values will be one of the following: 'N', 'R', 'A', 'B', 'C', 'X', 'TT'.

Enum: "N" "R" "A" "B" "C" "X" "TT"

initial_channel

required

string

The channel this unit was assigned at receiving. This can change throughout the workflow.

return_reason

string

The reason for a return, if provided on the inbound ASN or collected.

ot_user_login

required

string

The user who received the unit.

merchant

string

The merchant passed on the inbound ASN. Typically the inventory owner.

concept

string

The concept passed on the inbound ASN. Typically a brand of the merchant.

asin

string

Amazon Serial Identification Number. A 10-character alphanumeric unique identifier, which can be used to identify the product at receiving.

tracking_number

string

Tracking number scanned at receiving. This may differ from the one provided on the Inbound ASN in the event of an exception scenario.

location_identifier

string

Initial storage location in Optiturn where the unit is placed after receiving.

client_unit_identifier

string

The details.unit.identifier passed on the inbound ASN OR the client LPs if present.

reject_reason

string

'Empty Box' when a receiver indicates a parcel is empty or clearly at attempt at fraud i.e. a brick.

Responses

200

Success response should return HTTP status code 200 if the API already received the rma info in a prior request.

201

Success response should return HTTP status code 201 for a new rma.

400

Error response will be HTTP status code 400 for other bad/unparseable requests.

401

Error response will be HTTP status code 401 for missing or bad api_key (these have no body).

422

Error response will be HTTP status code 422 for validation errors (missing or invalid fields in this case).

post/inventory_receipt

Request samples

Payload

application/json

{"program_identifier": "returns",
"asn_number": "SO00001234",
"shipment_identifier": "SI1ZAAAAAAZZ97764680",
"from": {"identifier": 22,
"type": "Warehouse"
},
"to": {"identifier": 1352,
"type": "Store",
"original_identifier": 42
},
"carton_identifier": "CTAA1234567",
"reference": {"type": "RMA",
"identifier": 12345,
"alternate_identifier": "OR12345678"
},
"line_identifier": 123456789,
"unit_identifier": 123456891011,
"reference_line_identifier": 1,
"sku": "S123456",
"upc": 12345678905,
"serial_number": 12345678910001,
"initial_condition": "N",
"initial_channel": "blinq",
"return_reason": "not like",
"ot_user_login": "jdoe@email.com",
"merchant": "Merchant Name",
"concept": "Brand",
"asin": 120029872,
"tracking_number": 123012300123033,
"location_identifier": "Pallet 1",
"client_unit_identifier": 123456891011,
"reject_reason": "Empty Box"
}