mobileOrderSummaryPdf

Requires a customer (portal or buyer app) session.

Base64 PDF summary of one of the buyer's placed orders: its lines, delivery address and choice, bill, payment method and status, the online payment's receipt when captured, and for a bank transfer the account to pay into with the order's transfer reference and any proofs of payment the buyer attached. The buyer app's "Order placed" screen downloads and shares this one file. Nothing is persisted.

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 MobileOrderSummaryPdf($orderId: ID!) {
  mobileOrderSummaryPdf(orderId: $orderId)
}

cURL

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

Variables:

{
  "orderId": "id"
}

Response:

{
  "data": {
    "mobileOrderSummaryPdf": "string"
  }
}

mobileOrderSummaryPdf(
  bankAccountId: ID
  orderId: ID!
): String!

Arguments

mobileOrderSummaryPdf.bankAccountId ● ID scalar

Bank transfer: the seller account picked at checkout. Used only while no transfer is registered, and only when it is one of the accounts offered for this order; otherwise the default account prints.

mobileOrderSummaryPdf.orderId ● ID! non-null scalar

The ID of one of the buyer's own orders.

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.