GOgoshippo
Orders

List all orders

Changed on

Returns a list of all order objects.

get/orders

Request

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

Query parameters

pageinteger

The page number you want to select

resultsinteger

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

order_status[]OrderStatusEnum[]

Filter orders by order status

[
  "PAID"
]
shop_app'Amazon' | 'Bigcommerce' | 'CSV_Import' | 'eBay' | 'ePages' | 'Etsy' | 'Godaddy' | 'Magento' | 'Shippo' | 'Shopify' | 'Spreecommerce' | 'StripeRelay' | 'Walmart' | 'Weebly' | 'WooCommerce'

Platform the order was created on and, if applicable, imported from. Orders created via the Shippo API or dashboard will have the value "Shippo".

Example:Shippo

Filter orders by shop app

start_datestring

Filter orders created after the input date and time (ISO 8601 UTC format). This is based on the placed_at field, meaning when the order has been placed, not when the order object was created.

end_datestring

Filter orders created before the input date and time (ISO 8601 UTC format). This is based on the placed_at field, meaning when the order has been placed, not when the order object was created.

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 orders

nextstring
previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "currency": "USD",
      "notes": "This customer is a VIP",
      "order_number": "#1068",
      "order_status": "PAID",
      "placed_at": "2016-09-23T01:28:12Z",
      "shipping_cost": "12.83",
      "shipping_cost_currency": "USD",
      "shipping_method": "USPS First Class Package",
      "subtotal_price": "12.1",
      "total_price": "24.93",
      "total_tax": "0.0",
      "weight": "0.4",
      "weight_unit": "lb",
      "from_address": {
        "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"
            }
          ]
        }
      },
      "to_address": {
        "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"
            }
          ]
        }
      },
      "line_items": [
        {
          "currency": "USD",
          "manufacture_country": "US",
          "max_delivery_time": "2016-07-23T00:00:00Z",
          "max_ship_time": "2016-07-23T00:00:00Z",
          "quantity": 20,
          "sku": "HM-123",
          "title": "Hippo Magazines",
          "total_price": "12.1",
          "variant_title": "June Edition",
          "weight": "0.4",
          "weight_unit": "lb",
          "object_id": "abf7d5675d744b6ea9fdb6f796b28f28"
        }
      ],
      "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
      "object_owner": "shippotle@shippo.com",
      "shop_app": "Shippo"
    }
  ]
}

Changes