Retrieve packing slip
/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_idintegerExample:980191049invoice_numberstringExample:INV-42orderobjectShow 3 child attributesHide child attributes
shopify_order_idstringExample:gid://shopify/Order/42namestringExample:#1042numberinteger, nullable
pdfobjectShow 4 child attributesHide child attributes
availablebooleanExample:falsefilenamestring, nullableurlstring, nullablegenerated_atstring, nullable
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The resource does not exist for this shop, or no action is registered at this path.
The request failed validation. Nothing was saved.
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.
curl "https://app.invoicefalcon.com/api/v3/external/documents/packing_slips/{invoice_id}" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/packing_slips/{invoice_id}", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/documents/packing_slips/{invoice_id}",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/packing_slips/{invoice_id}")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}