Forward Orders (DEPRECATED) (1.0.0)

Download OpenAPI specification:Download

The Forward Order API is used to inform Optoro of new orders from your Forward order system.

Create/Update Forward Orders.Deprecated

The request payload looks the same for both. Updates can modify the contents of an order and its order items. Updates can also add order items to an order. Orders and order items cannot be deleted.

Request

Request Body schema: application/json

required

Array of objects (Order)

An array with one or more forward orders. Optoro recommends batching orders, where total payload size is not to exceed 10KB.

Array

identifier

required

string

A unique order identifier for this order. Must be a unique value per order.

concept

string

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.

postal_code

string

The postal / zip code portion of the order's shipping address.

created_at

string

iso8601 formatted date string representing when the order was created (YYYY-MM-DDT00:00:00).

required

Array of objects (Item)

An array of order items in the order.

Array

identifier

required

string

ID for individual item within the Order. Must be a unique value per item.

upc

required

string

UPC that represents the product for this order item.

sku

required

string

An identifier which matches the client catalog and represents the product for this order item.

quantity

required

integer

The number of units within the order for each SKU (or UPC).

tracking_number

string

The tracking number for the package containing this order item. This allows operations to scan the tracking number for undeliverable items.

reverse_tracking_number

string

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.

dropship_identifier

string

ID used to track item that was drop-shipped.

shipped_date

string

iso8601 formatted date string (YYYY-MM-DDT00:00:00) representing when the order was shipped.

return_policy_end_date

string

iso8601 formatted date string (YYYY-MM-DDT00:00:00) representing when the order item is no longer eligible for return.

Array of objects (Label)

Optional, labels used for clients to be able to print a custom barcode from the rework tool.

Array

type required	string Label type, allowed values are barcode or text
name required	string Label name, used with type to add a configurable barcode or text field name
value required	string The corresponding value of name

Responses

200

Successfully created or update order

400

Status code should be returned when there is a bad/unparseable request.

401

The user is not authenticated or not authorized (these have no body).

422

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

500

Status code should be returned when there is a server error.

502

Status code should be returned when Optoro's servers are unavailable.

post/forward_orders

Request samples

Payload

application/json

{"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 samples

application/json

{"message": "Success"
}