# Get Shipments

Get the list of paginated shipments by different search parameters.

Endpoint: GET /shipments
Version: 3.0
Security: bearerAuth

## Query parameters:

  - `from_date` (string)
    return shipments with a created_at on or after the given date

  - `to_date` (string)
    return shipments with a created_at greater than or equal to the given date.

  - `ship_code` (string)
    search by ship code

  - `to_name` (string)
    search by recipient

  - `tracking_code` (string)
    search by tracking code

  - `order_id` (string)
    search by order id

  - `batch_id` (string)
    search by batch id

  - `closeout_id` (string)
    search by closeout id

  - `status` (array)
    search by shipment statuses
    Enum: "unpaid", "postage-expired", "pending", "incomplete", "ready", "received", "processing", "in-transit", "delivered", "exception", "void-requested", "voided", "complete"

  - `limit` (integer)
    number of records to return per page

  - `page` (integer)
    the current page number of the response

## Response 200 fields (application/json):

  - `data` (array)
    Example: [null]

  - `data.ship_code` (string)
    Example: "2019JHSJDHSJ"

  - `data.name` (string)
    Example: "Pramod Thomson"

  - `data.address1` (string)
    Example: "30 Clearview Dr"

  - `data.address2` (string)
    Example: "Lot 2"

  - `data.city` (string)
    Example: "Rock Springs"

  - `data.province_code` (string)
    Example: "WY"

  - `data.postal_code` (string)
    Example: "82901"

  - `data.country_code` (string)
    Example: "US"

  - `data.weight_unit` (string)
    Enum: "lbs", "kg", "g", "oz"

  - `data.weight` (number)
    Example: 0.6

  - `data.length` (number)
    Example: 9

  - `data.width` (number)
    Example: 12

  - `data.height` (number)
    Example: 1

  - `data.size_unit` (string)
    Enum: "cm", "in"

  - `data.package_contents` (string)
    Example: "3 underwear"

  - `data.value` (number)
    Example: 10

  - `data.currency` (string)
    Enum: "CAD", "USD", "EUR", "AUD", "GBP"

  - `data.package_type` (string)
    Enum: "Parcel", "Legal Flat Rate Envelope", "Flat Rate PAdded Envelope", "Small Flat Rate Box", "Medium Flat Rate Box 1", "Medium Flat Rate Box 2", "Large Flat Rate Box", "Regional Rate Box A1", "Regional Rate Box A2", "Regional Rate Box B1", "Regional Rate Box B2", "Letter", "Large Envelope Or Flat", "Thick Envelope"

  - `data.postage_type` (string)
    Enum: "USPS First Class Mail", "USPS Priority Mail", "USPS Priority Mail Express", "USPS Parcel Select Ground", "USPS Media Mail", "USPS Library Mail", "USPS Express Mail International", "USPS Priority Mail International", "USPS First Class Mail International", "FedEx Ground", "UPS Standard", "PostNL International Packet", "PostNL International Packet Tracked", "APC Priority Worldwide", "APC Priority Worldwide Tracked", "APC Priority Worldwide Expedited", "APC Priority Worldwide Expedited(DDP)", "Stallion Economy USA", "Stallion Economy CA", "US Economy"

  - `data.tracking_code` (string)
    Example: "9400111969000940000011"

  - `data.rate` (integer)
    Example: 9

  - `data.tax` (integer)

  - `data.total_paid` (integer)

  - `data.insured` (boolean)
    Example: true

  - `links` (object)

  - `links.first` (string)
    Example: "https://sandbox.stallionexpress.ca/api/v3/shipments?page=1"

  - `links.last` (string)
    Example: "https://sandbox.stallionexpress.ca/api/v3/shipments?page=16"

  - `links.prev` (string)
    Example: "https://sandbox.stallionexpress.ca/api/v3/shipments?page=1"

  - `links.next` (string)
    Example: "https://sandbox.stallionexpress.ca/api/v3/shipments?page=3"

  - `meta` (object)

  - `meta.current_page` (integer)
    Example: 2

  - `meta.from` (integer)
    Example: 11

  - `meta.last_page` (integer)
    Example: 16

  - `meta.path` (string)
    Example: "https://sandbox.stallionexpress.ca/api/v3/shipments"

  - `meta.per_page` (integer)
    Example: 10

## Response 401 fields (application/json):

  - `message` (string)
    Example: "Unauthenticated."

## Response 422 fields (application/json):

  - `success` (boolean)

  - `errors` (array)
    Example: ["The data you entered is invalid"]

## Response 500 fields (application/json):

  - `success` (boolean)

  - `errors` (array)
    Example: ["An unknown error occured"]