GOgoshippo
Shipments

List all shipments

Changed on

Returns a list of all shipment objects.

To filter results, 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

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/shipments/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30

Note: Shipment objects older than 390 days are not returned.

get/shipments

Request

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

Query parameters

page_tokenstring

The page token for paginated results

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 shipments

nextstring
previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "extra": {
        "accounts_receivable_customer_account": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "appropriation_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "bill_of_lading_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "COD": {
          "amount": "5.5",
          "currency": "USD",
          "payment_method": "CASH"
        },
        "cod_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "customer_reference": {
          "ref_sort": 1
        },
        "dealer_order_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "dept_number": {
          "ref_sort": 3
        },
        "fda_product_code": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "insurance": {
          "amount": "5.5",
          "currency": "USD"
        },
        "invoice_number": {
          "ref_sort": 2
        },
        "manifest_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "model_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "part_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "po_number": {
          "ref_sort": 2
        },
        "production_code": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "purchase_request_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "rma_number": {
          "ref_sort": 1
        },
        "salesperson_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "serial_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "store_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        },
        "transaction_reference_number": {
          "prefix": "ABC",
          "value": "value",
          "ref_sort": 1
        }
      },
      "metadata": "Customer ID 123456",
      "shipment_date": "2021-03-22T12:00:00Z",
      "address_from": {
        "name": "Shwan Ippotle",
        "company": "Shippo",
        "street1": "215 Clayton St.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94117",
        "country": "US",
        "phone": "+1 555 341 9393",
        "email": "shippotle@shippo.com",
        "is_residential": true,
        "metadata": "Customer ID 123456",
        "is_complete": true,
        "object_created": "2014-07-09T02:19:13.174Z",
        "object_id": "d799c2679e644279b59fe661ac8fa488",
        "object_owner": "shippotle@shippo.com",
        "object_updated": "2014-07-09T02:19:13.174Z",
        "validation_results": {
          "messages": [
            {
              "code": "Unknown Street",
              "source": "Shippo Address Validator",
              "text": "City, State and ZIP Code are valid, but street address is not a match.",
              "type": "address_warning"
            }
          ]
        }
      },
      "address_return": {
        "name": "Shwan Ippotle",
        "company": "Shippo",
        "street1": "215 Clayton St.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94117",
        "country": "US",
        "phone": "+1 555 341 9393",
        "email": "shippotle@shippo.com",
        "is_residential": true,
        "metadata": "Customer ID 123456",
        "is_complete": true,
        "object_created": "2014-07-09T02:19:13.174Z",
        "object_id": "d799c2679e644279b59fe661ac8fa488",
        "object_owner": "shippotle@shippo.com",
        "object_updated": "2014-07-09T02:19:13.174Z",
        "validation_results": {
          "messages": [
            {
              "code": "Unknown Street",
              "source": "Shippo Address Validator",
              "text": "City, State and ZIP Code are valid, but street address is not a match.",
              "type": "address_warning"
            }
          ]
        }
      },
      "address_to": {
        "name": "Shwan Ippotle",
        "company": "Shippo",
        "street1": "215 Clayton St.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94117",
        "country": "US",
        "phone": "+1 555 341 9393",
        "email": "shippotle@shippo.com",
        "is_residential": true,
        "metadata": "Customer ID 123456",
        "is_complete": true,
        "object_created": "2014-07-09T02:19:13.174Z",
        "object_id": "d799c2679e644279b59fe661ac8fa488",
        "object_owner": "shippotle@shippo.com",
        "object_updated": "2014-07-09T02:19:13.174Z",
        "validation_results": {
          "messages": [
            {
              "code": "Unknown Street",
              "source": "Shippo Address Validator",
              "text": "City, State and ZIP Code are valid, but street address is not a match.",
              "type": "address_warning"
            }
          ]
        }
      },
      "customs_declaration": {
        "b13a_filing_option": "FILED_ELECTRONICALLY",
        "certify": true,
        "certify_signer": "Shawn Ippotle",
        "contents_explanation": "T-Shirt purchase",
        "duties_payor": {
          "account": "2323434543",
          "type": "THIRD_PARTY",
          "address": {
            "name": "Patrick Kavanagh",
            "zip": "80331",
            "country": "DE"
          }
        },
        "exporter_identification": {
          "eori_number": "PL123456790ABCDE",
          "tax_id": {
            "number": "123456789",
            "type": "EIN"
          }
        },
        "invoice": "#123123",
        "metadata": "Order ID #123123",
        "address_importer": "257ba08436604d2aaf069caafe7acb2a",
        "contents_type": "MERCHANDISE",
        "eel_pfc": "NOEEI_30_37_a",
        "incoterm": "DDP",
        "items": [
          "5087f181d1dc4b14b73fdbf636498886"
        ],
        "non_delivery_option": "RETURN",
        "object_created": "2014-07-17T01:01:08.306Z",
        "object_id": "e2197a54da9d470480f4f8796cc419cb",
        "object_owner": "shippotle@shippo.com",
        "object_updated": "2014-07-17T01:01:08.306Z",
        "test": true
      },
      "messages": [
        {
          "source": "UPS",
          "code": "carrier_timeout",
          "text": "UPS API did not respond. Please try again in a few minutes."
        }
      ],
      "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
      "object_owner": "pp@gmail.com",
      "parcels": [
        {
          "extra": {
            "COD": {
              "amount": "5.5",
              "currency": "USD",
              "payment_method": "CASH"
            },
            "insurance": {
              "amount": "5.5",
              "content": "Laptop",
              "currency": "USD",
              "provider": "UPS"
            }
          },
          "metadata": "Customer ID 123456",
          "mass_unit": "lb",
          "weight": "1",
          "distance_unit": "in",
          "height": "1",
          "length": "1",
          "width": "1",
          "object_created": "2014-07-09T02:19:13.174Z",
          "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
          "object_owner": "shippotle@shippo.com",
          "object_state": "VALID",
          "object_updated": "2014-07-09T02:19:13.174Z"
        }
      ],
      "rates": [
        {
          "amount": "5.5",
          "amount_local": "5.5",
          "currency": "USD",
          "currency_local": "USD",
          "arrives_by": "08:30:00",
          "carrier_account": "078870331023437cb917f5187429b093",
          "duration_terms": "Delivery in 1 to 3 business days",
          "estimated_days": 2,
          "included_insurance_price": "1.05",
          "messages": [
            {
              "source": "UPS",
              "code": "carrier_timeout",
              "text": "UPS API did not respond. Please try again in a few minutes."
            }
          ],
          "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
          "object_owner": "pp@gmail.com",
          "provider": "USPS",
          "provider_image_75": "https://cdn2.goshippo.com/providers/75/USPS.png",
          "provider_image_200": "https://cdn2.goshippo.com/providers/200/USPS.png",
          "servicelevel": {
            "name": "Priority Mail Express",
            "terms": "ONERATE",
            "token": "usps_priority_express",
            "parent_servicelevel": {
              "name": "Priority Mail Express",
              "terms": "ONERATE",
              "token": "usps_priority_express"
            }
          },
          "shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
          "zone": "1"
        }
      ],
      "status": "QUEUED"
    }
  ]
}

Changes

  • 0eab5a94b0c3Revision changes
    • info

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

  • be0092fd45a9Revision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status