mobileCartSummaryPdf

Requires a customer (portal or buyer app) session.

Base64 PDF summary of the buyer's checkout: the cart lines, the delivery address and the same bill mobileCartBill returns for this deliveryOptionId. A printout of the cart — no order or document is created.

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 MobileCartSummaryPdf {
  mobileCartSummaryPdf
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MobileCartSummaryPdf {\n  mobileCartSummaryPdf\n}"
}
EOF

Response:

{
  "data": {
    "mobileCartSummaryPdf": "string"
  }
}

mobileCartSummaryPdf(
  addressId: ID
  deliveryOptionId: ID
  paymentMethod: String
  paymentProvider: String
): String!

Arguments

mobileCartSummaryPdf.addressId ● ID scalar

The buyer's delivery address to print under "Deliver to". Must be one of their own addresses; omitted, the block is left out.

mobileCartSummaryPdf.deliveryOptionId ● ID scalar

the chosen live delivery option, exactly as passed to mobileCartBill.

mobileCartSummaryPdf.paymentMethod ● String scalar

The payment method chosen on checkout: EFT, ON_ACCOUNT or ONLINE. Any other value prints no payment method.

mobileCartSummaryPdf.paymentProvider ● String scalar

With ONLINE: the chosen gateway's provider key (mobilePaymentOptions). Printed by the store's own gateway name, never by client text.

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.