API Documentation

Orders - Get Orders by ID

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

You'll be able to pull information on the items in the order, the tracking information for the order, the total costs for the order, the billing and shipping addresses, and more metadata.

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": "string",
  "NiceId": "string",
  "SouceId": "string",
  "Items": [
    {
      "Sku": "string",
      "ProductId": "integer",
      "Product": "string",
      "Quantity": "integer",
      "Status": "string",
      "TrackingNumber": "string",
      "TrackingUrl": "string",
      "ShipCarrierName": "string",
      "Price": {
        "Price": "decimal",
        "CurrencyCode": "string",
        "FormattedPrice": "string",
        "CurrencyFormat": "string",
        "CurrencyDigits": "integer"
      },
      "DiscountAmount": {
        "Price": "decimal",
        "CurrencyCode": "string",
        "FormattedPrice": "string",
        "CurrencyFormat": "string",
        "CurrencyDigits": "integer"
      },
      "SourceId": "string",
      "Meta": {
        "Key": "string",
        "Value": "string"
      },
      "Shipments": [
        {
          "TrackingNumber": "string",
          "TrackingUrl": "string",
          "ShipCarrierName": "string"
        }
      ]
    }
  ],
  "Total": {
    "Price": "decimal",
    "CurrencyCode": "string",
    "FormattedPrice": "string",
    "CurrencyFormat": "string",
    "CurrencyDigits": "integer"
  },
  "ShippingTotal": {
    "Price": "decimal",
    "CurrencyCode": "string",
    "FormattedPrice": "string",
    "CurrencyFormat": "string",
    "CurrencyDigits": "integer"
  },
  "DiscountAmount": {
    "Price": "decimal",
    "CurrencyCode": "string",
    "FormattedPrice": "string",
    "CurrencyFormat": "string",
    "CurrencyDigits": "integer"
  },
  "DiscountCode": "string",
  "BillingAddress": {
    "FirstName": "string",
    "LastName": "string",
    "Line1": "string",
    "Line2": "string",
    "City": "string",
    "State": "string",
    "CountryCode": "string",
    "PostalCode": "string",
    "IsBusinessAddress": "boolean",
    "Phone": "string",
    "Email": "string"
  },
  "ShippingAddress": {
    "FirstName": "string",
    "LastName": "string",
    "Line1": "string",
    "Line2": "string",
    "City": "string",
    "State": "string",
    "CountryCode": "string",
    "PostalCode": "string",
    "IsBusinessAddress": "boolean",
    "Phone": "string",
    "Email": "string"
  },
  "Meta": {
    "Key": "string",
    "Value": "string"
  }
}

Next Topic: Update Order Status