API Documentation

Get Order by ID

The GET orders endpoint is used to get information about an Order by ID.

It takes the following arguments:

id - required - Order ID
languageCode - optional, defaults to “en” - the language to have product data returned in

This yields the response:

{
  "Id": "7-73f6321e-e85f-4352-8fbf-abd27b5ee919",
  "NiceId": "Test7-73f",
  "SourceId": "7-73f6321e-e85f-4352-8fbf-abd27b5ee919",
  "Items": [
    {
      "Sku": "PhoneCase-GalaxyNote2-Matte",
      "ProductId": 57,
      "Product": "Phone Cases",
      "Quantity": 1,
      "Status": "Test",
      "Price": {
        "Price": 18.72,
        "CurrencyCode": "USD",
        "FormattedPrice": "$18.72",
        "CurrencyFormat": "${1}",
        "CurrencyDigits": 2
      },
      "DiscountAmount": {
        "Price": 0.00,
        "CurrencyCode": "USD",
        "FormattedPrice": "$0.00",
        "CurrencyFormat": "${1}",
        "CurrencyDigits": 2
      },
      "Meta": {
        
      },
      "Shipments": [
        
      ]
    },
    [...]
  ],
  "Total": {
    "Price": 52.07,
    "CurrencyCode": "USD",
    "FormattedPrice": "$52.07",
    "CurrencyFormat": "${1}",
    "CurrencyDigits": 2
  },
  "ShippingTotal": {
    "Price": 9.29,
    "CurrencyCode": "USD",
    "FormattedPrice": "$9.29",
    "CurrencyFormat": "${1}",
    "CurrencyDigits": 2
  },
  "ShippingAddress": {
    "FirstName": "Gooten",
    "LastName": "Test",
    "Line1": "222 broadway",
    "City": "New York",
    "State": "NY",
    "CountryCode": "US",
    "PostalCode": "10038",
    "Phone": "13123123123",
    "Email": "Test@gooten.com"
  },
  "BillingAddress": {
    "FirstName": "Gooten",
    "LastName": "Test",
    "Line1": "222 broadway",
    "City": "New York",
    "State": "NY",
    "CountryCode": "US",
    "PostalCode": "10038",
    "Phone": "13123123123",
    "Email": "Test@gooten.com"
  }
}

Next Topic: Getting Supported Currencies