Get an order with its line items

GET

/api/v1/orders/{uuid}

const url = 'https://example.com/api/v1/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

uuid

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

object

uuid

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

human_order_id

required

string

nullable

placed_at

required

string format: date-time

nullable

currency

required

string

payment_status

required

string

Allowed values: paid unpaid refunded cancelled pending

dispatch_status

required

string

nullable

Allowed values: pending processing shipped delivered cancelled

tracking_code

required

string

nullable

items

required

Array<object>

object

uuid

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

release_group

required

string format: uuid

nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

release_title

required

string

nullable

ean

required

string

nullable

status

required

string

quantity

required

integer

>= -9007199254740991 <= 9007199254740991

unit_amount

required

integer

nullable >= -9007199254740991 <= 9007199254740991

total_amount

required

integer

nullable >= -9007199254740991 <= 9007199254740991

vat_amount

required

integer

nullable >= -9007199254740991 <= 9007199254740991

royalty_amount

required

integer

nullable >= -9007199254740991 <= 9007199254740991

royalty_rate

required

integer

nullable >= -9007199254740991 <= 9007199254740991

product_type

required

string

nullable

totals

required

object

royalty

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "payment_status": "paid",
  "dispatch_status": "pending"
}

400

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "code": "VALIDATION_ERROR"
}

401

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "code": "VALIDATION_ERROR"
}

404

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "code": "VALIDATION_ERROR"
}

429

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "code": "VALIDATION_ERROR"
}

500

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "code": "VALIDATION_ERROR"
}

503

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "code": "VALIDATION_ERROR"
}