How can we help?

Overview

This article details how to place, update, retrieve, and delete data from the orders collection using REST API calls. The orders collection contains all order data related to a purchase event. It's a separate collection designed specifically to accommodate data associated with orders. The most common order-related attributes are provided by default as part of the schema.

API set name: orders

Authentication

Cordial's core APIs use HTTPS Basic Authentication (BA). From within the Cordial platform, you can generate an encoded API key for your account and use it for authorization.

• Learn more about Cordial API authentication here.

Related collections

The following collections are associated with the orders collection.

Methods, parameters, and examples

• POST/v2/orders
• GET/v2/orders
• GET/v2/orders/{id}
• PUT/v2/orders/{id}
• DELETE/v2/orders/{id}

POST/v2/orders

• Parameters
• Example JSON requests
• Example request URL

* Required

| ### Base level parameters |

shippingAdress and billingAddress object parameters
- Find out how to work with multiple shipping addresses here

items object parameters
The items object is optional—but, if included, productID, sku, category, and name parameters are required.

discountApplication object parameters
If discountApplication is included, type and amount are required.

Basic example (minimum requirements)

{
  "orderID": "33451",
  "purchaseDate": "2025-01-09T22:47:12+0000",
  "email": "marksmith@example.com"
}

All optional fields included

{
  "orderID": "33451",
  "email": "marksmith@example.com",
  "purchaseDate": "2025-01-09T22:47:12+0000",
  "linkID": "55373eed6c87669bw",
  "mcID": "45:55373eed6c87669bwewewee7:ot:55375ba27ec3343a77ce07ec:1422343949",
  "customerID": "5432225",
  "properties": {
    "color": "red",
    "size": "large",
    "currency": "USD"
  },
  "shippingAddress": {
    "name": "Mark Smith",
    "address": "13130 Silverlake Road",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": 92332,
    "country": "USA"
  },
  "billingAddress": {
    "name": " Mark Smith ",
    "address": "13130 Silverlake Road",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": 92332,
    "country": "USA"
  },
  "items": [
    {
      "productID": "1234abcd",
      "sku": "ssd-2344-15",
      "description": "This shirt is amazing!",
      "category": "Shirts",
      "name": "Awesome Flannel",
      "qty": 1,
      "url": "https://awesomeflannels.com/1234abcd",
      "itemPrice": 129.95,
      "images": [
        "https://awesomeflannels.com/image_1.jpg",
        "https://awesomeflannels.com/image_2.jpg"
      ],
      "tags": [
        "flannels",
        "winter"
      ],
      "properties": {
        "brands": [
          "Cool Brand",
          "Other Cool Brand"
        ],
        "return_date": "2025-07-09T22:47:12+0000"
      },
      "attr": {
        "color": "red",
        "size": "large"
      }
    }
  ],
  "discountApplication": {
    "type": "fixed",
    "amount": 10.00
  },
  "tax": 7,
  "shippingAndHandling": 0
}

Custom order and item values

The properties parameter can be used to insert additional custom order and item values. Values added using the properties attribute will become available for segmenting audiences using the Audience Builder.

Use the properties parameter in place of the attr parameter if you want it to be searchable.

Example of adding custom order properties

{
  "orderID": "33451",
  "properties": {
    "color": "red",
    "size": "large",
    "currency": "USD"
  },
  "items": [
    {
      "productID": "1234abcd",
      "name": "Red Flannel",
      "category": "shirts",
      "sku": "ssd-2344-15",
      "tags": [
        "flannels",
        "winter"
      ]
    }
  ]
}

Example of adding custom items properties

{
  "orderID": "33451",
  "items": [
    {
      "productID": "1234abcd",
      "name": "Red Flannel",
      "category": "shirts",
      "sku": "ssd-2344-15",
      "tags": [
        "flannels",
        "winter"
      ],
      "properties": {
        "brands": [
          "Marmot",
          "Quicksilver"
        ]
      }
    }
  ]
}

Work with multiple shipping addresses

The shippingAddress and billingAddress parameters are part of the default kitchen sink order object. However, your order data may contain a secondary ship-to address as well as a separate ship-to address for each order item. Using the order and order item properties parameter, you can pass additional address fields as custom order and item values.

Add a custom secondary shipping address using order properties:

