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.
API Specifications
/Returns Management
/- Real Time Inventory Receipt API
Create Inventory Receipt
Drop Ship
Introduction
Post Confirmation:
Post Cancellation:
Post Partial Cancellation:
Failure Handling
POST a Drop Shipment Confirmation
POST a Drop Shipment Cancellation
POST a Drop Shipment Partial Cancellation
Disposition Update
Introduction
Failure Handling
POST a unit's disposition update
Final Disposition
Introduction
Failure Handling
POST a unit's final disposition
Outbound ASN
Failure Handling
Outbound ASN Event
Real Time Inventory Recei...
Real Time Inventory Receipt API (1.0.0)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.optoro.com/_mock/openapi/inventory_receipt/openapi
Bodyapplication/jsonrequired
The program identifier under which this inventory was received. This value will be provided by your implementation team.
Example: "returns"
The reference number for the ASN this item is being received against.
Example: "SO00001234"
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.
Example: "SI1ZAAAAAAZZ97764680"
Identifier for the to location. The internal OptiTurn warehouse identifier where this unit was received. This will be provided by your implementation team.
Example: 1352
The carton.identifier this unit was received in, if present on the inbound ASN.
Example: "CTAA1234567"
The line_identifer in the ASN which this unit was received against.
Example: 123456789
If present, the line in the reference which this unit was received against e.g. an RMA item.
Example: 1
The serial number for this unit, if provided on the inbound ASN or collected.
Example: 12345678910001
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"
Example: "N"
The channel this unit was assigned at receiving. This can change throughout the workflow.
Example: "blinq"
The reason for a return, if provided on the inbound ASN or collected.
Example: "not like"
The merchant passed on the inbound ASN. Typically the inventory owner.
Example: "Merchant Name"
The concept passed on the inbound ASN. Typically a brand of the merchant.
Example: "Brand"
Amazon Serial Identification Number. A 10-character alphanumeric unique identifier, which can be used to identify the product at receiving.
Example: 120029872
Tracking number scanned at receiving. This may differ from the one provided on the Inbound ASN in the event of an exception scenario.
Example: 123012300123033
Initial storage location in Optiturn where the unit is placed after receiving.
Example: "Pallet 1"
The details.unit.identifier passed on the inbound ASN OR the client LPs if present.
Example: 123456891011
- Mock serverhttps://developer.optoro.com/_mock/openapi/inventory_receipt/openapi/inventory_receipt
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.optoro.com/_mock/openapi/inventory_receipt/openapi/inventory_receipt \
-H 'Content-Type: application/json' \
-d '{
"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"
}'