You can use this method to create a new order or update an existing order. If the orderKey is specified, ShipStation will attempt to locate the order with the specified orderKey. If found, the existing order with that key will be updated. If the orderKey is not found, a new order will be created with that orderKey.
For split orders, see the mergedOrSplit property in Advanced Options. This property (key) is always required for merged or split orders.
This call does not currently support partial updates. The entire resource must be provided in the body of the request.
NOTE Only orders in an open status in ShipStation (
awaiting_payment,awaiting_shipment, andon_hold) can be updated through this method. Orders in thecancelledandshippedstates may not be updated. The body of this request should specify an Order object.
- Production Serverhttps://ssapi.shipstation.com/orders/createorder
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://ssapi.shipstation.com/orders/createorder \
-H 'Content-Type: application/json' \
-d '{
"orderNumber": "TEST-ORDER-API-DOCS",
"orderKey": "0f6bec18-3e89-4771-83aa-f392d84f4c74",
"orderDate": "2015-06-29T08:46:27.000Z",
"paymentDate": "2015-06-29T08:46:27.000Z",
"shipByDate": "2015-07-05T00:00:00.000Z",
"orderStatus": "awaiting_shipment",
"customerUsername": "headhoncho@whitehouse.gov",
"customerEmail": "headhoncho@whitehouse.gov",
"billTo": {
"name": "The President",
"country": "US"
},
"shipTo": {
"name": "The President",
"company": "US Govt",
"street1": "1600 Pennsylvania Ave",
"street2": "Oval Office",
"city": "Washington",
"state": "DC",
"postalCode": "20500",
"country": "US",
"phone": "555-555-5555",
"residential": true
},
"items": [
{
"lineItemKey": "vd08-MSLbtx",
"sku": "ABC123",
"name": "Test item #1",
"quantity": 2,
"unitPrice": 99.99,
"weight": {
"value": 24,
"units": "ounces"
}
}
],
"amountPaid": 218.73,
"taxAmount": 5,
"shippingAmount": 10,
"customerNotes": "Please ship as soon as possible!",
"requestedShippingService": "Priority Mail"
}'- Order Model
- See all order endpoints in the Full API Reference