shipmentsStickersUrl

Requires permission sales:shipment:read.

A signed link to ONE shipping-sticker PDF covering many shipments (bulk print from the Shipments list, at most 100 ids). Same content as shipmentStickerUrl.

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 ShipmentsStickersUrl($ids: [ID!]!) {
  shipmentsStickersUrl(ids: $ids)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ShipmentsStickersUrl($ids: [ID!]!) {\n  shipmentsStickersUrl(ids: $ids)\n}",
  "variables": {
    "ids": [
      "id"
    ]
  }
}
EOF

Variables:

{
  "ids": [
    "id"
  ]
}

Response:

{
  "data": {
    "shipmentsStickersUrl": "string"
  }
}

shipmentsStickersUrl(
  format: ShipmentStickerFormat
  ids: [ID!]!
): String!

Arguments

shipmentsStickersUrl.format ● ShipmentStickerFormat enum

The label layout to produce.

shipmentsStickersUrl.ids ● [ID!]! non-null scalar

The IDs of the shipments.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.