Sign in
latestOpenAPI 3.0.22026-08-10312271.6 KB

c5159bc39a84

Orders

Get a single order

get a specific order with all details

get/orders/{orderId}

Path parameters

orderIdinteger required

spreadconnect order id

Response

OK

idinteger

order id from spreadconnect

orderReferenceinteger

order reference from spreadconnect, can be changed after order updates

externalOrderReferencestring

external order reference from merchant (you)

externalOrderNamestring

external order name from merchant (you)

state'NEW' | 'CONFIRMED' | 'PROCESSED' | 'CANCELLED'

order state

phonestring

Phone used for the communication with the customer.

emailstring

Email used for the communication with the customer.

taxType'SALESTAX' | 'VAT' | 'NOT_TAXABLE'

tax type, salestax or vat

customerTaxType'SALESTAX' | 'VAT' | 'NOT_TAXABLE'

tax type, salestax or vat

Example response

{
  "id": 123,
  "orderReference": 5550000,
  "externalOrderReference": "1722995712",
  "externalOrderName": "ORDER-12",
  "orderItems": [
    {
      "orderItemReference": 55000001,
      "externalOrderItemReference": "12810092145",
      "sku": "P1026247707A12S5",
      "price": {
        "amount": 21.56,
        "taxRate": 19,
        "taxAmount": 12.45,
        "currency": "USD"
      },
      "customerPrice": {
        "amount": 21.56,
        "currency": "USD"
      }
    }
  ],
  "shipping": {
    "address": {
      "company": "Example Ltd.",
      "firstName": "Joshua",
      "lastName": "Anderson",
      "street": "1572 Roseytown Rd",
      "streetAnnex": "2nd Floor",
      "city": "Greensburg",
      "country": "US",
      "state": "AL",
      "zipCode": "15601"
    },
    "fromAddress": {
      "company": "Example Ltd.",
      "firstName": "Joshua",
      "lastName": "Anderson",
      "street": "1572 Roseytown Rd",
      "streetAnnex": "2nd Floor",
      "city": "Greensburg",
      "country": "US",
      "state": "AL",
      "zipCode": "15601"
    },
    "type": {
      "id": "29",
      "company": "DHL",
      "name": "International Standard",
      "description": "No tracking provided. May be subject to import taxes, customs, and duties upon delivery."
    },
    "price": {
      "amount": 21.56,
      "taxRate": 19,
      "taxAmount": 12.45,
      "currency": "USD"
    },
    "customerPrice": {
      "amount": 21.56,
      "currency": "USD"
    }
  },
  "billingAddress": {
    "company": "Example Ltd.",
    "firstName": "Joshua",
    "lastName": "Anderson",
    "street": "1572 Roseytown Rd",
    "streetAnnex": "2nd Floor",
    "city": "Greensburg",
    "country": "US",
    "state": "AL",
    "zipCode": "15601"
  },
  "phone": "+49 1520 1234567",
  "email": "joshua.anders@protonmail.ch",
  "price": {
    "amount": 21.56,
    "taxRate": 19,
    "taxAmount": 12.45,
    "currency": "USD"
  }
}