Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Line Items

Search line items

Search line items

get/line_items

Query parameters

line_item_idstring

Search for specific line item ID(s). Comma separate for multiple.

order_idinteger

Search for line items that belong to a specific order.

customer_idinteger

Search for line items that belong to a specific customer.

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

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

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

Return only line items that were completed on or before this date. Required when passing date_complete_from. Maximum date range: 31 days.

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

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

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

Return only line items that were delivered on or before this date. Required when passing date_scheduled_from. Maximum date range: 31 days.

campaign_idinteger

Search line items that are tied to orders of a specific campaign.

offer_idinteger

Search line items that are tied to orders of a specific offer.

item_idinteger

Search line items that are tied to a specific item.

discount_codeinteger

Search line items that are tied to orders with a specific discount code.

transaction_successinteger

Search line items by success status.

with'order' | 'customer' | 'transaction' | 'item' | 'line_item_shipments'

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

OK

totalinteger

Example response

{
  "line_items": [
    {
      "date_complete": "2023-04-01 00:00:00",
      "transaction": {
        "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"
      },
      "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"
          }
        ]
      },
      "item": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      }
    }
  ]
}