API resource
Store orders and customers
Read and manage the store's orders in one format for every platform (line items with prices, discounts and tax, shipping, billing details, payment status, refunds), refund, edit or cancel an order, create draft orders and send their invoice, and look up customers. Needs the orders and customers permissions the merchant approves on the store (see Get a store). Pick the store with accountId.
List orders
/v1/commerce/ordersWorks on: Shopify, WooCommerce
Query parameters
accountIdstringrequiredConnected store account id.
limitintegercursorstringcreatedAfterstringcreatedBeforestringupdatedAfterstringOnly orders changed after this time, oldest change first.
customerIdstringOnly this customer's orders (customer.id on an order, or id from the customers endpoints).
emailstringOnly orders placed with this email. Shopify only; WooCommerce answers 400 platform_not_supported.
numberstringThe order number a buyer quotes, with or without the "#" (number on an order). Shopify only; on WooCommerce the number is the order id, so read GET /v1/commerce/orders/{orderId} (this filter answers 400 platform_not_supported).
curl "https://creatoros-production-5658.up.railway.app/v1/commerce/orders?accountId=acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"orders": [
{
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"number": "#1001",
"status": "pending_payment",
"platformStatus": "string",
"paymentStatus": {},
"platformPaymentStatus": "string",
"currency": "EUR",
"taxesIncluded": true,
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"paidAt": "2026-10-10T00:00:00.000Z",
"cancelledAt": "2026-10-10T00:00:00.000Z",
"cancelReason": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"refundedTotal": {
"amount": "19.90",
"currency": "USD"
},
"discountCodes": [
"string"
],
"paymentMethods": [
"string"
],
"customer": {
"id": "string",
"email": "string",
"phone": "string",
"firstName": "string",
"lastName": "string"
},
"billingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"buyerNote": "string",
"attribution": {
"ready": true,
"firstVisit": {},
"lastVisit": {},
"customAttributes": []
},
"lineItems": [
{}
],
"shippingLines": [
{}
],
"feeLines": [
{}
],
"taxLines": [
{}
],
"refunds": [
{}
],
"fulfillments": [
{}
],
"platformData": {}
}
],
"nextCursor": "string"
}Get an order
/v1/commerce/orders/{orderId}Works on: Shopify, WooCommerce
Path parameters
orderIdstringrequiredPlatform-native order id.
Query parameters
accountIdstringrequiredConnected store account id.
curl "https://creatoros-production-5658.up.railway.app/v1/commerce/orders/123?accountId=acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"order": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"number": "#1001",
"status": "pending_payment",
"platformStatus": "string",
"paymentStatus": {},
"platformPaymentStatus": "string",
"currency": "EUR",
"taxesIncluded": true,
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"paidAt": "2026-10-10T00:00:00.000Z",
"cancelledAt": "2026-10-10T00:00:00.000Z",
"cancelReason": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"refundedTotal": {
"amount": "19.90",
"currency": "USD"
},
"discountCodes": [
"string"
],
"paymentMethods": [
"string"
],
"customer": {
"id": "string",
"email": "string",
"phone": "string",
"firstName": "string",
"lastName": "string"
},
"billingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"buyerNote": "string",
"attribution": {
"ready": true,
"firstVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"lastVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"customAttributes": [
{}
]
},
"lineItems": [
{
"id": "string",
"productId": "8214569812345",
"variantId": "string",
"sku": "string",
"title": "string",
"variantTitle": "string",
"quantity": 0,
"unitPrice": {},
"subtotal": {},
"discountTotal": {},
"total": {},
"taxLines": []
}
],
"shippingLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"feeLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"taxLines": [
{
"title": "TVA 20%",
"ratePercent": 0,
"amount": {}
}
],
"refunds": [
{
"id": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"note": "string",
"amount": {},
"lineItems": []
}
],
"fulfillments": [
{
"id": "string",
"carrierName": "string",
"trackingNumber": "string",
"trackingUrl": "string",
"deliveryStatus": "pending",
"platformDeliveryStatus": "string",
"estimatedDeliveryAt": "2026-10-10T00:00:00.000Z",
"inTransitAt": "2026-10-10T00:00:00.000Z",
"deliveredAt": "2026-10-10T00:00:00.000Z"
}
],
"platformData": {}
}
}Update an order's shipping address
/v1/commerce/orders/{orderId}Works on: Shopify, WooCommerce
Path parameters
orderIdstringrequiredPlatform-native order id.
Body
accountIdstringrequiredConnected store account id.
shippingAddressobjectrequiredcurl -X PATCH "https://creatoros-production-5658.up.railway.app/v1/commerce/orders/123" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
}
}'{
"order": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"number": "#1001",
"status": "pending_payment",
"platformStatus": "string",
"paymentStatus": {},
"platformPaymentStatus": "string",
"currency": "EUR",
"taxesIncluded": true,
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"paidAt": "2026-10-10T00:00:00.000Z",
"cancelledAt": "2026-10-10T00:00:00.000Z",
"cancelReason": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"refundedTotal": {
"amount": "19.90",
"currency": "USD"
},
"discountCodes": [
"string"
],
"paymentMethods": [
"string"
],
"customer": {
"id": "string",
"email": "string",
"phone": "string",
"firstName": "string",
"lastName": "string"
},
"billingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"buyerNote": "string",
"attribution": {
"ready": true,
"firstVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"lastVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"customAttributes": [
{}
]
},
"lineItems": [
{
"id": "string",
"productId": "8214569812345",
"variantId": "string",
"sku": "string",
"title": "string",
"variantTitle": "string",
"quantity": 0,
"unitPrice": {},
"subtotal": {},
"discountTotal": {},
"total": {},
"taxLines": []
}
],
"shippingLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"feeLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"taxLines": [
{
"title": "TVA 20%",
"ratePercent": 0,
"amount": {}
}
],
"refunds": [
{
"id": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"note": "string",
"amount": {},
"lineItems": []
}
],
"fulfillments": [
{
"id": "string",
"carrierName": "string",
"trackingNumber": "string",
"trackingUrl": "string",
"deliveryStatus": "pending",
"platformDeliveryStatus": "string",
"estimatedDeliveryAt": "2026-10-10T00:00:00.000Z",
"inTransitAt": "2026-10-10T00:00:00.000Z",
"deliveredAt": "2026-10-10T00:00:00.000Z"
}
],
"platformData": {}
}
}Refund an order
/v1/commerce/orders/{orderId}/refundsWorks on: Shopify, WooCommerce
Path parameters
orderIdstringrequiredPlatform-native order id.
Body
accountIdstringrequiredConnected store account id.
lineItemsobject[]shippingobjectRefund the shipping: { "full": true } for what is left of it, or { "amount": "5.00" } for part of it.
amountstringRefund this much money instead of what the lines and shipping are worth, for a goodwill refund or a partial one. Taken from the order's payments in order, up to what each can still refund.
currencystringThe currency your amounts are in. Refused (400) unless it is the one the buyer paid in, which every refund amount uses.
notestringKept on the refund, visible to staff.
notifyCustomerbooleanEmail the buyer about the refund.
validateOnlybooleanReturn the refund the platform would make, without refunding anything.
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/commerce/orders/123/refunds" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H"
}'{
"validateOnly": true,
"refund": {
"amount": {
"amount": "19.90",
"currency": "USD"
},
"maximumRefundable": {
"amount": "19.90",
"currency": "USD"
},
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"tax": {
"amount": "19.90",
"currency": "USD"
},
"shipping": {
"amount": "19.90",
"currency": "USD"
},
"lineItems": [
{
"lineItemId": "string",
"quantity": 0,
"restock": "none",
"amount": {}
}
],
"transactions": [
{
"gateway": "string",
"amount": {}
}
]
}
}Edit an order
/v1/commerce/orders/{orderId}/editsWorks on: Shopify, WooCommerce
Path parameters
orderIdstringrequiredPlatform-native order id.
Body
accountIdstringrequiredConnected store account id.
addobject[]quantitiesobject[]notifyCustomerbooleanstaffNotestringvalidateOnlybooleanReturn the edited totals without changing the order.
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/commerce/orders/123/edits" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H"
}'{
"validateOnly": true,
"order": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"number": "#1001",
"status": "pending_payment",
"platformStatus": "string",
"paymentStatus": {},
"platformPaymentStatus": "string",
"currency": "EUR",
"taxesIncluded": true,
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"paidAt": "2026-10-10T00:00:00.000Z",
"cancelledAt": "2026-10-10T00:00:00.000Z",
"cancelReason": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"refundedTotal": {
"amount": "19.90",
"currency": "USD"
},
"discountCodes": [
"string"
],
"paymentMethods": [
"string"
],
"customer": {
"id": "string",
"email": "string",
"phone": "string",
"firstName": "string",
"lastName": "string"
},
"billingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"buyerNote": "string",
"attribution": {
"ready": true,
"firstVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"lastVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"customAttributes": [
{}
]
},
"lineItems": [
{
"id": "string",
"productId": "8214569812345",
"variantId": "string",
"sku": "string",
"title": "string",
"variantTitle": "string",
"quantity": 0,
"unitPrice": {},
"subtotal": {},
"discountTotal": {},
"total": {},
"taxLines": []
}
],
"shippingLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"feeLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"taxLines": [
{
"title": "TVA 20%",
"ratePercent": 0,
"amount": {}
}
],
"refunds": [
{
"id": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"note": "string",
"amount": {},
"lineItems": []
}
],
"fulfillments": [
{
"id": "string",
"carrierName": "string",
"trackingNumber": "string",
"trackingUrl": "string",
"deliveryStatus": "pending",
"platformDeliveryStatus": "string",
"estimatedDeliveryAt": "2026-10-10T00:00:00.000Z",
"inTransitAt": "2026-10-10T00:00:00.000Z",
"deliveredAt": "2026-10-10T00:00:00.000Z"
}
],
"platformData": {}
},
"edit": {
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"outstanding": {
"amount": "19.90",
"currency": "USD"
},
"lineItems": [
{
"lineItemId": "string",
"variantId": "string",
"title": "string",
"quantity": 0,
"unitPrice": {}
}
]
}
}Cancel an order
/v1/commerce/orders/{orderId}/cancelWorks on: Shopify, WooCommerce
Path parameters
orderIdstringrequiredPlatform-native order id.
Body
accountIdstringrequiredConnected store account id.
reasonstringrequiredrefundbooleanRefund the payments to the original methods. Authorized payments are voided either way.
restockbooleannotifyCustomerbooleanstaffNotestringVisible to staff only.
curl -X POST "https://creatoros-production-5658.up.railway.app/v1/commerce/orders/123/cancel" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"reason": "customer"
}'{
"order": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"number": "#1001",
"status": "pending_payment",
"platformStatus": "string",
"paymentStatus": {},
"platformPaymentStatus": "string",
"currency": "EUR",
"taxesIncluded": true,
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"paidAt": "2026-10-10T00:00:00.000Z",
"cancelledAt": "2026-10-10T00:00:00.000Z",
"cancelReason": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"refundedTotal": {
"amount": "19.90",
"currency": "USD"
},
"discountCodes": [
"string"
],
"paymentMethods": [
"string"
],
"customer": {
"id": "string",
"email": "string",
"phone": "string",
"firstName": "string",
"lastName": "string"
},
"billingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"buyerNote": "string",
"attribution": {
"ready": true,
"firstVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"lastVisit": {
"occurredAt": "2026-10-10T00:00:00.000Z",
"landingUrl": "string",
"referrerUrl": "string",
"source": "instagram",
"sourceType": "string",
"utm": {}
},
"customAttributes": [
{}
]
},
"lineItems": [
{
"id": "string",
"productId": "8214569812345",
"variantId": "string",
"sku": "string",
"title": "string",
"variantTitle": "string",
"quantity": 0,
"unitPrice": {},
"subtotal": {},
"discountTotal": {},
"total": {},
"taxLines": []
}
],
"shippingLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"feeLines": [
{
"id": "string",
"title": "string",
"amount": {},
"discountTotal": {},
"taxLines": []
}
],
"taxLines": [
{
"title": "TVA 20%",
"ratePercent": 0,
"amount": {}
}
],
"refunds": [
{
"id": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"note": "string",
"amount": {},
"lineItems": []
}
],
"fulfillments": [
{
"id": "string",
"carrierName": "string",
"trackingNumber": "string",
"trackingUrl": "string",
"deliveryStatus": "pending",
"platformDeliveryStatus": "string",
"estimatedDeliveryAt": "2026-10-10T00:00:00.000Z",
"inTransitAt": "2026-10-10T00:00:00.000Z",
"deliveredAt": "2026-10-10T00:00:00.000Z"
}
],
"platformData": {}
},
"cancelled": true
}Create a draft order
/v1/commerce/draft-ordersWorks on: Shopify, WooCommerce
Body
accountIdstringrequiredConnected store account id.
customerIdstringThe customer it is for, from the customers endpoints.
emailstringlineItemsobject[]requiredA product variant (variantId) or a custom item (title and price).
discountobjectA discount on the whole draft.
shippingobjectshippingAddressobjectWhere to ship. Without one, the customer's default address is used.
notestringtagsstring[]curl -X POST "https://creatoros-production-5658.up.railway.app/v1/commerce/draft-orders" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"lineItems": [
{
"variantId": "string",
"title": "string",
"price": "25.00",
"quantity": 0,
"taxable": true,
"requiresShipping": true
}
]
}'{
"draftOrder": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"name": "#D12",
"status": "open",
"invoiceUrl": "string",
"invoiceSentAt": "2026-10-10T00:00:00.000Z",
"email": "string",
"customerId": "string",
"note": "string",
"tags": [
"string"
],
"currency": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"lineItems": [
{
"id": "string",
"productId": "8214569812345",
"variantId": "string",
"title": "string",
"variantTitle": "string",
"sku": "string",
"quantity": 0,
"unitPrice": {},
"total": {}
}
],
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"orderId": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"completedAt": "2026-10-10T00:00:00.000Z"
}
}Get a draft order
/v1/commerce/draft-orders/{draftOrderId}Works on: Shopify, WooCommerce
Path parameters
draftOrderIdstringrequiredPlatform-native draft order id.
Query parameters
accountIdstringrequiredConnected store account id.
curl "https://creatoros-production-5658.up.railway.app/v1/commerce/draft-orders/123?accountId=acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"draftOrder": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"name": "#D12",
"status": "open",
"invoiceUrl": "string",
"invoiceSentAt": "2026-10-10T00:00:00.000Z",
"email": "string",
"customerId": "string",
"note": "string",
"tags": [
"string"
],
"currency": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"lineItems": [
{
"id": "string",
"productId": "8214569812345",
"variantId": "string",
"title": "string",
"variantTitle": "string",
"sku": "string",
"quantity": 0,
"unitPrice": {},
"total": {}
}
],
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"orderId": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"completedAt": "2026-10-10T00:00:00.000Z"
}
}Send a draft order invoice
/v1/commerce/draft-orders/{draftOrderId}/invoiceWorks on: Shopify, WooCommerce
Path parameters
draftOrderIdstringrequiredPlatform-native draft order id.
Body
accountIdstringrequiredConnected store account id.
tostringDefaults to the draft's email.
subjectstringcustomMessagestringcurl -X POST "https://creatoros-production-5658.up.railway.app/v1/commerce/draft-orders/123/invoice" \
-H "Authorization: Bearer $CREATOROS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H"
}'{
"draftOrder": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"name": "#D12",
"status": "open",
"invoiceUrl": "string",
"invoiceSentAt": "2026-10-10T00:00:00.000Z",
"email": "string",
"customerId": "string",
"note": "string",
"tags": [
"string"
],
"currency": "string",
"subtotal": {
"amount": "19.90",
"currency": "USD"
},
"discountTotal": {
"amount": "19.90",
"currency": "USD"
},
"shippingTotal": {
"amount": "19.90",
"currency": "USD"
},
"taxTotal": {
"amount": "19.90",
"currency": "USD"
},
"total": {
"amount": "19.90",
"currency": "USD"
},
"lineItems": [
{
"id": "string",
"productId": "8214569812345",
"variantId": "string",
"title": "string",
"variantTitle": "string",
"sku": "string",
"quantity": 0,
"unitPrice": {},
"total": {}
}
],
"shippingAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
},
"orderId": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"completedAt": "2026-10-10T00:00:00.000Z"
}
}List customers
/v1/commerce/customersWorks on: Shopify, WooCommerce
Query parameters
accountIdstringrequiredConnected store account id.
limitintegercursorstringemailstringphonestringsearchstringFree text matched against name, email and phone.
curl "https://creatoros-production-5658.up.railway.app/v1/commerce/customers?accountId=acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"customers": [
{
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"ordersCount": 0,
"totalSpent": {
"amount": "19.90",
"currency": "USD"
},
"tags": [
"string"
],
"note": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"defaultAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
}
}
],
"nextCursor": "string"
}Get a customer
/v1/commerce/customers/{customerId}Works on: Shopify, WooCommerce
Path parameters
customerIdstringrequiredPlatform-native customer id.
Query parameters
accountIdstringrequiredConnected store account id.
curl "https://creatoros-production-5658.up.railway.app/v1/commerce/customers/123?accountId=acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H" \
-H "Authorization: Bearer $CREATOROS_API_KEY"{
"customer": {
"id": "string",
"accountId": "acc_Sh4Vp9Kz2Ny7Tx3Lm1Rc6Wb5Js8Df0Ga4Ue7Ki2Oq3H",
"platform": "shopify",
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"ordersCount": 0,
"totalSpent": {
"amount": "19.90",
"currency": "USD"
},
"tags": [
"string"
],
"note": "string",
"createdAt": "2026-10-10T00:00:00.000Z",
"updatedAt": "2026-10-10T00:00:00.000Z",
"defaultAddress": {
"firstName": "string",
"lastName": "string",
"company": "string",
"phone": "string",
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string"
}
}
}