Submit a new order

What this endpoint does

This endpoint creates a final order in OpenBorder’s Order Management System (OMS) once your customer has selected their shipping option and agreed to the calculated landed cost.
This call ensures the order is registered in OpenBorder’s OMS so we can:

  • Record the exact duties & taxes to be remitted to authorities
  • Guarantee the correct shipping rate is linked to the shipment
  • Generate accurate billing and settlement for your international shipments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Source system from which the order originated.

number
required

Reference ID from the source system. This is the unique identifier to reference the order on subsequent calls and cannot be updated.

string
required

Unique ID for this tax calculation request provided when calculating landed cost.

string
required

Timestamp in ISO format when the order was created in the source system.

string
required

Timestamp in ISO format when the order was last updated in the source system.

billing_address
object

Billing address for the order.

number
required

Total amount of the order including all charges, taxes, duties, discounts and refund in major currency units (e.g., dollars). Up to two decimal places are allowed.

shipments
array of objects
required

Shipments on the order. Each must include a tax_request_id from the tax calculation step.

shipments*
custom_properties
object | null

Optional custom metadata or structured properties. Object max. size is 4 KB.

Headers
string
required

OpenBorder merchant API token

Responses
204

Order successfully created. No content returned.

400

Invalid order payload received.

401

Invalid authorization token received.

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json