Skip to content

Get sales order

GET
/V1/salesOrders/{incrementId}

Fetch a single sales order by its order number, including per-item quantities ordered, canceled, assigned to fulfillment orders, shipped, invoiced and refunded.

incrementId
required
string

200 Success.

object
id
required
integer
order_number
required

Order number (increment id).

string
sales_order_number

Channel order number.

string
channel_code
string
status

Order status.

string
assigning_status
string
fulfillment_status
string
payment_status
string
currency_code
string
subtotal
required

Subtotal incl. tax.

number
subtotal_excl_tax
required
number
shipping_amount
required

Incl. tax.

number
shipping_amount_excl_tax
required
number
shipping_tax_amount
required
number
shipping_tax_percent
required
number
grand_total
required
number
grand_total_excl_tax
required
number
tax_amount
required

Tax total.

number
total_qty
required
number
customer_firstname
string
customer_lastname
string
customer_email
string
customer_is_guest
required
boolean
created_at
required
string
updated_at
required
string
payment
object
method_code
required
string
method_name
required
string
shipping
object
method_code
required
string
method_name
required
string
internal_method_code
required
string
customer_note
string
pickup_point_delivery
object
location_id
required
string
location_name
required
string
billing_address
object
firstname
required
string
lastname
required
string
email
required
string
street
required
string
city
required
string
postcode
required
string
region
required
string
country_id
required
string
telephone
required
string
company
required
string
vat_id
required
string
shipping_address
object
firstname
required
string
lastname
required
string
email
required
string
street
required
string
city
required
string
postcode
required
string
region
required
string
country_id
required
string
telephone
required
string
company
required
string
vat_id
required
string
items
required
Array<object>
object
id
required
integer
sku
required
string
erp_sku
string
external_item_id
integer
name
string
qty
required
number
qty_canceled
required
number
qty_invoiced
required
number
qty_shipped
required
number
qty_refunded
required
number
qty_ship_requested
required

Assigned to fulfillment orders.

number
price
required

Price incl. tax, after discount (fulfillment price semantics).

number
price_excl_tax
required
number
price_excl_discount
required

Price incl. tax, before discount.

number
discount_amount
required

Discount incl. tax.

number
row_total
required

Total incl. tax, after discount.

number
row_total_excl_tax
required
number
row_discount_amount
required
number
tax_amount
required

Tax amount.

number
tax_percent
required
number
Example generated
{
"id": 1,
"order_number": "example",
"sales_order_number": "example",
"channel_code": "example",
"status": "example",
"assigning_status": "example",
"fulfillment_status": "example",
"payment_status": "example",
"currency_code": "example",
"subtotal": 1,
"subtotal_excl_tax": 1,
"shipping_amount": 1,
"shipping_amount_excl_tax": 1,
"shipping_tax_amount": 1,
"shipping_tax_percent": 1,
"grand_total": 1,
"grand_total_excl_tax": 1,
"tax_amount": 1,
"total_qty": 1,
"customer_firstname": "example",
"customer_lastname": "example",
"customer_email": "example",
"customer_is_guest": true,
"created_at": "example",
"updated_at": "example",
"payment": {
"method_code": "example",
"method_name": "example"
},
"shipping": {
"method_code": "example",
"method_name": "example",
"internal_method_code": "example",
"customer_note": "example",
"pickup_point_delivery": {
"location_id": "example",
"location_name": "example"
}
},
"billing_address": {
"firstname": "example",
"lastname": "example",
"email": "example",
"street": "example",
"city": "example",
"postcode": "example",
"region": "example",
"country_id": "example",
"telephone": "example",
"company": "example",
"vat_id": "example"
},
"shipping_address": {
"firstname": "example",
"lastname": "example",
"email": "example",
"street": "example",
"city": "example",
"postcode": "example",
"region": "example",
"country_id": "example",
"telephone": "example",
"company": "example",
"vat_id": "example"
},
"items": [
{
"id": 1,
"sku": "example",
"erp_sku": "example",
"external_item_id": 1,
"name": "example",
"qty": 1,
"qty_canceled": 1,
"qty_invoiced": 1,
"qty_shipped": 1,
"qty_refunded": 1,
"qty_ship_requested": 1,
"price": 1,
"price_excl_tax": 1,
"price_excl_discount": 1,
"discount_amount": 1,
"row_total": 1,
"row_total_excl_tax": 1,
"row_discount_amount": 1,
"tax_amount": 1,
"tax_percent": 1
}
]
}

400 Bad Request

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
"message": "example",
"errors": [
{
"message": "example",
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
]
}
],
"code": 1,
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
],
"trace": "example"
}

401 Unauthorized

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
"message": "example",
"errors": [
{
"message": "example",
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
]
}
],
"code": 1,
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
],
"trace": "example"
}

Unexpected error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
"message": "example",
"errors": [
{
"message": "example",
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
]
}
],
"code": 1,
"parameters": [
{
"resources": "example",
"fieldName": "example",
"fieldValue": "example"
}
],
"trace": "example"
}