Create Order

This operation creates a new order in the Order Management System. This API accepts customer details, item information, pricing, and shipping-related data and generates a unique order identifier. The created order is initialized in an unfulfilled state and can be updated or progressed through subsequent OMS operations.

SecuritybearerAuth

Request

Request Body schema: application/json

orderNumber required	string The unique identifier for the order.
	object An optional message added to an order, such as a gift note or a short greeting.
	Array of objects Additional metadata that needs to be stored for this order can be added here.
	object (Charges) Financials and tender type information for the order.
	object (ShippingReferences) Contains additional reference fields that can be passed with the request.
	object End customer (buyer) profile for communication.
required	object The address from where the order is generated.
required	object The address where the order is destined to.
	Array of objects (Item) List of items in the order. To create an order, minimum one item is required. Note: Either use customProductId or item properties individually.
	Array of objects A list of additional addresses associated with the order.
	object (ShippingPreferences) Shipping-related preferences for an order.

Responses

200

The Order has been created Successfully.

400

Invalid request

401

The request could not be authorized

500

The request could not be completed due to an internal error

post/api/v1/orders

Request samples

application/json

{"orderNumber": "ORD12346",
"orderMessage": {"type": "GIFT",
"message": "Happy Birthday! Enjoy your gift."
},
"metadata": [{"name": "costAccountName",
"value": "costAccountName12"
},
{"name": "costAccountId",
"value": "costAccountId12"
},
{"name": "costAccountCode",
"value": "Code12"
}
],
"charges": {"currency": "USD",
"billingStatus": "Paid",
"gmv": 100,
"subTotal": 90,
"totalPaid": 100,
"paymentType": "Credit Card"
},
"shippingReference": {"reference1": "reference1",
"reference2": "reference2",
"reference3": "reference3",
"reference4": "reference4",
"shipperReference": "Shipper123",
"transportationReference": "TransRef2025",
"shippingNotes": "Handle with care"
},
"customerInfo": {"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"customerId": "CUST12345"
},
"fromAddress": {"name": "Warehouse A",
"company": "Company Name",
"addressLine1": "638 Manitoba Ave",
"addressLine2": "Apt 4B",
"addressLine3": "Near City Park",
"cityTown": "Winnipeg",
"stateProvince": "MB",
"postalCode": "R2W 2H2",
"countryCode": "CA",
"phone": "1234567890",
"email": "warehouse@email.com",
"residential": false
},
"toAddress": {"name": "Jane Smith",
"company": "Company ABC",
"addressLine1": "1822 Franklin Street",
"addressLine2": "3010 Summer Street",
"addressLine3": "Near City Park",
"cityTown": "Vancouver",
"stateProvince": "BC",
"postalCode": "V5L 1P8",
"countryCode": "CA",
"phone": "9876543210",
"email": "jane.smith@email.com",
"residential": true
},
"items": [{"customProductId": "string",
"itemId": "SKU12345",
"url": "https://example.com/products/wireless-mouse",
"description": "Wireless mouse with USB receiver",
"hSTariffCode": "847160",
"hSTariffCodeCountry": "US",
"originCountryCode": "US",
"originStateProvince": "",
"quantity": 2,
"unitPrice": 25,
"unitWeight": {"unitOfMeasurement": "OZ",
"weight": 12.5
}
}
],
"additionalAddresses": [{"address": {"addressLine1": "638 Manitoba Ave",
"cityTown": "Winnipeg",
"countryCode": "CA",
"name": "billing name",
"phone": "203-555-1213",
"postalCode": "R2W 2H2",
"company": "Pitney Bowes Inc.",
"stateProvince": "MB"
},
"addressType": "BILLING"
}
],
"shippingPreferences": {"customCarrierCode": "string",
"carrier": "UPS",
"parcelId": "PKG-001",
"parcelType": "PKG",
"service": "2DA",
"parcel": {"length": 2,
"width": 1,
"height": 1,
"dimUnit": "IN",
"weightUnit": "OZ",
"weight": 2
},
"specialServices": [{"inputParameters": [{"name": "INPUT_VALUE",
"value": "100"
}
],
"specialserviceId": "Ins"
}
],
"customs": {"customsInfo": {"certificateNumber": "98788877",
"comments": "string",
"currencyCode": "USD",
"customsDeclaredValue": 0,
"EELPFC": "NOEEI 30.36",
"fromCustomsReference": "11111",
"importerCustomsReference": "987654",
"insuredAmount": 0,
"invoiceNumber": "001189223",
"licenseNumber": "456ABC123",
"reasonForExport": "GIFT"
}
},
"shipmentProvider": {"shipViaCode": "shipViaCode123"
},
"shipmentOptions": {"packageDescription": "testpackageDescription"
},
"dateOfShipment": "2026-01-30"
}
}

Response samples

application/json

{"orderId": "PBcffM5ruasQ",
"orderNumber": "ORD12346",
"status": "Success",
"transactionCreateDate": "2026-01-30T10:53:24.554Z"
}