Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
ecommerce/orders

Retrieve Orders

Retrieve orders from any connected Ats software

get/ecommerce/orders/{id}

Path parameters

idstring required

id of the order you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Ats software.

Headers

x-connection-tokenstring required

The connection token

Response

order_statusstring nullable

The status of the order

order_numberstring nullable

The number of the order

payment_statusstring nullable

The payment status of the order

currencystring nullable

The currency of the order. Authorized value must be of type CurrencyCode (ISO 4217)

total_pricenumber nullable

The total price of the order

total_discountnumber nullable

The total discount on the order

total_shippingnumber nullable

The total shipping cost of the order

total_taxnumber nullable

The total tax on the order

fulfillment_statusstring nullable

The fulfillment status of the order

customer_idstring nullable

The UUID of the customer associated with the order

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the order

remote_idstring nullable

The remote ID of the order in the context of the 3rd Party

remote_dataobject nullable

The remote data of the customer in the context of the 3rd Party

created_atstring nullable

The created date of the object

modified_atstring nullable

The modified date of the object

Example response

{
  "order_status": "UNSHIPPED",
  "payment_status": "SUCCESS",
  "currency": "AUD",
  "total_price": 300,
  "total_discount": 10,
  "total_shipping": 120,
  "total_tax": 120,
  "fulfillment_status": "PENDING",
  "customer_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "items": [
    {
      "remote_id": "12345",
      "product_id": "prod_001",
      "variant_id": "var_001",
      "sku": "SKU123",
      "title": "Sample Product",
      "quantity": 2,
      "price": "19.99",
      "total": "39.98",
      "fulfillment_status": "PENDING",
      "requires_shipping": true,
      "taxable": true,
      "weight": 1.5,
      "variant_title": "Size M",
      "vendor": "Sample Vendor",
      "properties": [
        {
          "name": "Color",
          "value": "Red"
        }
      ],
      "tax_lines": [
        {
          "title": "Sales Tax",
          "price": "3.00",
          "rate": 0.075
        }
      ],
      "discount_allocations": [
        {
          "amount": "5.00",
          "discount_application_index": 0
        }
      ]
    }
  ],
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}