Path parameters

• orderIncrementId string Required

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • increment_id string Required
  • created_at string Required
  • updated_at string Required
  • items array[object] Required
    Hide items attributes Show items attributes object

    • sku string Required

      SKU

    • parent_sku string

      Parent SKU

    • qty_ordered integer Required

      Quantity ordered

    • item_price_inc_tax number Required

      Price of single item including VAT

    • row_total_inc_tax number Required

      Price of order line (items X quantity) including VAT

    • manufacturer string

      Manufacturer

    • size string Required

      Size

    • mpn string

      Manufacturer product number

  • shipping_address object Required
    Hide shipping_address attributes Show shipping_address attributes object

    • first_name string Required

      Firstname

    • last_name string Required

      Lastname

    • email string Required

      Email

    • telephone string Required

      Telephone. Needs to be in international format +XXXXXXXXXXX.

    • street string Required

      Street

    • house_number string Required

      House number

    • postcode string Required

      Postcode

    • city string Required

      City

    • region_code string

      Region code

    • country_id string

      Country id. Needs to a ALPHA-2 ISO 3166 country code.

    • company_name string

      Company name

  • billing_address object Required
    Hide billing_address attributes Show billing_address attributes object

    • first_name string Required

      Firstname

    • last_name string Required

      Lastname

    • email string Required

      Email

    • telephone string Required

      Telephone. Needs to be in international format +XXXXXXXXXXX.

    • street string Required

      Street

    • house_number string Required

      House number

    • postcode string Required

      Postcode

    • city string Required

      City

    • region_code string

      Region code

    • country_id string

      Country id. Needs to a ALPHA-2 ISO 3166 country code.

    • company_name string

      Company name

  • status string
  • shipping_price number
  • subtotal number
  • grand_total number
  • currency string
  • is_invoiced boolean Required
  • is_shipped boolean Required
• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace