batch-retrieve-orders-response.md

Batch Retrieve Orders Response

Defines the fields that are included in the response body of a request to the BatchRetrieveOrders endpoint.

Structure

Batch Retrieve Orders Response

Fields

Name	Type	Tags	Description
orders	List of Order	Optional	The requested orders. This will omit any requested orders that do not exist.
errors	List of Error	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "orders": [
    {
      "id": "CAISEM82RcpmcFBM0TfOyiHV3es",
      "line_items": [
        {
          "base_price_money": {
            "amount": 1599,
            "currency": "USD"
          },
          "name": "Awesome product",
          "quantity": "1",
          "total_money": {
            "amount": 1599,
            "currency": "USD"
          },
          "uid": "945986d1-9586-11e6-ad5a-28cfe92138cf"
        },
        {
          "base_price_money": {
            "amount": 2000,
            "currency": "USD"
          },
          "name": "Another awesome product",
          "quantity": "3",
          "total_money": {
            "amount": 6000,
            "currency": "USD"
          },
          "uid": "a8f4168c-9586-11e6-bdf0-28cfe92138cf"
        }
      ],
      "location_id": "057P5VYJ4A5X1",
      "reference_id": "my-order-001",
      "total_money": {
        "amount": 7599,
        "currency": "USD"
      }
    }
  ]
}