Choose a version:

inventory_shipments

The inventory_shipments schema captures shipment line items that move inventory between locations. It focuses on shipment quantities, outcomes, and the transfer or operational context attached to the shipment.

Anchor to Use casesUse cases

Quantities: Compare shipped_quantity and received_quantity by shipment_name to spot shortfalls between what was sent and what arrived.
Outcomes: Group accepted_quantity and rejected_quantity by shipment_status to review shipment outcomes.
Attribution: Track shipment_count by shipment_app_name or staff_id to break shipments down by app or staff.

Examples

ShopifyQL

View in adminView query results in the ShopifyQL editor

FROM inventory_shipments

SHOW acceptance_rate, rejection_rate, shipment_count

GROUP BY carrier

HAVING shipment_count > 5

DURING this_quarter

ORDER BY rejection_rate DESC

LIMIT 25

VISUALIZE rejection_rate TYPE horizontal_bar

Examples

Description
Rank carriers by `rejection_rate` this quarter, with acceptance rate and shipment count. This example uses [`HAVING`](/docs/api/shopifyql/latest/syntax/having) `shipment_count > 5` to drop low-volume carriers from the ranking.
ShopifyQL
```
FROM inventory_shipments
  SHOW acceptance_rate, rejection_rate, shipment_count
  GROUP BY carrier
  HAVING shipment_count > 5
  DURING this_quarter
  ORDER BY rejection_rate DESC
  LIMIT 25
VISUALIZE rejection_rate TYPE horizontal_bar
```
Description
Track weekly `shipped_quantity` by destination country as a stacked area across this quarter. This example pairs [`PERCENT_CHANGE`](/docs/api/shopifyql/latest/syntax/with#percent-change-columns) with [`COMPARE TO previous_period`](/docs/api/shopifyql/latest/syntax/compare-to) to add a column measuring each week against the prior quarter.
ShopifyQL
```
FROM inventory_shipments
  SHOW shipped_quantity, received_quantity, unique_items_shipped
  GROUP BY destination_country WITH PERCENT_CHANGE
  TIMESERIES week
  DURING this_quarter
  COMPARE TO previous_period
  ORDER BY week ASC
VISUALIZE shipped_quantity TYPE stacked_area
```
Description
Track weekly `accepted_quantity` and `rejected_quantity` across this quarter. This example uses [`WITH TOTALS`](/docs/api/shopifyql/latest/syntax/with#total-columns) to add a quarter-to-date total beside the weekly rows.
ShopifyQL
```
FROM inventory_shipments
  SHOW accepted_quantity, rejected_quantity
  TIMESERIES week WITH TOTALS
  DURING this_quarter
  ORDER BY week ASC
VISUALIZE accepted_quantity, rejected_quantity TYPE line
```
Description
Compare monthly `received_quantity` this year against last year. This example uses [`COMPARE TO previous_year`](/docs/api/shopifyql/latest/syntax/compare-to) to set last year as the year-over-year baseline.
ShopifyQL
```
FROM inventory_shipments
  SHOW received_quantity
  TIMESERIES month WITH PERCENT_CHANGE
  DURING this_year
  COMPARE TO previous_year
  ORDER BY month ASC
VISUALIZE received_quantity TYPE bar
```

Anchor to MetricsMetrics

Counts and calculations that let you track key business indicators. Metrics show up as the columns when queried.

Metrics you can use when querying FROM inventory_shipments.

Anchor to acceptance_rate acceptance_rate: If no items were received in the results, acceptance_rate is null.

Acceptance rate = accepted_quantity / received_quantity
Anchor to accepted_quantity accepted_quantity: Quantity accepted after quality checks
Anchor to received_quantity received_quantity: Quantity received at destination locations
Anchor to rejected_quantity rejected_quantity: Quantity rejected due to quality issues or damage
Anchor to rejection_rate rejection_rate: If no items were received in the results, then rejection_rate is null.

Rejection rate = rejected_quantity / received_quantity
Anchor to shipment_count shipment_count: Number of unique shipments
Anchor to shipped_quantity shipped_quantity: Quantity shipped between locations
Anchor to unique_items_shipped unique_items_shipped: Number of unique inventory items shipped

Anchor to DimensionsDimensions

Attributes of your data that let you look more granularly at aspects of the data. Group and filter by dimensions to shape the rows your query returns.

Dimensions you can use when querying FROM inventory_shipments.

Anchor to carrier carrier: Name of the shipping carrier company
Anchor to carrier_code carrier_code: Carrier code or abbreviation (like UPS, FEDEX, USPS)
Anchor to day day: The day a shipment was created.
Anchor to day_of_week day_of_week: The day of week a shipment was created, with values Monday through Sunday.
Anchor to expected_delivery_at expected_delivery_at: Estimated date and time the shipment will arrive
Anchor to hour hour: The hour a shipment was created.
Anchor to hour_of_day hour_of_day: The hour of day a shipment was created, with values 0 through 23.
Anchor to inventory_destination_id inventory_destination_id: The unique Shopify identifier for the location receiving the inventory. Use inventory_destination_id to filter to a specific receiving location. Use it with destination_name to show readable labels.
Anchor to inventory_item_id inventory_item_id: The unique Shopify identifier for the inventory item on the shipment line item. Use inventory_item_id to filter to a specific item. Use it with product_variant_sku or product_variant_title to show readable labels.
Anchor to inventory_origin_id inventory_origin_id: The unique Shopify identifier for the location sending the inventory. Use inventory_origin_id to filter to a specific sending location. Use it with inventory_origin_name to show readable labels.
Anchor to inventory_shipment_id inventory_shipment_id: The unique Shopify identifier for the shipment. Use inventory_shipment_id to filter to one shipment or to break results down by shipment.
Anchor to inventory_shipment_line_item_id inventory_shipment_line_item_id: The unique Shopify identifier for the shipment line item. Use inventory_shipment_line_item_id to filter to a specific line in a shipment.
Anchor to inventory_transfer_id inventory_transfer_id: The unique Shopify identifier for the inventory transfer that created the shipment. Use inventory_transfer_id to connect shipment line items back to a specific transfer.
Anchor to minute minute: The minute a shipment was created.
Anchor to month month: The month a shipment was created.
Anchor to month_of_year month_of_year: The month of year a shipment was created, with values 1 through 12.
Anchor to product_variant_id product_variant_id: The unique Shopify identifier for the product variant on the shipment line item. Use product_variant_id to filter to a specific variant. Use it with product_variant_title or product_variant_sku to show readable labels.
Anchor to quarter quarter: The quarter a shipment was created.
Anchor to second second: The second a shipment was created.
Anchor to shipment_app_id shipment_app_id: The Shopify identifier for the app that created the shipment. Use shipment_app_id to filter to a specific app. Use it with shipment_app_name to show readable labels.
Anchor to shipment_app_name shipment_app_name: Name of the app or integration that created the shipment
Anchor to shipment_name shipment_name: The readable shipment label that combines the related transfer label with the shipment number. Use shipment_name to identify specific shipments in results.
Anchor to shipment_received_at shipment_received_at: Date and time the shipment was initially received
Anchor to shipment_shipped_at shipment_shipped_at: Date and time the shipment was shipped
Anchor to shipment_status shipment_status: Values include Draft, In transit, Received, and Partially received.
Anchor to shop_id shop_id: The unique Shopify identifier for your store. Use shop_id with shop_name to show readable store labels.
Anchor to staff_id staff_id: The unique Shopify identifier for the staff member who created or managed the shipment. Use staff_id to filter to a specific staff member. Use it with staff_member_name to show readable labels.
Anchor to tracking_number tracking_number: Tracking number used by the carrier to identify the shipment
Anchor to tracking_url tracking_url: URL to track the shipment on the carrier's website
Anchor to week week: The week a shipment was created.
Anchor to week_of_year week_of_year: The week of year a shipment was created, with values 1 through 53.
Anchor to year year: The year a shipment was created.
Anchor to destination_city destination_city: City of the location that's receiving inventory
Anchor to destination_country destination_country: Country where the inventory destination location is located
Anchor to destination_name destination_name: Name of the location receiving inventory
Anchor to destination_region destination_region: Province or state of the location that's receiving inventory (e.g., California, Ontario)
Anchor to shop_name shop_name: Name of your store
Anchor to inventory_cost_is_recorded inventory_cost_is_recorded: Whether the inventory item has a cost saved in Shopify, with values true and false.
Anchor to inventory_is_tracked inventory_is_tracked: Whether Shopify tracks inventory adjustments for the inventory item, with values true and false.
Anchor to inventory_item_cost inventory_item_cost: The cost recorded for one unit of the inventory item, in your store's currency.
Anchor to inventory_origin_city inventory_origin_city: City of the location that's sending inventory transfers
Anchor to inventory_origin_country inventory_origin_country: Country of the location that's sending inventory transfers
Anchor to inventory_origin_name inventory_origin_name: Name of the location sending inventory transfers
Anchor to inventory_origin_region inventory_origin_region: Province or state of the location that's sending inventory transfers (e.g., California, Ontario)
Anchor to transfer_created_at transfer_created_at: The date and time the inventory transfer was created, reported in your store's time zone.
Anchor to transfer_name transfer_name: The display name of the inventory transfer. If no name is set, the transfer number can appear.
Anchor to transfer_note transfer_note: Additional note attached to the inventory transfer
Anchor to transfer_reference_name transfer_reference_name: Reference name of the inventory transfer
Anchor to transfer_status transfer_status: The current status of the inventory transfer, with values such as Draft, In progress, Ready to ship, and Transferred.
Anchor to transfer_tags transfer_tags: Custom tags assigned to the inventory transfer
Anchor to product_variant_sku product_variant_sku: SKU of the product variant
Anchor to product_variant_title product_variant_title: Display name of the product variant
Anchor to staff_member_name staff_member_name: Name of the staff member associated with the order

STRING

A sequence of characters representing text data.

DAY_TIMESTAMP

A date value truncated to day precision.

DAY_OF_WEEK

A day within a week, used for weekday-based grouping and filtering.

TIMESTAMP

A full-precision timestamp including date and time.

HOUR_TIMESTAMP

A timestamp truncated to hour precision.

HOUR_OF_DAY

An hour within a day, typically represented as an integer from 0 to 23.

IDENTITY

A unique identifier for a Shopify resource such as a customer, product, or order.

MINUTE_TIMESTAMP

A timestamp truncated to minute precision.

MONTH_TIMESTAMP

A date value representing the start of a month.

MONTH_OF_YEAR

A month number within a year.

QUARTER_TIMESTAMP

A date value representing the start of a fiscal quarter.

SECOND_TIMESTAMP

A timestamp truncated to second precision.

WEEK_TIMESTAMP

A date value representing the start of a week.

WEEK_OF_YEAR

A week number within a year.

YEAR_TIMESTAMP

A date value representing the start of a year.

BOOLEAN

A true or false value representing binary states.

MONEY

A monetary amount representing currency values such as prices, revenue, costs, and discounts.

Anchor to Related schemasRelated schemas

inventory_by_location: Destination location inventory state that shipments arrive into.
inventory_transfers: Stock moves between locations alongside incoming shipments.
inventory: Store-wide inventory state replenished by these shipments.

Was this page helpful?