ecommerce/orders

Retrieve orders from any connected Ats software

get/ecommerce/orders/{id}

Request

  • Base URL
    https://api.panora.dev
  • URL
    https://api.panora.dev/ecommerce/orders/{id}
  • Auth
    API key in header x-api-key

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"
}

Changes

    • info

      removed the AED enum value from the response property for the response status

    • info

      removed the AFN enum value from the response property for the response status

    • info

      removed the ALL enum value from the response property for the response status

    • info

      removed the AMD enum value from the response property for the response status

    • info

      removed the ANG enum value from the response property for the response status

    • info

      removed the AOA enum value from the response property for the response status

    • info

      removed the ARS enum value from the response property for the response status

    • info

      removed the AUD enum value from the response property for the response status

    • info

      removed the AWG enum value from the response property for the response status

    • info

      removed the AZN enum value from the response property for the response status

    • info

      removed the BAM enum value from the response property for the response status

    • info

      removed the BBD enum value from the response property for the response status

    • info

      removed the BDT enum value from the response property for the response status

    • info

      removed the BGN enum value from the response property for the response status

    • info

      removed the BHD enum value from the response property for the response status

    • info

      removed the BIF enum value from the response property for the response status

    • info

      removed the BMD enum value from the response property for the response status

    • info

      removed the BND enum value from the response property for the response status

    • info

      removed the BOB enum value from the response property for the response status

    • info

      removed the BRL enum value from the response property for the response status

    • info

      removed the BSD enum value from the response property for the response status

    • info

      removed the BTN enum value from the response property for the response status

    • info

      removed the BWP enum value from the response property for the response status

    • info

      removed the BYN enum value from the response property for the response status

    • info

      removed the BZD enum value from the response property for the response status

    • info

      removed the CAD enum value from the response property for the response status

    • info

      removed the CANCELED enum value from the response property for the response status

    • info

      removed the CANCELED enum value from the response property for the response status

    • info

      removed the CDF enum value from the response property for the response status

    • info

      removed the CHF enum value from the response property for the response status

    • info

      removed the CLP enum value from the response property for the response status

    • info

      removed the CNY enum value from the response property for the response status

    • info

      removed the COP enum value from the response property for the response status

    • info

      removed the CRC enum value from the response property for the response status

    • info

      removed the CUP enum value from the response property for the response status

    • info

      removed the CVE enum value from the response property for the response status

    • info

      removed the CZK enum value from the response property for the response status

    • info

      removed the DJF enum value from the response property for the response status

    • info

      removed the DKK enum value from the response property for the response status

    • info

      removed the DOP enum value from the response property for the response status

    • info

      removed the DZD enum value from the response property for the response status

    • info

      removed the EGP enum value from the response property for the response status

    • info

      removed the ERN enum value from the response property for the response status

    • info

      removed the ETB enum value from the response property for the response status

    • info

      removed the EUR enum value from the response property for the response status

    • info

      removed the FAIL enum value from the response property for the response status

    • info

      removed the FJD enum value from the response property for the response status

    • info

      removed the FKP enum value from the response property for the response status

    • info

      removed the FOK enum value from the response property for the response status

    • info

      removed the FULFILLED enum value from the response property for the response status

    • info

      removed the GBP enum value from the response property for the response status

    • info

      removed the GEL enum value from the response property for the response status

    • info

      removed the GGP enum value from the response property for the response status

    • info

      removed the GHS enum value from the response property for the response status

    • info

      removed the GIP enum value from the response property for the response status

    • info

      removed the GMD enum value from the response property for the response status

    • info

      removed the GNF enum value from the response property for the response status

    • info

      removed the GTQ enum value from the response property for the response status

    • info

      removed the GYD enum value from the response property for the response status

    • info

      removed the HKD enum value from the response property for the response status

    • info

      removed the HNL enum value from the response property for the response status

    • info

      removed the HRK enum value from the response property for the response status

    • info

      removed the HTG enum value from the response property for the response status

    • info

      removed the HUF enum value from the response property for the response status

    • info

      removed the IDR enum value from the response property for the response status

    • info

      removed the ILS enum value from the response property for the response status

    • info

      removed the IMP enum value from the response property for the response status

    • info

      removed the INR enum value from the response property for the response status

    • info

      removed the IQD enum value from the response property for the response status

    • info

      removed the IRR enum value from the response property for the response status

    • info

      removed the ISK enum value from the response property for the response status

    • info

      removed the JEP enum value from the response property for the response status

    • info

      removed the JMD enum value from the response property for the response status

    • info

      removed the JOD enum value from the response property for the response status

    • info

      removed the JPY enum value from the response property for the response status

    • info

      removed the KES enum value from the response property for the response status

    • info

      removed the KGS enum value from the response property for the response status

    • info

      removed the KHR enum value from the response property for the response status

    • info

      removed the KID enum value from the response property for the response status

    • info

      removed the KMF enum value from the response property for the response status

    • info

      removed the KRW enum value from the response property for the response status

    • info

      removed the KWD enum value from the response property for the response status

    • info

      removed the KYD enum value from the response property for the response status

    • info

      removed the KZT enum value from the response property for the response status

    • info

      removed the LAK enum value from the response property for the response status

    • info

      removed the LBP enum value from the response property for the response status

    • info

      removed the LKR enum value from the response property for the response status

    • info

      removed the LRD enum value from the response property for the response status

    • info

      removed the LSL enum value from the response property for the response status

    • info

      removed the LYD enum value from the response property for the response status

    • info

      removed the MAD enum value from the response property for the response status

    • info

      removed the MDL enum value from the response property for the response status

    • info

      removed the MGA enum value from the response property for the response status

    • info

      removed the MKD enum value from the response property for the response status

    • info

      removed the MMK enum value from the response property for the response status

    • info

      removed the MNT enum value from the response property for the response status

    • info

      removed the MOP enum value from the response property for the response status

    • info

      removed the MRU enum value from the response property for the response status

    • info

      removed the MUR enum value from the response property for the response status

    • info

      removed the MVR enum value from the response property for the response status

    • info

      removed the MWK enum value from the response property for the response status

    • info

      removed the MXN enum value from the response property for the response status

    • info

      removed the MYR enum value from the response property for the response status

    • info

      removed the MZN enum value from the response property for the response status

    • info

      removed the NAD enum value from the response property for the response status

    • info

      removed the NGN enum value from the response property for the response status

    • info

      removed the NIO enum value from the response property for the response status

    • info

      removed the NOK enum value from the response property for the response status

    • info

      removed the NPR enum value from the response property for the response status

    • info

      removed the NZD enum value from the response property for the response status

    • info

      removed the OMR enum value from the response property for the response status

    • info

      removed the PAB enum value from the response property for the response status

    • info

      removed the PEN enum value from the response property for the response status

    • info

      removed the PENDING enum value from the response property for the response status

    • info

      removed the PENDING enum value from the response property for the response status

    • info

      removed the PGK enum value from the response property for the response status

    • info

      removed the PHP enum value from the response property for the response status

    • info

      removed the PKR enum value from the response property for the response status

    • info

      removed the PLN enum value from the response property for the response status

    • info

      removed the PYG enum value from the response property for the response status

    • info

      removed the QAR enum value from the response property for the response status

    • info

      removed the RON enum value from the response property for the response status

    • info

      removed the RSD enum value from the response property for the response status

    • info

      removed the RUB enum value from the response property for the response status

    • info

      removed the RWF enum value from the response property for the response status

    • info

      removed the SAR enum value from the response property for the response status

    • info

      removed the SBD enum value from the response property for the response status

    • info

      removed the SCR enum value from the response property for the response status

    • info

      removed the SDG enum value from the response property for the response status

    • info

      removed the SEK enum value from the response property for the response status

    • info

      removed the SGD enum value from the response property for the response status

    • info

      removed the SHIPPED enum value from the response property for the response status

    • info

      removed the SHP enum value from the response property for the response status

    • info

      removed the SLE enum value from the response property for the response status

    • info

      removed the SLL enum value from the response property for the response status

    • info

      removed the SOS enum value from the response property for the response status

    • info

      removed the SRD enum value from the response property for the response status

    • info

      removed the SSP enum value from the response property for the response status

    • info

      removed the STN enum value from the response property for the response status

    • info

      removed the SUCCESS enum value from the response property for the response status

    • info

      removed the SYP enum value from the response property for the response status

    • info

      removed the SZL enum value from the response property for the response status

    • info

      removed the THB enum value from the response property for the response status

    • info

      removed the TJS enum value from the response property for the response status

    • info

      removed the TMT enum value from the response property for the response status

    • info

      removed the TND enum value from the response property for the response status

    • info

      removed the TOP enum value from the response property for the response status

    • info

      removed the TRY enum value from the response property for the response status

    • info

      removed the TTD enum value from the response property for the response status

    • info

      removed the TVD enum value from the response property for the response status

    • info

      removed the TWD enum value from the response property for the response status

    • info

      removed the TZS enum value from the response property for the response status

    • info

      removed the UAH enum value from the response property for the response status

    • info

      removed the UGX enum value from the response property for the response status

    • info

      removed the UNSHIPPED enum value from the response property for the response status

    • info

      removed the USD enum value from the response property for the response status

    • info

      removed the UYU enum value from the response property for the response status

    • info

      removed the UZS enum value from the response property for the response status

    • info

      removed the VES enum value from the response property for the response status

    • info

      removed the VND enum value from the response property for the response status

    • info

      removed the VUV enum value from the response property for the response status

    • info

      removed the WST enum value from the response property for the response status

    • info

      removed the XAF enum value from the response property for the response status

    • info

      removed the XCD enum value from the response property for the response status

    • info

      removed the XDR enum value from the response property for the response status

    • info

      removed the XOF enum value from the response property for the response status

    • info

      removed the XPF enum value from the response property for the response status

    • info

      removed the YER enum value from the response property for the response status

    • info

      removed the ZAR enum value from the response property for the response status

    • info

      removed the ZMW enum value from the response property for the response status

    • info

      removed the ZWL enum value from the response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status