Skip to main content

supplyCreateShipment

Creates a new supply shipment that tracks product movement from suppliers to your facilities.

Authentication​

Requires authentication and the supply:create_shipment permission.

Behavior​

  • If shipmentNumber is not provided, a unique number will be automatically generated based on your brand's configuration.
  • Shipment items can be linked to purchase order line items via poItemId on each item.
  • The shipment type (STANDARD, BLIND, RETURN, TRANSFER) classifies the shipment. Use destinationBuildingId to specify the arrival facility when the shipment is destined for a warehouse.
  • Shipment creation is processed asynchronously and returns a process ID for tracking.

Validation Rules​

  • brandId must be provided and the brand must exist.
  • shipmentType is required (STANDARD, BLIND, RETURN, TRANSFER).
  • If shipmentItems are provided, they must reference valid products associated with the brand.

Possible Errors​

  • Brand not found - The specified brand does not exist.
  • Destination building not found - The specified building ID does not exist.

Plan Requirement​

Requires a plan that includes the supply chain module. Companies on Studio receive an ALLOWANCE_DENIED (402) error.

supplyCreateShipment(
  input: CreateSupplyShipmentInput!
): AsynchronousActionResponse

Arguments​

supplyCreateShipment.input ● CreateSupplyShipmentInput! non-null input common​

Parameters for CreateSupplyShipment

Type​

AsynchronousActionResponse object common​

Asynchronous action response type