Skip to main content

getShipment

Triggers an asynchronous fetch of external shipment data for a V2 order fulfillment.

Business Rules​

  • The order must exist and be a V2 order.
  • The order must be in a status that allows external shipment queries (in_progress, shipped).
  • The fulfillment must belong to the specified order and be in the in_progress state.

Error Scenarios​

  • **NOT_FOUND**: when the order does not exist or is not a V2 order.
  • **NOT_FOUND**: when the fulfillment does not exist or does not belong to the order.
  • **UNPROCESSABLE_CONTENT**: when the order or fulfillment is in a status that does not allow querying.

Permissions Required​

  • orders:get_fulfillment_shipment permission
getShipment(
  input: GetShipmentInput!
): GetShipmentPayload

Arguments​

getShipment.input ● GetShipmentInput! non-null input common​

Parameters for GetShipment

Type​

GetShipmentPayload object common​

Autogenerated return type of GetShipment.