Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Order Offers

Search order offers

 

get/order_offers

Query parameters

order_offer_idstring

Search for specific order offer ID(s). Comma separate for multiple.

customer_idinteger

Search for order offers for a specific customer ID.

customer_emailstring

Search for order offers for a specific customer email.

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
  • 1 - Active
  • 2 - Cancelled
  • 3 - Complete
  • 4 - Partial
  • 5 - Declined
  • 6 - Archive
  • 7 - Rejected
  • 8 - Removed
  • 9 - Paused
  • 10 - Expired
offer_idinteger

Search for order offers by offer ID.

date_created_fromstring date-time
Example:2023-04-01 00:00:00

Return only order offers that were created on or after this date. A date to and from field is required when not passing order offer id(s), a customer ID, or a customer email.

date_created_tostring date-time
Example:2023-04-01 00:00:00

Search order offers that were created on or before this date. Required when passing date_created_from. Maximum date range: 31 days.

date_ordered_fromstring date-time
Example:2023-04-01 00:00:00

Return only order offers that were ordered ( completed ) on or after this date. A date to and from field is required when not passing order offer ID(s), a customer ID, or a customer email.

date_ordered_tostring date-time
Example:2023-04-01 00:00:00

Search order offers that were ordered ( completed ) on or before this date. Required when passing date_ordered_from. Maximum date range: 31 days.

date_cancel_fromstring date-time
Example:2023-04-01 00:00:00

Return only order offers that were cancelled on or after this date. A date to and from field is required when not passing order offer ID(s), a customer ID, or a customer email.

date_cancel_tostring date-time
Example:2023-04-01 00:00:00

Search order offers that were cancelled on or before this date. Required when passing date_cancel_from. Maximum date range: 31 days.

with'discount' | 'order_offer_shipments' | 'order_offer_next_transactions' | 'order_offer_items' | 'order_offer_gifts' | 'customer_address_billing' | 'customer_address_shipping' | 'campaign' | 'actions'

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

limitinteger

Limit the number of results. Default: 200, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

is_recurringboolean
is_giftboolean
discount_codestring
gift_emailstring
gift_status'Claimed' | 'Pending' | 'Sent' | 'Inactive'
gift_date_fromstring date-time
Example:2023-04-01 00:00:00
gift_date_tostring date-time
Example:2023-04-01 00:00:00

Response

OK

totalinteger

Example response

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