Transaction Records

List all Transaction Records

Changed on

Retrieve a list of all transactions within range. Pagination of this endpoint is not indexed. count on the response body will always be null.

Required authorization scope: public.transaction_record:read

get/2024-09/transaction_records

Request

  • Base URL
    https://public-api.easyship.com
  • URL
    https://public-api.easyship.com/2024-09/transaction_records
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

from_datestring date

Beginning of date. Only accept YYYY-MM-DD format.

to_datestring date

End of date. Only accept YYYY-MM-DD format.

days_from_nowinteger

Number of days until current date.

easyship_shipment_idEasyshipShipmentId (unresolved $ref)

Easyship Shipment ID

adjustmentboolean

Whether the transaction record is an adjustment or not

type'shipment' | 'pickup' | 'claim' | 'policy' | 'payment'

Type of transaction record

Response

list of transactions

OR
string required

Transaction Records in CSV format

Example response

{
  "transaction_records": [
    {
      "id": "01563646-58c1-4607-8fe0-cae3e33c0001"
    }
  ]
}

Changes

    • warning

      added the new Bank Account Charge Failed enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new Bank Account Charge Failed enum value to the /// response property for the response status (media type: text/csv)

    • warning

      added the new Pay by Bank Cashback enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new Pay by Bank Cashback enum value to the /// response property for the response status (media type: text/csv)

    • warning

      added the new Tax & Duty Adjustment by Courier Invoice enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new Tax & Duty Adjustment by Courier Invoice enum value to the /// response property for the response status (media type: text/csv)