Shipments / Index

Name	Shipments Index
Description	List all shipments owned by your office.
Type	GET
URL	/v9/shipments

Long Description

List all shipments for all orders belonging to your brokerage.

Parameters

Name	Description	Value Type	Required

Name	Description	Value Type	Required
`order_id`	Filter to those belonging to this order	integer	Optional
`type`	Filter to type. One of: `Delivery::FedEx` `Delivery::Eticket` `Delivery::UPS` `Delivery::Courier` `Delivery::WillCall` `Delivery::TBD` `Delivery::LocalPickup` `Delivery::PickupAtOffice` `Delivery::Custom` `Delivery::Offline` `Delivery::InstantDelivery` `Delivery::Paperless` `Delivery::FlashSeats` `Delivery::TMMobile` `Delivery::TMMobileLink` `Delivery::ProvidedAirbill`	string	Optional
`state`	Filter by shipment state. One of `pending` `in_transit` `in_exception` `delivered` `returned` `canceled`	string	Optional
`tracking_number`	Filter by tracking number	string	Optional
`created_at`	Filter by shipment created_at range	Date	Optional
`updated_at`	Filter by shipment updated_at range	Date	Optional

Examples

GET /v9/shipments?order_id=181001&page=1&per_page=1 HTTP/1.1

{
  "total_entries": 1,
  "current_page": 1,
  "per_page": 1,
  "shipments": [
    {
      "id": 75054,
      "url": "/shipment/75054",
      "updated_at": "2018-04-12T20:24:22Z",
      "created_at": "2018-04-12T20:23:42Z",
      "tracking_number": null,
      "name": null,
      "state": "pending",
      "type": "FlashSeats",
      "cost": "0.0",
      "notes": null,
      "email_address": {
        "id": 212025,
        "url": null,
        "address": "moe@moestavern.com",
        "label": null,
        "updated_at": "2018-04-12T20:24:22Z"
      },
      "ship_to_company_name": null,
      "ship_to_name": "Moe Szyslak",
      "courier_company": null,
      "service_type": "LEAST_EXPENSIVE",
      "signature_type": "",
      "service_type_display": "",
      "airbill": "",
      "residential": null,
      "order": {
        "id": 181002,
        "url": "/orders/181002"
      },
      "address": {
        "id": 648264,
        "label": null,
        "name": null,
        "street_address": "36600 North Pima Road",
        "extended_address": "Suite 303-4",
        "cross_street": null,
        "po_box": false,
        "locality": "Carefree",
        "region": "AZ",
        "postal_code": "85377",
        "country_code": "US",
        "latitude": null,
        "longitude": null,
        "primary": false
      },
      "phone_number": "4805551212",
      "shipment_snapshot": {
        "id": 75054,
        "type": "FlashSeats",
        "po_box": "false",
        "locality": "Carefree",
        "postal_code": "85377",
        "region": "AZ",
        "country_code": "US",
        "available": null,
        "carrier": null,
        "name": null,
        "company": null,
        "label": null,
        "email_address": "moe@moestavern.com",
        "phone_number": "4805551212",
        "street_address": "36600 North Pima Road",
        "extended_address": "Suite 303-4",
        "cross_street": null
      },
      "available": false,
      "carrier": null,
      "items": [
        {
          "id": 136020,
          "price": "7.0",
          "quantity": 2,
          "ticket_group": {
            "id": "453545098",
            "url": "/ticket_groups/453545098",
            "remote_id": null,
            "office_id": "2943",
            "retail_price": null,
            "wholesale_price": "7.0",
            "quantity": null,
            "event": {
              "id": "982604",
              "url": "/events/982604",
              "name": "Test Event (Do Not Purchase)",
              "occurs_at": "2019-02-28T19:00:00Z",
              "event_tbd": null,
              "venue": {
                "id": "29256",
                "url": "/venues/29256",
                "name": "Test Venue",
                "address": {
                  "locality": "Testville",
                  "region": "CA"
                }
              }
            }
          }
        }
      ]
    }
  ]
}