post https://api.openborder.com/api/v1/orders
OrderStatus
type OrderStatus =
| 'pending'
| 'processing'
| 'shipped'
| 'delivered'
| 'cancelled'
| 'refunded'
| 'partially_refunded'
FulfillmentStatus
type FulfillmentStatus =
| 'unfulfilled'
| 'partially_fulfilled'
| 'fulfilled'
OrderItem
{
"quantity": number,
"unit_price": number,
"product_id": string,
"sku": string,
"fulfillment_status": FulfillmentStatus,
"refunded_quantity": number | null,
"refunded_amount": number | null
}
OrderShipping
{
"shipping_rate_id": string,
"shipping_rate": number,
"tracking_number": string | null,
"tracking_url": string | null
}
OrderCustomer
{
"customer_id": string | null,
"email": string,
"phone": string | null,
"first_name": string,
"last_name": string
}
Order
{
"source_order_id": string,
"status": OrderStatus,
"created_at": string,
"updated_at": string,
"caller_app": string | null,
"currency_code": string,
"order_subtotal": number,
"order_discount": number,
"order_tax": number,
"shipping_total": number,
"order_total": number,
"refunded_amount": number,
"customer": OrderCustomer,
"ship_from": Address,
"ship_to": Address,
"billing_address": Address | null,
"items": OrderItem[],
"shipping_rate": OrderShipping[],
"tax_request_id": string | null,
"usd_conversion_rate": number | null,
"notes": string | null,
"tags": string[],
"custom_properties": object | null
}
CreateOrderRequest
Sample Request
{
"source_order_id": "ORD-2023-78945",
"status": "processing",
"created_at": "2023-11-15T09:30:45Z",
"updated_at": "2023-11-15T09:45:22Z",
"caller_app": "ecommerce-platform",
"currency_code": "USD",
"order_subtotal": 145.95,
"order_discount": 10.00,
"order_tax": 12.18,
"shipping_total": 8.99,
"order_total": 157.12,
"refunded_amount": 0.00,
"customer": {
"customer_id": "cust-789123",
"email": "[email protected]",
"phone": "+15551234567",
"first_name": "John",
"last_name": "Doe"
},
"ship_from": {
"country_code": "US",
"province": "CA",
"postal_code": "90001",
"address1": "123 Warehouse Lane",
"address2": "Suite 400",
"city": "Los Angeles",
"name": "Main Distribution Center"
},
"ship_to": {
"country_code": "US",
"province": "NY",
"postal_code": "10001",
"address1": "456 Broadway Ave",
"address2": "Apt 3B",
"city": "New York",
"name": "John Doe"
},
"billing_address": {
"country_code": "US",
"province": "NY",
"postal_code": "10001",
"address1": "456 Broadway Ave",
"address2": "Apt 3B",
"city": "New York",
"name": "John Doe"
},
"items": [
{
"quantity": 1,
"unit_price": 99.99,
"product_id": "prod-12345",
"sku": "SKU-100-BLUE",
"fulfillment_status": "unfulfilled",
"refunded_quantity": 0,
"refunded_amount": 0.00
},
{
"quantity": 2,
"unit_price": 22.98,
"product_id": "prod-67890",
"sku": "SKU-201-RED",
"fulfillment_status": "unfulfilled",
"refunded_quantity": 0,
"refunded_amount": 0.00
}
],
"shipping_rate": [
{
"shipping_rate_id": "shiprate-852",
"shipping_rate": 8.99
}
],
"tax_request_id": "taxreq-963852",
"usd_conversion_rate": 1.00,
"notes": "Customer requested gift wrapping",
"tags": ["holiday_sale", "repeat_customer"],
"custom_properties": {
"marketing_source": "facebook_ads",
"coupon_code": "FALL10"
}
}