The Forward Order API is used to inform Optoro of new orders from your Forward order system.
API Specifications
/Returns Management
//
Forward Orders (DEPRECATE...
Forward Orders (DEPRECATED) (1.0.0)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.optoro.com/_mock/openapi/forward_orders/openapi
Production
https://orders.optiturn.com
Sandbox
https://orders.sandbox.optiturn.com
Staging
https://orders.stage.optiturn.com
Bodyapplication/jsonrequired
An array with one or more forward orders. Optoro recommends batching orders, where total payload size is not to exceed 10KB.
A unique order identifier for this order. Must be a unique value per order.
Example: "1193Z93LL"
A unique identifier for the 'concept' or 'brand' the order was placed from. This allows a client to delineate orders across different concepts or brands when the client’s parent company has multiple retail brands.
Example: "Best Brand"
The postal / zip code portion of the order's shipping address.
Example: 55127
iso8601 formatted date string representing when the order was created (YYYY-MM-DDT00:00:00).
Example: "2023-09-11T00:00:00.000Z"
An array of order items in the order.
ID for individual item within the Order. Must be a unique value per item.
Example: "f34d97a7-f175-4a52-9e94-405631adbb3e4"
UPC that represents the product for this order item.
Example: 848709033673
An identifier which matches the client catalog and represents the product for this order item.
Example: "0123445667A"
The number of units within the order for each SKU (or UPC).
Example: 2
The tracking number for the package containing this order item. This allows operations to scan the tracking number for undeliverable items.
Example: "1Z999AA10123456784"
The return tracking number for the package containing this order item. This allows operations to scan the tracking number for items returned by the customer.
Example: 2396343519220426000
ID used to track item that was drop-shipped.
Example: 1872
iso8601 formatted date string (YYYY-MM-DDT00:00:00) representing when the order was shipped.
Example: "2023-08-20T04:00:00Z"
iso8601 formatted date string (YYYY-MM-DDT00:00:00) representing when the order item is no longer eligible for return.
Example: "2023-08-15T04:00:00Z"
- Mock serverhttps://developer.optoro.com/_mock/openapi/forward_orders/openapi/forward_orders
- Productionhttps://orders.optiturn.com/forward_orders
- Sandboxhttps://orders.sandbox.optiturn.com/forward_orders
- Staginghttps://orders.stage.optiturn.com/forward_orders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://developer.optoro.com/_mock/openapi/forward_orders/openapi/forward_orders \
-H 'Content-Type: application/json' \
-d '{
"orders": [
{
"identifier": "1193Z93LL",
"concept": "Best Brand",
"postal_code": 55127,
"created_at": "2023-09-11T00:00:00.000Z",
"items": [
{
"identifier": "f34d97a7-f175-4a52-9e94-405631adbb3e4",
"upc": 848709033673,
"sku": "0123445667A",
"quantity": 2,
"tracking_number": "1Z999AA10123456784",
"reverse_tracking_number": 2396343519220426000,
"dropship_identifier": 1872,
"shipped_date": "2023-08-20T04:00:00Z",
"return_policy_end_date": "2023-08-15T04:00:00Z",
"labels": [
{
"type": "barcode",
"name": "title",
"value": 10231030023
}
]
}
]
}
]
}'Response
application/json
{ "message": "Success" }