Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Orders

Get an order

Get order details by specific order ID. Query params will determine the level of order details returned. Expand on the information returned by including 'with' in the query parameters to include additional details of the orders. For multiple attributes, separate with a comma (example : with=customer,order_offers)

get/orders/{order_id}

Query parameters

with'order_offers' | 'order_gift_cards' | 'order_revisions' | 'customer' | 'customer_card' | 'customer_address_billing' | 'customer_address_shipping' | 'transactions' | 'shipments' | 'campaign' | 'cart' | 'route_logs' | 'api_requests'

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=customer,order_offers)

Response

OK

order_idinteger
connection_order_idstring nullable
campaign_idinteger
status_type_idnull | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 nullable
  • 1 - Active
  • 2 - Cancelled
  • 3 - Complete
  • 4 - Partial
  • 5 - Declined
  • 6 - Archive
  • 7 - Rejected
  • 8 - Removed
  • 9 - Paused
  • 10 - Expired
customer_card_idinteger nullable
customer_idinteger
customers_address_billing_idinteger nullable
customers_address_shipping_idinteger nullable
date_createdstring date-time nullable
date_modifiedstring date-time nullable
date_authorizedstring date-time nullable
date_auto_capturestring date-time nullable
date_orderedstring date-time nullable
date_capturestring date-time nullable
is_testboolean
ip_addressstring nullable
order_discountstring
order_pixelboolean
cart_tokenstring nullable
order_pixel_blockstring nullable
order_notesstring nullable
created_byinteger
modified_byinteger
tracking1string nullable
tracking2string nullable
tracking3string nullable
tracking4string nullable
tracking5string nullable
tracking6string nullable
tracking7string nullable
tracking8string nullable
tracking9string nullable
tracking10string nullable
tracking11string nullable
tracking12string nullable
tracking13string nullable
tracking14string nullable
tracking15string nullable
tracking16string nullable
tracking17string nullable
tracking18string nullable
tracking19string nullable
tracking20string nullable
user_agentstring nullable

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00",
  "date_authorized": "2023-04-01 00:00:00",
  "date_auto_capture": "2023-04-01 00:00:00",
  "date_ordered": "2023-04-01 00:00:00",
  "date_capture": "2023-04-01 00:00:00",
  "cart": {
    "campaign": {
      "campaign_checkout_upsell": {
        "items": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ]
      }
    },
    "order": {
      "date_authorized": "2023-04-01 00:00:00",
      "date_ordered": "2023-04-01 00:00:00"
    },
    "offers": [
      {
        "gift_date": "2023-04-01 00:00:00",
        "upsells": [
          {
            "items": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              }
            ]
          }
        ]
      }
    ]
  },
  "order_offers": [
    {
      "date_cancel": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "date_ordered": "2023-04-01 00:00:00",
      "date_reactivate": "2023-04-01 00:00:00",
      "date_pause": "2023-04-01 00:00:00",
      "date_unpause": "2023-04-01 00:00:00",
      "last_recurring_date": "2023-04-01 00:00:00",
      "next_recurring_date": "2023-04-01 00:00:00",
      "order_offer_shipments": [
        {
          "date_cancel": "2023-04-01 00:00:00",
          "date_scheduled": "2023-04-01 00:00:00",
          "date_complete": "2023-04-01 00:00:00",
          "date_scan": "2023-04-01 00:00:00",
          "date_deliver": "2023-04-01 00:00:00",
          "date_return": "2023-04-01 00:00:00",
          "date_skip": "2023-04-01 00:00:00",
          "date_rma": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00",
          "customer_address_billing": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "customer_address_shipping": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "tracking_history": [
            {
              "date": "2023-04-01 00:00:00"
            }
          ]
        }
      ],
      "order_offer_items": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "discount": {
        "discount_expiration_date": "2023-04-01 00:00:00",
        "discount_offers": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00",
            "offer_cycles": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00",
                "offer_cycle_items": [
                  {
                    "date_created": "2023-04-01 00:00:00",
                    "date_modified": "2023-04-01 00:00:00"
                  }
                ],
                "charge_timeframe": {
                  "date_created": "2023-04-01 00:00:00",
                  "date_modified": "2023-04-01 00:00:00"
                }
              }
            ],
            "offer_timeframes": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              }
            ],
            "offer_swap_options": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              }
            ]
          }
        ]
      },
      "order_offer_next_transactions": [
        {
          "date_scheduled": "2023-04-01 00:00:00",
          "date_complete": "2023-04-01 00:00:00",
          "date_cancelled": "2023-04-01 00:00:00",
          "date_skip": "2023-04-01 00:00:00",
          "date_batch": "2023-04-01 00:00:00",
          "date_deposit": "2023-04-01 00:00:00",
          "date_request": "2023-04-01 00:00:00",
          "date_response": "2023-04-01 00:00:00",
          "rebill_date": "2023-04-01 00:00:00",
          "original_attempt_date": "2023-04-01 00:00:00",
          "parent_date_complete": "2023-04-01 00:00:00",
          "chargeback_date": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00",
          "order": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00",
            "date_authorized": "2023-04-01 00:00:00",
            "date_auto_capture": "2023-04-01 00:00:00",
            "date_ordered": "2023-04-01 00:00:00",
            "date_capture": "2023-04-01 00:00:00"
          },
          "order_revisions": [
            {
              "date_modified": "2023-04-01 00:00:00"
            }
          ],
          "customer": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00",
            "customer_cards": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              }
            ],
            "customer_addresses": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              }
            ]
          },
          "customer_card": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "customer_address_billing": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "customer_address_shipping": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "merchant": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "sale": {
            "date_sale": "2023-04-01 00:00:00",
            "date_attempt": "2023-04-01 00:00:00"
          },
          "credits": [
            {
              "date_scheduled": "2023-04-01 00:00:00",
              "date_complete": "2023-04-01 00:00:00",
              "date_cancelled": "2023-04-01 00:00:00",
              "date_skip": "2023-04-01 00:00:00",
              "date_batch": "2023-04-01 00:00:00",
              "date_deposit": "2023-04-01 00:00:00",
              "date_request": "2023-04-01 00:00:00",
              "date_response": "2023-04-01 00:00:00",
              "rebill_date": "2023-04-01 00:00:00",
              "original_attempt_date": "2023-04-01 00:00:00",
              "parent_date_complete": "2023-04-01 00:00:00",
              "chargeback_date": "2023-04-01 00:00:00",
              "date_created": "2023-04-01 00:00:00",
              "date_modified": "2023-04-01 00:00:00"
            }
          ],
          "line_items": [
            {
              "date_complete": "2023-04-01 00:00:00"
            }
          ],
          "shipments": [
            {
              "date_cancel": "2023-04-01 00:00:00",
              "date_scheduled": "2023-04-01 00:00:00",
              "date_complete": "2023-04-01 00:00:00",
              "date_scan": "2023-04-01 00:00:00",
              "date_deliver": "2023-04-01 00:00:00",
              "date_return": "2023-04-01 00:00:00",
              "date_skip": "2023-04-01 00:00:00",
              "date_rma": "2023-04-01 00:00:00",
              "date_created": "2023-04-01 00:00:00",
              "date_modified": "2023-04-01 00:00:00",
              "customer_address_billing": {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              },
              "customer_address_shipping": {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              },
              "tracking_history": [
                {
                  "date": "2023-04-01 00:00:00"
                }
              ]
            }
          ],
          "route_logs": [
            {
              "date_complete": "2023-04-01 00:00:00",
              "date_created": "2023-04-01 00:00:00"
            }
          ]
        }
      ],
      "order_offer_gifts": [
        {
          "gift_date": "2023-04-01 00:00:00",
          "gift_date_sent": "2023-04-01 00:00:00"
        }
      ],
      "customer_address_billing": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_shipping": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      }
    }
  ],
  "order_gift_cards": [
    {
      "date_created": "2023-04-01 00:00:00"
    }
  ],
  "order_revisions": [
    {
      "date_modified": "2023-04-01 00:00:00"
    }
  ],
  "customer": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00",
    "customer_cards": [
      {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      }
    ],
    "customer_addresses": [
      {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      }
    ]
  },
  "customer_card": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  },
  "customer_address_billing": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  },
  "customer_address_shipping": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  },
  "shipments": [
    {
      "date_cancel": "2023-04-01 00:00:00",
      "date_scheduled": "2023-04-01 00:00:00",
      "date_complete": "2023-04-01 00:00:00",
      "date_scan": "2023-04-01 00:00:00",
      "date_deliver": "2023-04-01 00:00:00",
      "date_return": "2023-04-01 00:00:00",
      "date_skip": "2023-04-01 00:00:00",
      "date_rma": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "customer_address_billing": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_shipping": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "tracking_history": [
        {
          "date": "2023-04-01 00:00:00"
        }
      ]
    }
  ],
  "transactions": [
    {
      "date_scheduled": "2023-04-01 00:00:00",
      "date_complete": "2023-04-01 00:00:00",
      "date_cancelled": "2023-04-01 00:00:00",
      "date_skip": "2023-04-01 00:00:00",
      "date_batch": "2023-04-01 00:00:00",
      "date_deposit": "2023-04-01 00:00:00",
      "date_request": "2023-04-01 00:00:00",
      "date_response": "2023-04-01 00:00:00",
      "rebill_date": "2023-04-01 00:00:00",
      "original_attempt_date": "2023-04-01 00:00:00",
      "parent_date_complete": "2023-04-01 00:00:00",
      "chargeback_date": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "merchant": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "line_items": [
        {
          "date_complete": "2023-04-01 00:00:00"
        }
      ]
    }
  ],
  "route_logs": [
    {
      "date_complete": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00"
    }
  ]
}