{
  "orderID": "33451",
  "email": "marksmith@example.com",
  "purchaseDate": "2025-01-09T22:47:12+0000",
  "properties": {
    "shippingAddress2": {
      "name": "Mark Smith",
      "address": "5555 Park Avenue",
      "city": "Los Angeles",
      "state": "CA",
      "postalCode": 90038,
      "country": "USA"
    }
  },
  "shippingAddress": {
    "name": "Mark Smith",
    "address": "13130 Silverlake Road",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": 92332,
    "country": "USA"
  },
  "billingAddress": {
    "name": " Mark Smith ",
    "address": "13130 Silverlake Road",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": 92332,
    "country": "USA"
  }
}

Add a custom order item shipping address using items properties:

{
  "orderID": "33451",
  "email": "marksmith@example.com",
  "purchaseDate": "2025-01-09T22:47:12+0000",
  "properties": {
    "color": "red",
    "size": "large",
    "currency": "USD"
  },
  "items": [
    {
      "productID": "1234abcd",
      "name": "Red Flannel",
      "category": "shirts",
      "sku": "ssd-2344-15",
      "tags": [
        "flannels",
        "winter"
      ],
      "properties": {
        "itemShipAddress": {
          "name": "Mark Smith",
          "address": "5555 Park Avenue",
          "city3": "Los Angeles",
          "state": "CA",
          "postalCode": 90038,
          "country": "USA"
        }
      }
    }
  ]
}

1.) The orderID field must be a unique value. 2.) The contact identifier primary or secondary key field is required. This is the unique identifier for the contact. Cordial does not accept anonymous order records. 3.)mcID or linkID are required if you need to attribute the order to a specific message or link within a message. These can be passed in the link as linkID={$linkID}&mcID={$mcID} and stored in a session variable for use in the API. 4.) One or more items can be included in an order.

GET/v2/orders

The GET/orders endpoint can retrieve up to 10,000 records at a time. To page through more than 10,000 records, multiple queries must be made with manually adjusted parameters for each.

• Parameters
• Example GET/orders request URLs

The following URL will retrieve all orders and include all fields.

https://<path>/v2/orders

The following URL will retrieve all orders, but only include the fields data for shippingAddress

https://<path>/v2/orders?fields=shippingAddress

The following URL will retrieve all orders, and include the fields data for both totalAmount and tax

https://<path>/v2/orders?fields=totalAmount,tax

The following URL will retrieve all orders with a purchaseDate greater than 2024-11-10

https://api.cordial.io/v2/orders?purchaseDate[gt]=2024-11-10

The following URL will retrieve all orders where the purchaseDate is between 2017-01-10 and 2017-01-11

https://api.cordial.io/v2/orders?purchaseDate[gte]=2017-01-10&purchaseDate[lte]=2017-01-11

The following URL will retrieve all orders starting from the third page grouping contacts by 10. For example, page 1 would have included the first 10, page 2 the second group of 10 and so on.

https://<path>/v2/orders?page=3&per_page=10

The following URL will retrieve all orders associated with the specified batch message ID (msID).

https://api.cordial.io/v2/orders?msID=45:58d99989486e542f5291c5b8:ot

The following URL will retrieve all orders associated with the specified automation template ID (mdtID).

https://api.cordial.io/v2/orders?mdtID=5b83b2e161c95f012b8255d6

GET/v2/orders/{id}

• Parameters
• Example GET/orders/{id} request URLs

Return records filtered by ID

The following URL will retrieve an order where the id value is 128.

https://<path>/v2/orders/128

Return records filtered by ID field

The following URL will retrieve an order where the id value is 128, but only include the field data for shippingAddress

https://<path>/v2/orders/128?fields=shippingAddress

Return records filtered by ID multiple fields

The following URL will retrieve an order where the id value is 128, and include the field data for both totalAmount and tax

https://<path>/v2/orders/128?fields=totalAmount,tax

PUT/v2/orders{id}

• Parameters
• Example JSON request
• Example PUT/orders request URL

Same requirements and schema as the POST method above.

The following will update the purchase date of order 33451.

{
  "email": "marksmith@example.com",
  "orderID": "33451",
  "purchaseDate": "2025-01-10T22:47:12+0000"
}

The following URL in conjunction with the JSON will perform the PUT.

https://<path>/v2/orders

DELETE/v2/orders/{id}

• Example DELETE/orders/{id} request URL

The following URL will delete an order where the id value is 128.

https://<path>/v2/orders/128

Error responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Orders API endpoint, along with suggested modifications to resolve each error. If you receive an error from this API endpoint that is not listed in this table, it is likely recorded within the Global API error responses page.