Skip to main content
PUT
Update

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-company
string
Example:

"{{companyId}}"

Path Parameters

id
string
required

Body

application/json
amount
number
Example:

15000

amount_due
number
Example:

15000

billing
object
bills
any[]
Example:
calendar_event_id
unknown
company
object
company_id
string
Example:

"01hqydxwtxdj3kmzp3bz7jk73g"

created_at
string
Example:

"2025-09-18T00:00:00.000000Z"

credit_code
string
Example:

"701"

currency
string
Example:

"XAF"

custom_fields
any[]
Example:
customer_id
string
Example:

"01k76xt7v9aq02r798c0c9nqhf"

debit_code
string
Example:

"4111"

deleted_at
unknown
deliveries
any[]
Example:
delivery
unknown
due_at
unknown
expires_at
unknown
id
string
Example:

"01k76xt7z87katy392s6w335cp"

invoices_count
number
Example:

0

medias
any[]
Example:
metadata
object
order_products
object[]
Example:
pickup_location
unknown
pickup_location_id
unknown
private_medias
any[]
Example:
products
object[]
Example:
reference
string
Example:

"#ORDER_1174"

returns_count
number
Example:

0

revenue_type
string
Example:

"PRODUCTS"

shipping
object
shipping_fee
unknown
shipping_fee_id
unknown
shop_id
string
Example:

"01k1amypzhgs7fngfx1r9d37pn"

signature
unknown
source
string
Example:

"EXCEL"

state
number
Example:

1

status
string
Example:

"pending"

updated_at
string
Example:

"2025-10-10T11:24:05.000000Z"

user_id
string
Example:

"01k1amyqgjje8sknkzpm78qv6x"

Response

200 - application/json

200 OK

addresses
object[]
Example:
amount
number
Example:

80000

amount_due
number
Example:

80000

billing
object
bills
any[]
Example:
calendar_event_id
unknown
company
object
company_id
string
Example:

"01hqydxwtxdj3kmzp3bz7jk73g"

created_at
string
Example:

"2025-09-18T00:00:00.000000Z"

credit_code
string
Example:

"701"

currency
string
Example:

"XAF"

custom_fields
any[]
Example:
customer
unknown
customer_id
unknown
customer_orders_count
number
Example:

0

debit_code
string
Example:

"4111"

deleted_at
unknown
deliveries
any[]
Example:
delivery
unknown
discounts
any[]
Example:
due_at
unknown
expires_at
unknown
id
string
Example:

"01k76xt7z87katy392s6w335cp"

invoices
any[]
Example:
invoices_count
number
Example:

0

medias
any[]
Example:
metadata
object
order_products
object[]
Example:
pickup_location
unknown
pickup_location_id
unknown
private_medias
any[]
Example:
products
object[]
Example:
reference
string
Example:

"#ORDER_1174"

returns
any[]
Example:
returns_count
number
Example:

0

revenue_type
string
Example:

"PRODUCTS"

shipping
object
shipping_fee
unknown
shipping_fee_id
unknown
shop
object
shop_id
string
Example:

"01k1amypzhgs7fngfx1r9d37pn"

signature
unknown
source
string
Example:

"EXCEL"

state
number
Example:

1

status
string
Example:

"pending"

subscriptions
any[]
Example:
taxes
any[]
Example:
updated_at
string
Example:

"2025-10-10T11:27:08.000000Z"

user
object
user_id
string
Example:

"01k1amyqgjje8sknkzpm78qv6x"