Skip to main content
PATCH
cURL

Authorizations

x-api-key
string
header
required

Path Parameters

ID
string
required

ID of the order to update

Body

application/json

Schema for updating an order. All fields are optional except the ID in the path.

friendlyName
string

Human-readable order name (e.g., #1059)

Example:

"#1059"

customer
object
orderTotal
number

Total order amount in Stripe format (e.g., 3995 = $39.95)

Example:

3995

currency
string

Currency code following ISO 4217 standard

Example:

"USD"

items
object[]

Array of ordered items

metadata
object

Additional information in JSON format for AI prompting

Example:
status
enum<string>

Current order status

Available options:
open,
paid,
refunded,
partially_refunded,
cancelled,
disputed,
completed,
shipped,
fulfilled
Example:

"paid"

shipmentStatus
enum<string>

Shipping status

Available options:
none,
confirmed,
in_transit,
out_for_delivery,
attempted_delivery,
ready_for_pickup,
delivered,
failure
Example:

"in_transit"

source
enum<string>

Order source

Available options:
online,
in_store
Example:

"online"

trackingUrl
string

Shipping tracking URL

Example:

"https://tracking.example.com/12345"

address
object

Response

Order updated successfully

id
string
Example:

"be6ed223-19c3-47db-8635-794f856e1956"

contactId
string
Example:

"21f0cf2f-30cd-4e13-9cde-7a3e4e77deff"

externalName
string
Example:

"1001"

externalId
string
Example:

"5210634092624"

firstName
string
Example:

"Jeff"

lastName
string
Example:

"Bezos"

email
string
Example:

"jeff@amazon.com"

phoneNumber
string
Example:

"+15551234"

orderTotal
number
Example:

69995

currency
string
Example:

"eur"

channel
string
Example:

"SHOPIFY"

status
string
Example:

"PAID"

trackingUrl
string
Example:

"https://{{YOUR_SHOPIFY_URL}}.myshopify.com/{{EXTERNAL_ID}}"

createdAt
string
Example:

"2024-11-07T11:57:25.000Z"

updatedAt
string
Example:

"2024-11-07T11:57:25.000Z"

shopId
string
Example:

"{{YOUR_SHOPIFY_URL}}.myshopify.com"