v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Sales

Get a sale

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

get/sales/{sale_id}

Query parameters

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)

Response

sale_idinteger

order_idinteger

customer_idinteger

customer_namestring

statusstring

cycleinteger

currency_idinteger

pricestring

discount_totalstring

shippingstring

sub_totalstring

taxstring

gift_card_appliedstring

totalstring

date_salestring date-time nullable

date_attemptstring date-time nullable

Example response

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