GOgoshippo
Transactions

List all shipping labels

Changed on

Returns a list of all transaction objects.

To filter results by creation date, use the optional query parameters below. Provided dates should be ISO 8601 UTC dates (timezone offsets are currently not supported).

  • object_created_gt: object(s) created after the provided date time
  • object_created_gte: object(s) created at or after the provided date time
  • object_created_lt: object(s) created before the provided date time
  • object_created_lte: object(s) created at or before the provided date time

Provide at most one lower bound (object_created_gt or object_created_gte) and at most one upper bound (object_created_lt or object_created_lte) per request. Lower bounds must not be in the future.

Date format examples: 2017-01-01, 2017-01-01T03:30:30 (or 2017-01-01T03:30:30.5), 2017-01-01T03:30:30Z

Example URL: https://api.goshippo.com/transactions/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30

get/transactions

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/transactions
  • Auth
    API key in header Authorization

Query parameters

ratestring

Filter by rate ID

object_status'WAITING' | 'QUEUED' | 'SUCCESS' | 'ERROR' | 'REFUNDED' | 'REFUNDPENDING' | 'REFUNDREJECTED'

Indicates the status of the Transaction.

Example:SUCCESS

Filter by object status

tracking_status'UNKNOWN' | 'PRE_TRANSIT' | 'TRANSIT' | 'DELIVERED' | 'RETURNED' | 'FAILURE'

Indicates the high level status of the shipment.

Example:DELIVERED

Filter by tracking status

pageinteger

The page number you want to select

resultsinteger

The number of results to return per page (max 100)

object_created_gtstring

Object(s) created greater than a provided date and time.

object_created_gtestring

Object(s) created greater than or equal to a provided date and time.

object_created_ltstring

Object(s) created lesser than a provided date and time.

object_created_ltestring

Object(s) created lesser than or equal to a provided date and time.

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts guide.

Response

Paginated list of transactions

nextstring
previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "created_by": {
        "first_name": "Shwan",
        "last_name": "Ippotle",
        "username": "shippotle@shippo.com"
      },
      "label_file_type": "PDF_4x6",
      "label_url": "https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
      "messages": [
        {
          "source": "UPS",
          "code": "carrier_timeout",
          "text": "UPS API did not respond. Please try again in a few minutes."
        }
      ],
      "object_id": "915d94940ea54c3a80cbfa328722f5a1",
      "object_owner": "shippotle@shippo.com",
      "parcel": "e94c7fdfdc7b495dbb390a28d929d90a",
      "qr_code_url": "https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
      "rate": {
        "amount": "5.5",
        "amount_local": "5.5",
        "currency": "USD",
        "currency_local": "USD",
        "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
        "provider": "USPS",
        "carrier_account": "078870331023437cb917f5187429b093",
        "servicelevel_name": "Priority Mail",
        "servicelevel_token": "fedex_ground"
      },
      "status": "SUCCESS",
      "tracking_number": "9499907123456123456781",
      "tracking_status": "DELIVERED",
      "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781"
    }
  ]
}

Changes

  • 0eab5a94b0c3Revision changes
    • info

      added the new optional header request parameter SHIPPO-ACCOUNT-ID

  • 840802c43c16Revision changes
    • info

      added the new optional query request parameter object_created_gt

    • info

      added the new optional query request parameter object_created_gte

    • info

      added the new optional query request parameter object_created_lt

    • info

      added the new optional query request parameter object_created_lte