---
title: "Search shipments"
method: GET
path: "/shipments"
tags: ["Shipments"]
---

# Search shipments

`GET /shipments`

Search for specific shipment details or get all existing shipment details. Shipments are automatically created based on the Item/Offer configuration. If Item is shippable a shipment is created. How many and how frequently a shipment is scheduled is dependant on the Offer. A shipment can contain a single or multiple items.

## Query parameters

- `shipment_id` string
- `order_id` integer
- `customer_id` integer
- `shipment_tracking_id` string
- `date_created_from` string, date-time
- `date_created_to` string, date-time
- `date_complete_from` string, date-time
- `date_complete_to` string, date-time
- `date_scheduled_from` string, date-time
- `date_scheduled_to` string, date-time
- `date_cancel_from` string, date-time
- `date_cancel_to` string, date-time
- `date_post_from` string, date-time
- `date_post_to` string, date-time
- `date_scan_from` string, date-time
- `date_scan_to` string, date-time
- `date_deliver_from` string, date-time
- `date_deliver_to` string, date-time
- `campaign_id` integer
- `item_sku` string
- `connection_id` integer
- `shipment_status_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 — * `1` - Pending Post * `2` - Pending Tracking * `3` - Cancelled * `4` - Shipped * `5` - Error * `6` - Delivered * `7` - Declined * `8` - Pending Transaction * `9` - Skipped
- `is_test` boolean
- `shipment_parent_type_id` null | 1 | 2 | 3 | 4, nullable — * `1` - Reship * `2` - Reward * `3` - Gift * `4` - Free
- `ship_city` string
- `ship_state` string
- `ship_zipcode` string
- `ship_country` string
- `shipment_rma` string
- `rma_status_id` null | 1 | 2, nullable — * `1` - Pending Return * `2` - Returned
- `with` 'shipment_items' | 'customer_address_billing' | 'customer_address_shipping' | 'campaign' | 'connection' | 'tracking_history' | 'actions'
- `limit` integer
- `offset` integer
- `sort_by` string
- `order` 'asc' | 'desc'

## Response `200`

OK

- object
  - `total` integer
  - `shipments` object[]
    - `shipment_id` integer
    - `connection_shipment_id` string, nullable
    - `customer_id` integer
    - `order_id` integer
    - `shipment_prepaid_cycle` integer
    - `shipment_status_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 — * `1` - Pending Post * `2` - Pending Tracking * `3` - Cancelled * `4` - Shipped * `5` - Error * `6` - Delivered * `7` - Declined * `8` - Pending Transaction * `9` - Skipped
    - `transaction_charge_id` integer
    - `connection_id` integer, nullable
    - `fulfillment_id` string, nullable
    - `shipment_tracking_id` string, nullable
    - `carrier_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9, nullable — * `1` - USPS * `2` - UPS * `3` - FedEx * `4` - DHL eCommerce * `5` - UPS Mail Innovations * `6` - Canada Post * `8` - Australia Post * `9` - Hermes
    - `shipping_profile_id` integer, nullable
    - `date_cancel` string, date-time, nullable
    - `date_scheduled` string, date-time
    - `date_complete` string, date-time, nullable
    - `date_scan` string, date-time, nullable
    - `date_deliver` string, date-time, nullable
    - `date_return` string, date-time, nullable
    - `date_skip` string, date-time, nullable
    - `date_rma` string, date-time, nullable
    - `shipment_rma` string, nullable
    - `cancel_type_id` integer, nullable
    - `skip_type_id` integer, nullable
    - `shipping_reship_type_id` null | 1 | 2 | 3 | 4, nullable — * `1` - Did not receive package * `2` - Damaged Items * `3` - Items Incorrect * `4` - Quantity Incorrect
    - `shipment_parent_type_id` null | 1 | 2 | 3 | 4, nullable — * `1` - Reship * `2` - Reward * `3` - Gift * `4` - Free
    - `date_created` string, date-time
    - `created_by` integer
    - `date_modified` string, date-time
    - `modified_by` integer
    - `shipment_notes` string, nullable
    - `connection_request_text` string, nullable
    - `connection_response_text` string, nullable
    - `shipment_items` object[]
      - `shipment_item_id` integer
      - `quantity` integer
      - `item_id` integer
      - `item_name` string
      - `item_description` string, nullable
      - `item_additional_description` string, nullable
      - `item_image` string, nullable
      - `shipment_item_sku` string, nullable
      - `items_option_variation_id` integer, nullable
    - `customer_address_billing` object
      - `customer_address_id` integer
      - `fname` string
      - `lname` string
      - `organization` string
      - `address1` string
      - `address2` string
      - `city` string
      - `country` string
      - `state` string
      - `zipcode` string
      - `address_valid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `customer_address_shipping` object
      - `customer_address_id` integer
      - `fname` string
      - `lname` string
      - `organization` string
      - `address1` string
      - `address2` string
      - `city` string
      - `country` string
      - `state` string
      - `zipcode` string
      - `address_valid` boolean
      - `date_created` string, date-time
      - `date_modified` string, date-time
      - `created_by` integer
      - `modified_by` integer
    - `campaign` object
      - `campaign_id` integer
      - `campaign_name` string
    - `connection` object, nullable
      - `connection_id` integer
      - `connection_name` string
    - `tracking_history` object[]
      - `tracking_history_id` integer
      - `carrier_id` integer, nullable
      - `date` string, date-time, nullable
      - `category_id` integer, nullable
      - `category_name` string, nullable
      - `status_id` integer, nullable
      - `status_text` string, nullable
    - `actions` object
      - `can_change_address` boolean
      - `can_process` boolean
      - `can_reschedule` boolean
      - `can_rma` boolean
      - `can_skip` boolean
      - `can_swap` boolean
      - `can_unskip` boolean

## Other responses

- `401` — Unauthorized response
- `403` — Forbidden response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/versions/62037010356e/schema)