shipmentStickerUrl

Requires permission sales:shipment:read.

A signed link to the shipping sticker PDF of one shipment (our own box label: sender, recipient, order and shipment numbers, courier, AWB barcode, tracking QR, box n of N). One page per box.

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 ShipmentStickerUrl($id: ID!) {
  shipmentStickerUrl(id: $id)
}

cURL

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

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "shipmentStickerUrl": "string"
  }
}

shipmentStickerUrl(
  format: ShipmentStickerFormat
  id: ID!
): String!

Arguments

shipmentStickerUrl.format ● ShipmentStickerFormat enum

The label layout to produce.

shipmentStickerUrl.id ● ID! non-null scalar

The ID of the shipment.

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.