shipmentProofOfDeliveryUrl

Requires permission sales:shipment:read.

Returns a short-lived download link for the shipment's proof of delivery, or null when there is none. Needs the shipment read permission.

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

cURL

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

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "shipmentProofOfDeliveryUrl": "string"
  }
}

shipmentProofOfDeliveryUrl(
  id: ID!
): String

Arguments

shipmentProofOfDeliveryUrl.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.