Skip to main content

supplyShipmentIntegrationStates

Reads where each selected shipment stands in a downstream system, for a single-shipment dialog or a bulk arrival-date preview.

Business Rules​

  • Between one and 50 shipments per request, each belonging to the company.
  • The integration must support shipment state lookup.
  • Each shipment gets its own state; one that cannot be read is UNREADABLE with a reason, and the others still answer.
  • Neither system is changed by asking.

Error Scenarios​

  • **NOT_FOUND**: the integration or a shipment does not exist.
  • **VALIDATION**: the integration does not support shipment state lookup, or the selection is empty or too large.

Permissions Required​

  • integration:read_external_data permission.
supplyShipmentIntegrationStates(
  integrationId: ID!
  shipmentIds: [ID!]!
): [SupplyShipmentIntegrationState!]!

Arguments​

supplyShipmentIntegrationStates.integrationId ● ID! non-null scalar common​

The integration to ask.

supplyShipmentIntegrationStates.shipmentIds ● [ID!]! non-null scalar common​

The shipments to read, at most 50.

Type​

SupplyShipmentIntegrationState object shipments​

Where a shipment stands in a downstream system, read from that system when asked.