Skip to content

Retrieve packing slip

GET/documents/packing_slips/{invoice_id}

Costs 1 rate-limit point · Rate limits

Whether a packing slip PDF is stored for an invoice, and a one-week signed URL to it when it is. A packing slip is the invoice rendered through a packing-slip template; it exists only after it was printed or downloaded once. Read-only: it never renders the PDF.

Also searched aspacking slip for invoicepacking slip pdfis there a packing slipdownload packing slipdelivery note for order

Path parameters

  • invoice_idstringRequired

Returns

  • invoice_idinteger
    Example: 980191049
  • invoice_numberstring
    Example: INV-42
  • orderobject
    Show 3 child attributesHide child attributes
    • shopify_order_idstring
      Example: gid://shopify/Order/42
    • namestring
      Example: #1042
    • numberinteger, nullable
  • pdfobject
    Show 4 child attributesHide child attributes
    • availableboolean
      Example: false
    • filenamestring, nullable
    • urlstring, nullable
    • generated_atstring, nullable

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

404

The resource does not exist for this shop, or no action is registered at this path.

422

The request failed validation. Nothing was saved.

429

Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.

Every error has the same shape: see Errors.

GET/documents/packing_slips/{invoice_id}
curl "https://app.invoicefalcon.com/api/v3/external/documents/packing_slips/{invoice_id}" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "invoice_id": 980191049,
  "invoice_number": "INV-42",
  "order": {
    "shopify_order_id": "gid://shopify/Order/42",
    "name": "#1042",
    "number": null
  },
  "pdf": {
    "available": false,
    "filename": null,
    "url": null,
    "generated_at": null
  }
}