Search shipments

get

https://api.vrio.app/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 Params

shipment_id

string

Search for specific shipment ID(s). Comma separate for multiple.

order_id

integer

Search for shipments belonging to a specific order ID.

customer_id

integer

Search for shipments belonging to a specific customer ID.

shipment_tracking_id

string

Search for shipments tby tracking number.

date_created_from

date-time

Return only shipments that were created on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_created_to

date-time

Return only shipments that were created on or before this date. Required when passing date_created_from. Maximum date range: 31 days.

date_complete_from

date-time

Return only shipments that were completed (shipped) on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_complete_to

date-time

Return only shipments that were completed (shipped) on or before this date. Required when passing date_complete_from. Maximum date range: 31 days.

date_scheduled_from

date-time

Return only shipments that were scheduled on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_scheduled_to

date-time

Return only shipments that were scheduled on or before this date. Required when passing date_scheduled_from. Maximum date range: 31 days.

date_cancel_from

date-time

Return only shipments that were cancelled on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_cancel_to

date-time

Return only shipments that were cancelled on or before this date. Required when passing date_cancel_from. Maximum date range: 31 days.

date_post_from

date-time

Return only shipments that were posted to fulfillment on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_post_to

date-time

Return only shipments that were posted to fulfillment on or before this date. Required when passing date_post_from. Maximum date range: 31 days.

date_scan_from

date-time

Return only shipments that were scanned by a carrier on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_scan_to

date-time

Return only shipments that were scanned by a carrier on or before this date. Required when passing date_scan_from. Maximum date range: 31 days.

date_deliver_from

date-time

Return only shipments that were delivered on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_deliver_to

date-time

Return only shipments that were delivered on or before this date. Required when passing date_deliver_from. Maximum date range: 31 days.

campaign_id

integer

Search for shipments belonging to a specific campaign ID.

item_sku

string

Search for shipments that have a specific item sku.

connection_id

integer

Search for shipments by the fulfillment connection ID.

shipment_status_id

integer

enum

Search for shipments by status.

1 - Pending Post
2 - Pending Tracking
3 - Cancelled
4 - Shipped
5 - Error
6 - Delivered
7 - Declined
8 - Pending Transaction
9 - Skipped

is_test

boolean

Search for shipments that are associated with test orders.

shipment_parent_type_id

integer | null

enum

Search for shipments that were not created at the time that the order was placed.

1 - Reship
2 - Reward
3 - Gift
4 - Free
5 - Split

Allowed:

ship_city

string

Search for shipments that are being sent to a specific city.

ship_state

string

Search for shipments that are being sent to a specific state.

ship_zipcode

string

Search for shipments that are being sent to a specific zipcode.

ship_country

string

Search for shipments that are being sent to a specific country. 2 letters (example : US).

shipment_rma

string

Search for shipments by RMA

rma_status_id

integer | null

enum

Search for shipments by RMA status.

1 - Pending Return
2 - Returned

Allowed:

with

string

enum

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=shipment_items,customer_address_shipping)

Allowed:

limit

integer

Limit the number of results. Default: 25, max: 200.

offset

integer

Offset the results

sort_by

string

Field to sort result by

order

string

enum

Order by asc or desc

Allowed:

Responses

200OK

401Unauthorized response

403Forbidden response

500Error response