productDeliveryFlags

Requires permission products:product:read.

Returns a product's delivery flags: whether it ships in its own packaging and whether it is fragile. Requires permission to read products.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ProductDeliveryFlags($productId: ID!) {
  productDeliveryFlags(productId: $productId) {
    categoryOwnPackaging
    effectiveOwnPackaging
    fragile
    ownPackaging
    productId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ProductDeliveryFlags($productId: ID!) {\n  productDeliveryFlags(productId: $productId) {\n    categoryOwnPackaging\n    effectiveOwnPackaging\n    fragile\n    ownPackaging\n    productId\n  }\n}",
  "variables": {
    "productId": "id"
  }
}
EOF

Variables:

{
  "productId": "id"
}

Response:

{
  "data": {
    "productDeliveryFlags": {
      "categoryOwnPackaging": true,
      "effectiveOwnPackaging": true,
      "fragile": true,
      "ownPackaging": true,
      "productId": "id"
    }
  }
}

productDeliveryFlags(
  productId: ID!
): ProductDeliveryFlags!

Arguments

productDeliveryFlags.productId ● ID! non-null scalar

The ID of the product.

Type

ProductDeliveryFlags object

A product's delivery flags (Product.metadata.deliveryFlags), for every variant: own packaging and fragile. Null = not set.