v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Sales

Search sales

get/sales

Query parameters

sale_idstring

Search for specific sale ID(s). Comma separate for multiple.

order_idinteger

Search for transactions that belong to a specific order.

customer_idinteger

Search for sales that belong to a specific customer.

date_scheduled_fromstring date-time

Example:2023-04-01 00:00:00

Return only sales that were scheduled on or after this date. A date to and from field is required when not passing sale ID(s), a customer ID or an order ID.

date_scheduled_tostring date-time

Example:2023-04-01 00:00:00

Return only sales that were scheduled on or before this date. Required when passing date_scheduled_from. Maximum date range: 31 days.

campaign_idinteger

Search sales that are tied to orders of a specific campaign.

with'order' | 'customer' | 'transactions'

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

limitinteger

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

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

totalinteger

Example response

{
  "sales": [
    {
      "date_sale": "2023-04-01 00:00:00",
      "date_attempt": "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"
      },
      "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"
          }
        ]
      },
      "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"
            }
          ]
        }
      ]
    }
  ]
}