> ## Documentation Index
> Fetch the complete documentation index at: https://www.zippendo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Fetch missing label
> Ask the carrier again for the label of a dispatched shipment whose label could not be downloaded when it was sent (it carries a LABEL_DOWNLOAD_FAILED error). Stores the label, clears the error and returns the shipment.
## OpenAPI
````yaml https://api.zippendo.com/public/json post /orgs/{orgId}/shipments/{shipmentId}/fetch-label
openapi: 3.0.0
info:
title: Zippendo Public API
description: >-
Public API documentation for Zippendo. Authenticate using your API token
(Bearer token prefixed with zipp_).
**Brands (sub-accounts).** An organization can be split into brands, each
keeping its own orders,
shipments and configuration separate. There are two ways to scope requests
to one brand, and
NEITHER changes any request body:
1. **Bind the token.** Create an API token with a `brandId` and every
request it makes is confined
to that brand — reads filtered, writes stamped. This is the recommended way to give a single
brand's team its own credential.
2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can
scope an individual
request by sending the brand's id or slug in this header. Most SDKs let you set it once on the
client so every call inherits it.
A brand-bound token that receives an `X-Zippendo-Brand` header naming a
different brand is
rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit
both and requests
cover the whole organization, which is the behaviour of every existing
token.
Records that belong to no brand carry `brandId: null`. Configuration
(carriers, shipping rules,
addresses) with a null brand is organization-wide and remains visible inside
every brand;
orders and shipments with a null brand are only visible organization-wide.
List endpoints additionally take a `?brandScope=own|shared|both` parameter
to narrow further
within whichever brand context already applies. `own` returns only rows
assigned to that brand,
and requires a brand context — a brand-bound token, a resolved brand
session, or the
`X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the
organization-wide
rows (equivalent to filtering `brandId=none`). The default, `both`, keeps
the existing behaviour:
a brand context sees its own rows plus the organization-wide ones. Set
`X-Zippendo-Brand-Scope`
as a client default to apply the same choice to every request instead of
repeating the query
parameter on each call — an explicit `brandScope` query parameter always
wins over the header,
and a blank header value is ignored.
Brands themselves are managed under the **Brands** tag. Retiring a brand is
done with
`POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a
dashboard-only action,
since it is refused while any order, shipment, member or token still
references the brand.
Brands require a plan that includes them; creating one beyond your plan's
limit returns `403`.
version: 1.0.0
contact:
name: Zippendo Support
email: support@zippendo.com
url: https://zippendo.com/support
license:
name: Proprietary
url: https://www.zippendo.com/legal
termsOfService: https://www.zippendo.com/legal/terms-of-service
servers:
- url: https://api.zippendo.com
description: Zippendo API
security:
- bearerAuth: []
paths:
/orgs/{orgId}/shipments/{shipmentId}/fetch-label:
post:
tags:
- Shipments
summary: Fetch missing label
description: >-
Ask the carrier again for the label of a dispatched shipment whose label
could not be downloaded when it was sent (it carries a
LABEL_DOWNLOAD_FAILED error). Stores the label, clears the error and
returns the shipment.
operationId: fetchShipmentLabel
parameters:
- schema:
type: string
example: org_1a2b3c4d
in: path
name: orgId
required: true
description: Organization identifier.
- schema:
type: string
example: shp_4d9e7a2f
in: path
name: shipmentId
required: true
description: Shipment identifier.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique shipment identifier.
example: shp_4d9e7a2f
reference:
type: string
description: Customer-facing shipment reference.
example: ORDER-1042
addressId:
nullable: true
description: Sender address identifier.
example: addr_7e8f9a0b
type: string
servicePointId:
nullable: true
description: Selected service point ID.
example: sp_pn_4521
type: string
parties:
type: array
items:
type: object
properties:
type:
type: string
enum:
- sender
- receiver
- pickup
- billing
- freight_payer
- service_point
- return
description: Role of the party in the shipment.
example: receiver
name:
type: string
minLength: 1
description: Full name or company name of the party.
example: Anna Jensen
attention:
nullable: true
description: Attention contact at the party.
example: Reception
type: string
address1:
type: string
minLength: 1
description: Primary street address line.
example: Vesterbrogade 12
address2:
nullable: true
description: Secondary address line.
example: 2. sal
type: string
postalCode:
type: string
minLength: 1
description: Postal code of the party address.
example: '1620'
city:
type: string
minLength: 1
description: City of the party address.
example: København V
countryCode:
type: string
minLength: 2
maxLength: 2
description: ISO 3166-1 alpha-2 country code.
example: DK
email:
nullable: true
description: Email address of the party.
example: anna@example.dk
type: string
format: email
pattern: >-
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone:
nullable: true
description: Phone number of the party in E.164 format.
example: '+4520123456'
type: string
attributes:
default: []
description: >-
Additional carrier-specific attributes for the
party.
type: array
items:
type: object
properties:
name:
type: string
minLength: 1
description: Name of the party attribute.
example: vatNumber
value:
type: string
minLength: 1
description: Value of the party attribute.
example: DK12345678
required:
- name
- value
additionalProperties: false
required:
- type
- name
- address1
- postalCode
- city
- countryCode
- attributes
additionalProperties: false
description: Parties involved in the shipment (sender, receiver, etc.).
type:
type: string
enum:
- outbound
- inbound
description: Direction of the shipment relative to the organization.
example: outbound
carrierSettings:
type: object
properties:
carrierId:
type: string
description: Identifier of the carrier to use.
example: car_pn_001
productId:
type: string
description: Identifier of the carrier product/service.
example: prod_mypack_home
services:
type: array
items:
type: string
description: Additional service codes requested from the carrier.
example:
- A7
additionalParameters:
type: object
additionalProperties:
anyOf:
- type: string
- type: number
- type: boolean
- type: object
properties:
id:
type: string
description: Identifier of the selected service point.
example: sp_pn_4521
name:
type: string
description: Display name of the service point.
example: Føtex Nørrebro
address:
type: string
description: Formatted address of the service point.
example: Nørrebrogade 20, 2200 København N
coordinates:
description: Latitude/longitude of the service point.
example:
- 55.6987
- 12.5501
type: array
items:
anyOf:
- type: number
- type: number
minItems: 2
maxItems: 2
required:
- id
- name
- address
additionalProperties: false
description: Carrier-specific extra parameters as key/value pairs.
example:
notificationEmail: anna@example.dk
required:
- carrierId
- productId
- services
- additionalParameters
additionalProperties: false
parcels:
type: array
items:
type: object
properties:
id:
description: Unique parcel identifier.
example: prc_5a6b7c8d
type: string
weight:
type: number
minimum: 0
description: Parcel weight in the given weight unit.
example: 2.5
weightUnit:
type: string
enum:
- kg
- g
- lb
- oz
description: Unit of measurement for parcel weight.
example: kg
dimensions:
type: object
properties:
length:
type: number
minimum: 0
description: Parcel length in centimetres.
example: 30
width:
type: number
minimum: 0
description: Parcel width in centimetres.
example: 20
height:
type: number
minimum: 0
description: Parcel height in centimetres.
example: 15
required:
- length
- width
- height
additionalProperties: false
orderLines:
type: array
items:
type: object
properties:
id:
description: Unique order line identifier.
example: ol_9c1d2e3f
type: string
orderLineId:
nullable: true
description: >-
ID of the order line this packed line came
from. Null when the item did not originate
from an order line, such as a free gift or a
replacement part.
example: clz9k2f0a0004abcd3456qrst
type: string
sku:
nullable: true
description: >-
Stock keeping unit of the product. Optional —
not every webshop assigns SKUs.
example: SKU-1024
type: string
minLength: 1
quantity:
type: integer
minimum: 1
maximum: 9007199254740991
description: Number of units in this order line.
example: 2
description:
nullable: true
description: Human-readable product description.
example: Wool sweater, navy
type: string
minLength: 1
unitPrice:
nullable: true
description: Price per unit in the order line currency.
example: 299.95
type: number
minimum: 0
currency:
nullable: true
description: ISO 4217 currency code.
example: DKK
type: string
minLength: 3
maxLength: 3
vatPercent:
nullable: true
description: VAT percentage applied to the unit price.
example: 25
type: number
minimum: 0
location:
nullable: true
description: Warehouse picking location.
example: A-12-3
type: string
countryOfOrigin:
description: ISO 3166-1 alpha-2 country of origin.
example: DK
type: string
minLength: 2
maxLength: 2
hsCode:
nullable: true
description: Harmonized System customs code.
example: '61101100'
type: string
tarrifNumber:
nullable: true
description: >-
Deprecated misspelling of `hsCode`, kept for
backwards compatibility.
example: '61101100'
type: string
required:
- quantity
additionalProperties: false
description: Order lines contained in this parcel.
trackingNumber:
nullable: true
description: Carrier tracking number for this parcel.
example: '00370724710000012345'
type: string
trackingUrl:
nullable: true
description: Public carrier tracking URL for this parcel.
example: https://tracking.postnord.com/00370724710000012345
type: string
labelFreeCode:
nullable: true
description: Label-free drop-off code for the parcel.
example: AB12CD34
type: string
qrCodeLink:
nullable: true
description: >-
DEPRECATED — use `qrCodeDataUri` (embeddable data
URI) or `qrCodeUrl` (hosted link). Catch-all that
carries whichever applies, kept populated for
backwards compatibility during the migration and
until it is disabled.
example: >-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
type: string
qrCodeDataUri:
nullable: true
description: >-
Embeddable `data:` URI of the QR code image for
label-free drop-off — base64 image bytes you can
drop straight into an ![]()
/email. Populated
whenever the image bytes are available, including
for carriers that host the image (it is fetched and
inlined); null if the carrier published no QR code
or its image could not be retrieved.
example: >-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
type: string
qrCodeUrl:
nullable: true
description: >-
Carrier-hosted URL of the QR code image for
label-free drop-off, returned by carriers (e.g.
Bring) that link to the image rather than embedding
it. Independent of `qrCodeDataUri` — both are set
when the hosted image was inlined successfully; null
for carriers that only return embedded bytes.
example: https://qr.bring.com/label-free/AB12CD34.png
type: string
required:
- weight
- weightUnit
- dimensions
- orderLines
additionalProperties: false
description: Parcels included in the shipment.
pickupDetails:
nullable: true
type: object
properties:
date:
type: string
description: Requested pickup date (YYYY-MM-DD).
example: '2026-06-22'
from:
type: string
description: Requested earliest pickup time (HH:MM:SS).
example: '08:00:00'
to:
type: string
description: Requested latest pickup time (HH:MM:SS).
example: '16:00:00'
instruction:
description: Pickup instruction to the carrier.
example: Ring the bell at the loading dock.
type: string
required:
- date
- from
- to
additionalProperties: false
termOfTrade:
default: DAP
description: Incoterm governing the shipment.
example: DAP
type: string
documents:
description: Documents generated for the shipment (labels, invoices).
type: array
items:
type: object
properties:
id:
type: string
description: Unique document identifier.
example: doc_8f3a2b1c
shipmentId:
type: string
description: Identifier of the shipment this document belongs to.
example: shp_4d9e7a2f
documentType:
type: string
enum:
- label
- customs_invoice
- commercial_invoice
- proforma_invoice
- packing_list
- certificate_of_origin
- cn22
- cn23
- other
description: Type of shipment document.
example: label
format:
type: string
enum:
- pdf
- png
- jpg
- zpl
- svg
description: File format of the document content.
example: pdf
content:
type: string
description: Base64-encoded document/label content.
example: JVBERi0xLjQKJeLjz9MKMS...
size:
default: A4
type: string
enum:
- 100X150
- 100X192
- A4
- 100x100
description: Physical print size of the document.
example: 100X150
createdAt:
type: string
description: Timestamp when the document was created.
example: '2026-06-22T14:30:00.000Z'
updatedAt:
type: string
description: Timestamp when the document was last updated.
example: '2026-06-22T14:30:00.000Z'
required:
- id
- shipmentId
- documentType
- format
- content
- size
- createdAt
- updatedAt
additionalProperties: false
errors:
default: []
description: Carrier errors recorded for the shipment.
type: array
items:
type: object
properties:
id:
type: string
description: Unique error identifier.
example: err_2b3c4d5e
carrier:
type: string
description: Carrier that produced the error.
example: PostNord
code:
nullable: true
description: Carrier-specific error code.
example: INVALID_POSTAL_CODE
type: string
message:
type: string
description: Human-readable error message.
example: >-
Receiver postal code is invalid for the selected
product.
createdAt:
type: string
description: Timestamp when the error occurred.
example: '2026-06-22T14:30:00.000Z'
required:
- id
- carrier
- message
- createdAt
additionalProperties: false
tracking:
nullable: true
type: object
properties:
url:
nullable: true
description: Public carrier tracking URL.
example: https://tracking.postnord.com/00370724710000012345
type: string
number:
nullable: true
description: Carrier tracking number.
example: '00370724710000012345'
type: string
labelFreeCode:
nullable: true
description: Label-free drop-off code.
example: AB12CD34
type: string
qrCodeLink:
nullable: true
description: >-
DEPRECATED — use `qrCodeDataUri` (embeddable data URI)
or `qrCodeUrl` (hosted link). Catch-all that carries
whichever applies, kept populated for backwards
compatibility during the migration and until it is
disabled.
example: >-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
type: string
qrCodeDataUri:
nullable: true
description: >-
Embeddable `data:` URI of the QR code image for
label-free drop-off — base64 image bytes you can drop
straight into an ![]()
/email. Populated whenever the
image bytes are available, including for carriers that
host the image (it is fetched and inlined); null if
the carrier published no QR code or its image could
not be retrieved.
example: >-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
type: string
qrCodeUrl:
nullable: true
description: >-
Carrier-hosted URL of the QR code image for label-free
drop-off, returned by carriers (e.g. Bring) that link
to the image rather than embedding it. Independent of
`qrCodeDataUri` — both are set when the hosted image
was inlined successfully; null for carriers that only
return embedded bytes.
example: https://qr.bring.com/label-free/AB12CD34.png
type: string
additionalProperties: false
status:
type: string
enum:
- draft
- pending
- processing
- dispatched
- partly_dispatched
- error
- cancelled
- on_hold
description: Lifecycle status of the shipment.
example: pending
orgId:
type: string
description: Owning organization identifier.
example: org_1a2b3c4d
orderId:
nullable: true
description: Associated order identifier.
example: ord_5e6f7a8b
type: string
shippingRuleId:
nullable: true
description: Applied shipping rule identifier.
example: rule_3c4d5e6f
type: string
shippingRule:
nullable: true
type: object
properties:
id:
type: string
description: Unique shipping rule identifier.
example: rule_3c4d5e6f
name:
type: string
description: Display name of the shipping rule.
example: Domestic standard
carrierId:
type: string
description: Carrier applied by the rule.
example: car_pn_001
productId:
type: string
description: Carrier product applied by the rule.
example: prod_mypack_home
services:
type: array
items:
type: string
description: Additional service codes applied by the rule.
example:
- A7
addressId:
type: string
description: Sender address applied by the rule.
example: addr_7e8f9a0b
returnShippingRuleId:
description: Shipping rule used for return shipments.
example: rule_return_01
nullable: true
type: string
autoCreateReturnShipment:
description: Whether a return shipment is created automatically.
example: false
type: boolean
autoPrintLabels:
description: Whether labels are printed automatically on send.
example: true
type: boolean
autoPrintDocuments:
description: Whether documents are printed automatically on send.
example: false
type: boolean
labelPrinterId:
description: Printer used for labels.
example: prn_label_01
nullable: true
type: string
documentPrinterId:
description: Printer used for documents.
example: prn_doc_01
nullable: true
type: string
required:
- id
- name
- carrierId
- productId
- services
- addressId
additionalProperties: false
labelPrinterId:
nullable: true
description: Printer assigned for labels on this shipment.
example: prn_label_01
type: string
documentPrinterId:
nullable: true
description: Printer assigned for documents on this shipment.
example: prn_doc_01
type: string
logs:
default: []
description: >-
Request/response logs captured during carrier
interactions.
type: array
items:
type: object
properties:
id:
type: string
description: Unique log entry identifier.
example: log_6f7a8b9c
direction:
type: string
enum:
- inbound
- outbound
- carrier
description: Direction of the logged request.
example: outbound
request:
description: Captured request payload.
response:
nullable: true
description: Captured response payload.
statusCode:
nullable: true
description: HTTP status code of the response.
example: 200
type: number
error:
nullable: true
description: Error message if the request failed.
example: Connection timed out
type: string
duration:
nullable: true
description: Request duration in milliseconds.
example: 342
type: number
createdAt:
type: string
description: Timestamp when the log entry was created.
example: '2026-06-22T14:30:00.000Z'
required:
- id
- direction
- request
- createdAt
additionalProperties: false
activities:
default: []
description: Chronological activity history of the shipment.
type: array
items:
type: object
properties:
id:
type: string
description: Unique activity identifier.
example: act_1d2e3f4a
action:
type: string
enum:
- created
- updated
- sent
- send_failed
- deleted
- shipping_rule_applied
- parcel_split
- shipment_split
- return_created
description: Type of activity performed on the shipment.
example: created
description:
type: string
description: Human-readable description of the activity.
example: Shipment created
metadata:
nullable: true
description: Additional structured data about the activity.
createdAt:
type: string
description: Timestamp when the activity occurred.
example: '2026-06-22T14:30:00.000Z'
required:
- id
- action
- description
- createdAt
additionalProperties: false
createdAt:
type: string
description: Timestamp when the shipment was created.
example: '2026-06-22T14:30:00.000Z'
updatedAt:
type: string
description: Timestamp when the shipment was last updated.
example: '2026-06-22T14:30:00.000Z'
required:
- id
- reference
- parties
- type
- carrierSettings
- parcels
- termOfTrade
- errors
- status
- orgId
- logs
- activities
- createdAt
- updatedAt
additionalProperties: false
'403':
description: Default Response
content:
application/json:
schema:
type: object
properties:
code:
description: >-
Machine-readable error code (translate by this on the
client)
example: CARRIER_GLS_WRONG_ADDRESS
type: string
enum:
- INTERNAL_ERROR
- BAD_REQUEST
- VALIDATION_FAILED
- UNAUTHORIZED
- FORBIDDEN
- NOT_FOUND
- CONFLICT
- RATE_LIMITED
- PAYLOAD_TOO_LARGE
- IMAGE_DIMENSIONS_EXCEEDED
- NOT_IMPLEMENTED
- AUTH_INVALID_CREDENTIALS
- AUTH_TOKEN_INVALID
- AUTH_TOKEN_EXPIRED
- AUTH_EMAIL_NOT_VERIFIED
- AUTH_EMAIL_EXISTS
- AUTH_OAUTH_FAILED
- AUTH_SIGNUP_NOT_ALLOWED
- AUTH_VERIFICATION_FAILED
- AUTH_RESET_TOKEN_INVALID
- AUTH_MFA_REQUIRED
- AUTH_MFA_INVALID_CODE
- AUTH_MFA_ALREADY_ENABLED
- CAPTCHA_FAILED
- EMAIL_DOMAIN_BLOCKED
- EMAIL_DOMAIN_UNDELIVERABLE
- BILLING_EMAIL_UNDELIVERABLE
- VAT_INVALID
- AUTH_MFA_NOT_ENABLED
- SESSION_REQUIRED
- ORG_NOT_FOUND
- ORG_ACCESS_DENIED
- ORG_DISABLED
- ORG_SLUG_EXISTS
- SETUP_NOT_FOUND
- SETUP_EXISTS
- BRAND_NOT_FOUND
- BRAND_ACCESS_DENIED
- BRAND_SLUG_EXISTS
- BRAND_HAS_RECORDS
- USER_NOT_FOUND
- USER_EXISTS
- TERMS_NOT_ACCEPTED
- MEMBER_NOT_FOUND
- MEMBER_SELF_BRAND_RESTRICTION
- ROLE_NOT_FOUND
- ROLE_NAME_EXISTS
- ROLE_IN_USE
- MEMBER_EXISTS
- INVITATION_NOT_FOUND
- INVITATION_EXPIRED
- INVITATION_ALREADY_SENT
- INVITATION_EMAIL_FAILED
- TOKEN_NOT_FOUND
- BILLING_PAYMENT_FAILED
- BILLING_NO_SUBSCRIPTION
- BILLING_TAX_ID_INVALID
- BILLING_PLAN_INVALID
- BILLING_OPERATION_FAILED
- FEATURE_NOT_AVAILABLE
- RESOURCE_LIMIT_REACHED
- PLAN_LIMITS_EXCEEDED
- NO_SUBSCRIPTION
- SUBSCRIPTION_INACTIVE
- BILLING_MANAGED_BY_SHOPIFY
- BILLING_CHECKOUT_REQUIRED
- ZIPPY_ADDON_REQUIRED
- ZIPPY_MESSAGE_LIMIT_REACHED
- ZIPPY_NOT_ACTIVATED
- ZIPPY_INCLUDED_CREDITS_EXHAUSTED
- ZIPPY_DAILY_LIMIT_REACHED
- SHIPMENT_NOT_FOUND
- SHIPMENT_DOCUMENT_NOT_FOUND
- SHIPMENT_ALREADY_SENT
- SHIPMENT_INVALID_STATE
- SHIPMENT_SERVICE_POINT_REQUIRED
- SHIPMENT_SEND_NOT_ATTEMPTED
- PARCEL_NOT_FOUND
- PARCEL_INVALID_SPLIT
- PICKUP_NOT_FOUND
- PICKUP_FAILED
- CARRIER_ERROR
- CARRIER_AUTH_FAILED
- CARRIER_NOT_FOUND
- CARRIER_PRODUCT_NOT_FOUND
- CARRIER_PRODUCT_ROUTE_UNSUPPORTED
- CARRIER_CONFIG_INVALID
- CARRIER_PARAMETER_INVALID
- CARRIER_SERVER_UNAVAILABLE
- CARRIER_UNREACHABLE
- CARRIER_NOT_RESPONDING
- LABEL_DOWNLOAD_FAILED
- CARRIER_DOCUMENT_INCOMPLETE
- CARRIER_GLS_WRONG_ADDRESS
- CARRIER_DAO_INVALID_POSTAL_CODE
- CARRIER_POSTNORD_BOOKING_FAILED
- CARRIER_FEDEX_BOOKING_FAILED
- CARRIER_DHL_EXPRESS_BOOKING_FAILED
- CARRIER_UPS_BOOKING_FAILED
- CARRIER_MATKAHUOLTO_BOOKING_FAILED
- CARRIER_DPD_PL_BOOKING_FAILED
- CARRIER_POSTNL_BOOKING_FAILED
- CARRIER_ROYAL_MAIL_BOOKING_FAILED
- CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED
- CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT
- CARRIER_CUSTOMS_INCOMPLETE
- CARRIER_REQUEST_NOT_FOUND
- CARRIER_REQUEST_LOCKED
- CARRIER_REQUEST_DISPATCH_FAILED
- SHIPPING_RULE_NOT_FOUND
- SHIPPING_RULE_INVALID
- ADDRESS_NOT_FOUND
- ORDER_NOT_FOUND
- ORDER_EXISTS
- ORDER_CHANNEL_NOT_FOUND
- ORDER_CHANNEL_CONFIG_INVALID
- ORDER_CHANNEL_RATES_ONLY
- INTEGRATION_NOT_CONFIGURED
- INSTALLATION_NOT_FOUND
- WEBHOOK_SIGNATURE_INVALID
- WEBHOOK_PAYLOAD_INVALID
- SHOPIFY_PENDING_INSTALL_NOT_FOUND
- SHOPIFY_PENDING_INSTALL_EXPIRED
- SHOP_ALREADY_CONNECTED
- SHOP_CLAIMED_BY_ANOTHER_ORG
- WOOCOMMERCE_CONNECT_FAILED
- WOOCOMMERCE_AUTH_STATE_INVALID
- CHECKOUT_TOKEN_INVALID
- ORDER_CHANNEL_TYPE_UNSUPPORTED
- PRINTER_NOT_FOUND
- PRINTER_OFFLINE
- PRINTER_AUTH_TIMEOUT
- PRINTER_JOB_NOT_FOUND
- ORG_INTEGRATION_NOT_FOUND
- ORG_WEBHOOK_NOT_FOUND
- AUTOMATION_NOT_FOUND
- AUTOMATION_INVALID
- ZIPPY_DISABLED
- CONVERSATION_NOT_FOUND
- FILTER_INVALID
- SAVED_VIEW_NOT_FOUND
- SAVED_VIEW_LIMIT_REACHED
- ADMIN_FORBIDDEN
- JOB_HANDLER_NOT_REGISTERED
- JOB_QUEUE_NOT_CONFIGURED
- JOB_ENQUEUE_FAILED
- JOB_PAYLOAD_INVALID
- EMAIL_SEND_FAILED
- INTEGRATION_DELIVERY_FAILED
- WEBHOOK_DELIVERY_FAILED
- DOCUMENT_GENERATION_FAILED
- AI_UNAVAILABLE
- MIGRATION_PROVIDER_UNKNOWN
- MIGRATION_SOURCE_TOKEN_INVALID
- MIGRATION_SOURCE_UNREACHABLE
- MIGRATION_NOT_FOUND
- MIGRATION_IN_PROGRESS
- WMS_CONNECTION_NOT_FOUND
- WMS_CONNECTION_CONFIG_INVALID
- WMS_CONNECTION_DISABLED
- WMS_ACCOUNT_MISMATCH
- WMS_HOST_ID_UNMAPPED
- WMS_SERVICE_POINT_REQUIRED
- WMS_DANGEROUS_GOODS_UNSUPPORTED
- WMS_LABEL_IN_PROGRESS
- WMS_LABEL_ALREADY_BOOKED
- WMS_LABEL_COUNT_MISMATCH
- DATA_EXPORT_NOT_FOUND
- DATA_EXPORT_IN_PROGRESS
- DATA_EXPORT_NOT_READY
- DATA_EXPORT_EXPIRED
- DATA_EXPORT_FAILED
error:
type: string
description: Short human title
example: Bad Request
message:
type: string
description: Human-readable English detail (i18n fallback)
example: Failed to create address
required:
- error
- message
additionalProperties: false
'404':
description: Default Response
content:
application/json:
schema:
type: object
properties:
code:
description: >-
Machine-readable error code (translate by this on the
client)
example: CARRIER_GLS_WRONG_ADDRESS
type: string
enum:
- INTERNAL_ERROR
- BAD_REQUEST
- VALIDATION_FAILED
- UNAUTHORIZED
- FORBIDDEN
- NOT_FOUND
- CONFLICT
- RATE_LIMITED
- PAYLOAD_TOO_LARGE
- IMAGE_DIMENSIONS_EXCEEDED
- NOT_IMPLEMENTED
- AUTH_INVALID_CREDENTIALS
- AUTH_TOKEN_INVALID
- AUTH_TOKEN_EXPIRED
- AUTH_EMAIL_NOT_VERIFIED
- AUTH_EMAIL_EXISTS
- AUTH_OAUTH_FAILED
- AUTH_SIGNUP_NOT_ALLOWED
- AUTH_VERIFICATION_FAILED
- AUTH_RESET_TOKEN_INVALID
- AUTH_MFA_REQUIRED
- AUTH_MFA_INVALID_CODE
- AUTH_MFA_ALREADY_ENABLED
- CAPTCHA_FAILED
- EMAIL_DOMAIN_BLOCKED
- EMAIL_DOMAIN_UNDELIVERABLE
- BILLING_EMAIL_UNDELIVERABLE
- VAT_INVALID
- AUTH_MFA_NOT_ENABLED
- SESSION_REQUIRED
- ORG_NOT_FOUND
- ORG_ACCESS_DENIED
- ORG_DISABLED
- ORG_SLUG_EXISTS
- SETUP_NOT_FOUND
- SETUP_EXISTS
- BRAND_NOT_FOUND
- BRAND_ACCESS_DENIED
- BRAND_SLUG_EXISTS
- BRAND_HAS_RECORDS
- USER_NOT_FOUND
- USER_EXISTS
- TERMS_NOT_ACCEPTED
- MEMBER_NOT_FOUND
- MEMBER_SELF_BRAND_RESTRICTION
- ROLE_NOT_FOUND
- ROLE_NAME_EXISTS
- ROLE_IN_USE
- MEMBER_EXISTS
- INVITATION_NOT_FOUND
- INVITATION_EXPIRED
- INVITATION_ALREADY_SENT
- INVITATION_EMAIL_FAILED
- TOKEN_NOT_FOUND
- BILLING_PAYMENT_FAILED
- BILLING_NO_SUBSCRIPTION
- BILLING_TAX_ID_INVALID
- BILLING_PLAN_INVALID
- BILLING_OPERATION_FAILED
- FEATURE_NOT_AVAILABLE
- RESOURCE_LIMIT_REACHED
- PLAN_LIMITS_EXCEEDED
- NO_SUBSCRIPTION
- SUBSCRIPTION_INACTIVE
- BILLING_MANAGED_BY_SHOPIFY
- BILLING_CHECKOUT_REQUIRED
- ZIPPY_ADDON_REQUIRED
- ZIPPY_MESSAGE_LIMIT_REACHED
- ZIPPY_NOT_ACTIVATED
- ZIPPY_INCLUDED_CREDITS_EXHAUSTED
- ZIPPY_DAILY_LIMIT_REACHED
- SHIPMENT_NOT_FOUND
- SHIPMENT_DOCUMENT_NOT_FOUND
- SHIPMENT_ALREADY_SENT
- SHIPMENT_INVALID_STATE
- SHIPMENT_SERVICE_POINT_REQUIRED
- SHIPMENT_SEND_NOT_ATTEMPTED
- PARCEL_NOT_FOUND
- PARCEL_INVALID_SPLIT
- PICKUP_NOT_FOUND
- PICKUP_FAILED
- CARRIER_ERROR
- CARRIER_AUTH_FAILED
- CARRIER_NOT_FOUND
- CARRIER_PRODUCT_NOT_FOUND
- CARRIER_PRODUCT_ROUTE_UNSUPPORTED
- CARRIER_CONFIG_INVALID
- CARRIER_PARAMETER_INVALID
- CARRIER_SERVER_UNAVAILABLE
- CARRIER_UNREACHABLE
- CARRIER_NOT_RESPONDING
- LABEL_DOWNLOAD_FAILED
- CARRIER_DOCUMENT_INCOMPLETE
- CARRIER_GLS_WRONG_ADDRESS
- CARRIER_DAO_INVALID_POSTAL_CODE
- CARRIER_POSTNORD_BOOKING_FAILED
- CARRIER_FEDEX_BOOKING_FAILED
- CARRIER_DHL_EXPRESS_BOOKING_FAILED
- CARRIER_UPS_BOOKING_FAILED
- CARRIER_MATKAHUOLTO_BOOKING_FAILED
- CARRIER_DPD_PL_BOOKING_FAILED
- CARRIER_POSTNL_BOOKING_FAILED
- CARRIER_ROYAL_MAIL_BOOKING_FAILED
- CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED
- CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT
- CARRIER_CUSTOMS_INCOMPLETE
- CARRIER_REQUEST_NOT_FOUND
- CARRIER_REQUEST_LOCKED
- CARRIER_REQUEST_DISPATCH_FAILED
- SHIPPING_RULE_NOT_FOUND
- SHIPPING_RULE_INVALID
- ADDRESS_NOT_FOUND
- ORDER_NOT_FOUND
- ORDER_EXISTS
- ORDER_CHANNEL_NOT_FOUND
- ORDER_CHANNEL_CONFIG_INVALID
- ORDER_CHANNEL_RATES_ONLY
- INTEGRATION_NOT_CONFIGURED
- INSTALLATION_NOT_FOUND
- WEBHOOK_SIGNATURE_INVALID
- WEBHOOK_PAYLOAD_INVALID
- SHOPIFY_PENDING_INSTALL_NOT_FOUND
- SHOPIFY_PENDING_INSTALL_EXPIRED
- SHOP_ALREADY_CONNECTED
- SHOP_CLAIMED_BY_ANOTHER_ORG
- WOOCOMMERCE_CONNECT_FAILED
- WOOCOMMERCE_AUTH_STATE_INVALID
- CHECKOUT_TOKEN_INVALID
- ORDER_CHANNEL_TYPE_UNSUPPORTED
- PRINTER_NOT_FOUND
- PRINTER_OFFLINE
- PRINTER_AUTH_TIMEOUT
- PRINTER_JOB_NOT_FOUND
- ORG_INTEGRATION_NOT_FOUND
- ORG_WEBHOOK_NOT_FOUND
- AUTOMATION_NOT_FOUND
- AUTOMATION_INVALID
- ZIPPY_DISABLED
- CONVERSATION_NOT_FOUND
- FILTER_INVALID
- SAVED_VIEW_NOT_FOUND
- SAVED_VIEW_LIMIT_REACHED
- ADMIN_FORBIDDEN
- JOB_HANDLER_NOT_REGISTERED
- JOB_QUEUE_NOT_CONFIGURED
- JOB_ENQUEUE_FAILED
- JOB_PAYLOAD_INVALID
- EMAIL_SEND_FAILED
- INTEGRATION_DELIVERY_FAILED
- WEBHOOK_DELIVERY_FAILED
- DOCUMENT_GENERATION_FAILED
- AI_UNAVAILABLE
- MIGRATION_PROVIDER_UNKNOWN
- MIGRATION_SOURCE_TOKEN_INVALID
- MIGRATION_SOURCE_UNREACHABLE
- MIGRATION_NOT_FOUND
- MIGRATION_IN_PROGRESS
- WMS_CONNECTION_NOT_FOUND
- WMS_CONNECTION_CONFIG_INVALID
- WMS_CONNECTION_DISABLED
- WMS_ACCOUNT_MISMATCH
- WMS_HOST_ID_UNMAPPED
- WMS_SERVICE_POINT_REQUIRED
- WMS_DANGEROUS_GOODS_UNSUPPORTED
- WMS_LABEL_IN_PROGRESS
- WMS_LABEL_ALREADY_BOOKED
- WMS_LABEL_COUNT_MISMATCH
- DATA_EXPORT_NOT_FOUND
- DATA_EXPORT_IN_PROGRESS
- DATA_EXPORT_NOT_READY
- DATA_EXPORT_EXPIRED
- DATA_EXPORT_FAILED
error:
type: string
description: Short human title
example: Bad Request
message:
type: string
description: Human-readable English detail (i18n fallback)
example: Failed to create address
required:
- error
- message
additionalProperties: false
'409':
description: Default Response
content:
application/json:
schema:
type: object
properties:
code:
description: >-
Machine-readable error code (translate by this on the
client)
example: CARRIER_GLS_WRONG_ADDRESS
type: string
enum:
- INTERNAL_ERROR
- BAD_REQUEST
- VALIDATION_FAILED
- UNAUTHORIZED
- FORBIDDEN
- NOT_FOUND
- CONFLICT
- RATE_LIMITED
- PAYLOAD_TOO_LARGE
- IMAGE_DIMENSIONS_EXCEEDED
- NOT_IMPLEMENTED
- AUTH_INVALID_CREDENTIALS
- AUTH_TOKEN_INVALID
- AUTH_TOKEN_EXPIRED
- AUTH_EMAIL_NOT_VERIFIED
- AUTH_EMAIL_EXISTS
- AUTH_OAUTH_FAILED
- AUTH_SIGNUP_NOT_ALLOWED
- AUTH_VERIFICATION_FAILED
- AUTH_RESET_TOKEN_INVALID
- AUTH_MFA_REQUIRED
- AUTH_MFA_INVALID_CODE
- AUTH_MFA_ALREADY_ENABLED
- CAPTCHA_FAILED
- EMAIL_DOMAIN_BLOCKED
- EMAIL_DOMAIN_UNDELIVERABLE
- BILLING_EMAIL_UNDELIVERABLE
- VAT_INVALID
- AUTH_MFA_NOT_ENABLED
- SESSION_REQUIRED
- ORG_NOT_FOUND
- ORG_ACCESS_DENIED
- ORG_DISABLED
- ORG_SLUG_EXISTS
- SETUP_NOT_FOUND
- SETUP_EXISTS
- BRAND_NOT_FOUND
- BRAND_ACCESS_DENIED
- BRAND_SLUG_EXISTS
- BRAND_HAS_RECORDS
- USER_NOT_FOUND
- USER_EXISTS
- TERMS_NOT_ACCEPTED
- MEMBER_NOT_FOUND
- MEMBER_SELF_BRAND_RESTRICTION
- ROLE_NOT_FOUND
- ROLE_NAME_EXISTS
- ROLE_IN_USE
- MEMBER_EXISTS
- INVITATION_NOT_FOUND
- INVITATION_EXPIRED
- INVITATION_ALREADY_SENT
- INVITATION_EMAIL_FAILED
- TOKEN_NOT_FOUND
- BILLING_PAYMENT_FAILED
- BILLING_NO_SUBSCRIPTION
- BILLING_TAX_ID_INVALID
- BILLING_PLAN_INVALID
- BILLING_OPERATION_FAILED
- FEATURE_NOT_AVAILABLE
- RESOURCE_LIMIT_REACHED
- PLAN_LIMITS_EXCEEDED
- NO_SUBSCRIPTION
- SUBSCRIPTION_INACTIVE
- BILLING_MANAGED_BY_SHOPIFY
- BILLING_CHECKOUT_REQUIRED
- ZIPPY_ADDON_REQUIRED
- ZIPPY_MESSAGE_LIMIT_REACHED
- ZIPPY_NOT_ACTIVATED
- ZIPPY_INCLUDED_CREDITS_EXHAUSTED
- ZIPPY_DAILY_LIMIT_REACHED
- SHIPMENT_NOT_FOUND
- SHIPMENT_DOCUMENT_NOT_FOUND
- SHIPMENT_ALREADY_SENT
- SHIPMENT_INVALID_STATE
- SHIPMENT_SERVICE_POINT_REQUIRED
- SHIPMENT_SEND_NOT_ATTEMPTED
- PARCEL_NOT_FOUND
- PARCEL_INVALID_SPLIT
- PICKUP_NOT_FOUND
- PICKUP_FAILED
- CARRIER_ERROR
- CARRIER_AUTH_FAILED
- CARRIER_NOT_FOUND
- CARRIER_PRODUCT_NOT_FOUND
- CARRIER_PRODUCT_ROUTE_UNSUPPORTED
- CARRIER_CONFIG_INVALID
- CARRIER_PARAMETER_INVALID
- CARRIER_SERVER_UNAVAILABLE
- CARRIER_UNREACHABLE
- CARRIER_NOT_RESPONDING
- LABEL_DOWNLOAD_FAILED
- CARRIER_DOCUMENT_INCOMPLETE
- CARRIER_GLS_WRONG_ADDRESS
- CARRIER_DAO_INVALID_POSTAL_CODE
- CARRIER_POSTNORD_BOOKING_FAILED
- CARRIER_FEDEX_BOOKING_FAILED
- CARRIER_DHL_EXPRESS_BOOKING_FAILED
- CARRIER_UPS_BOOKING_FAILED
- CARRIER_MATKAHUOLTO_BOOKING_FAILED
- CARRIER_DPD_PL_BOOKING_FAILED
- CARRIER_POSTNL_BOOKING_FAILED
- CARRIER_ROYAL_MAIL_BOOKING_FAILED
- CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED
- CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT
- CARRIER_CUSTOMS_INCOMPLETE
- CARRIER_REQUEST_NOT_FOUND
- CARRIER_REQUEST_LOCKED
- CARRIER_REQUEST_DISPATCH_FAILED
- SHIPPING_RULE_NOT_FOUND
- SHIPPING_RULE_INVALID
- ADDRESS_NOT_FOUND
- ORDER_NOT_FOUND
- ORDER_EXISTS
- ORDER_CHANNEL_NOT_FOUND
- ORDER_CHANNEL_CONFIG_INVALID
- ORDER_CHANNEL_RATES_ONLY
- INTEGRATION_NOT_CONFIGURED
- INSTALLATION_NOT_FOUND
- WEBHOOK_SIGNATURE_INVALID
- WEBHOOK_PAYLOAD_INVALID
- SHOPIFY_PENDING_INSTALL_NOT_FOUND
- SHOPIFY_PENDING_INSTALL_EXPIRED
- SHOP_ALREADY_CONNECTED
- SHOP_CLAIMED_BY_ANOTHER_ORG
- WOOCOMMERCE_CONNECT_FAILED
- WOOCOMMERCE_AUTH_STATE_INVALID
- CHECKOUT_TOKEN_INVALID
- ORDER_CHANNEL_TYPE_UNSUPPORTED
- PRINTER_NOT_FOUND
- PRINTER_OFFLINE
- PRINTER_AUTH_TIMEOUT
- PRINTER_JOB_NOT_FOUND
- ORG_INTEGRATION_NOT_FOUND
- ORG_WEBHOOK_NOT_FOUND
- AUTOMATION_NOT_FOUND
- AUTOMATION_INVALID
- ZIPPY_DISABLED
- CONVERSATION_NOT_FOUND
- FILTER_INVALID
- SAVED_VIEW_NOT_FOUND
- SAVED_VIEW_LIMIT_REACHED
- ADMIN_FORBIDDEN
- JOB_HANDLER_NOT_REGISTERED
- JOB_QUEUE_NOT_CONFIGURED
- JOB_ENQUEUE_FAILED
- JOB_PAYLOAD_INVALID
- EMAIL_SEND_FAILED
- INTEGRATION_DELIVERY_FAILED
- WEBHOOK_DELIVERY_FAILED
- DOCUMENT_GENERATION_FAILED
- AI_UNAVAILABLE
- MIGRATION_PROVIDER_UNKNOWN
- MIGRATION_SOURCE_TOKEN_INVALID
- MIGRATION_SOURCE_UNREACHABLE
- MIGRATION_NOT_FOUND
- MIGRATION_IN_PROGRESS
- WMS_CONNECTION_NOT_FOUND
- WMS_CONNECTION_CONFIG_INVALID
- WMS_CONNECTION_DISABLED
- WMS_ACCOUNT_MISMATCH
- WMS_HOST_ID_UNMAPPED
- WMS_SERVICE_POINT_REQUIRED
- WMS_DANGEROUS_GOODS_UNSUPPORTED
- WMS_LABEL_IN_PROGRESS
- WMS_LABEL_ALREADY_BOOKED
- WMS_LABEL_COUNT_MISMATCH
- DATA_EXPORT_NOT_FOUND
- DATA_EXPORT_IN_PROGRESS
- DATA_EXPORT_NOT_READY
- DATA_EXPORT_EXPIRED
- DATA_EXPORT_FAILED
error:
type: string
description: Short human title
example: Bad Request
message:
type: string
description: Human-readable English detail (i18n fallback)
example: Failed to create address
required:
- error
- message
additionalProperties: false
'422':
description: Default Response
content:
application/json:
schema:
type: object
properties:
code:
description: >-
Machine-readable error code (translate by this on the
client)
example: CARRIER_GLS_WRONG_ADDRESS
type: string
enum:
- INTERNAL_ERROR
- BAD_REQUEST
- VALIDATION_FAILED
- UNAUTHORIZED
- FORBIDDEN
- NOT_FOUND
- CONFLICT
- RATE_LIMITED
- PAYLOAD_TOO_LARGE
- IMAGE_DIMENSIONS_EXCEEDED
- NOT_IMPLEMENTED
- AUTH_INVALID_CREDENTIALS
- AUTH_TOKEN_INVALID
- AUTH_TOKEN_EXPIRED
- AUTH_EMAIL_NOT_VERIFIED
- AUTH_EMAIL_EXISTS
- AUTH_OAUTH_FAILED
- AUTH_SIGNUP_NOT_ALLOWED
- AUTH_VERIFICATION_FAILED
- AUTH_RESET_TOKEN_INVALID
- AUTH_MFA_REQUIRED
- AUTH_MFA_INVALID_CODE
- AUTH_MFA_ALREADY_ENABLED
- CAPTCHA_FAILED
- EMAIL_DOMAIN_BLOCKED
- EMAIL_DOMAIN_UNDELIVERABLE
- BILLING_EMAIL_UNDELIVERABLE
- VAT_INVALID
- AUTH_MFA_NOT_ENABLED
- SESSION_REQUIRED
- ORG_NOT_FOUND
- ORG_ACCESS_DENIED
- ORG_DISABLED
- ORG_SLUG_EXISTS
- SETUP_NOT_FOUND
- SETUP_EXISTS
- BRAND_NOT_FOUND
- BRAND_ACCESS_DENIED
- BRAND_SLUG_EXISTS
- BRAND_HAS_RECORDS
- USER_NOT_FOUND
- USER_EXISTS
- TERMS_NOT_ACCEPTED
- MEMBER_NOT_FOUND
- MEMBER_SELF_BRAND_RESTRICTION
- ROLE_NOT_FOUND
- ROLE_NAME_EXISTS
- ROLE_IN_USE
- MEMBER_EXISTS
- INVITATION_NOT_FOUND
- INVITATION_EXPIRED
- INVITATION_ALREADY_SENT
- INVITATION_EMAIL_FAILED
- TOKEN_NOT_FOUND
- BILLING_PAYMENT_FAILED
- BILLING_NO_SUBSCRIPTION
- BILLING_TAX_ID_INVALID
- BILLING_PLAN_INVALID
- BILLING_OPERATION_FAILED
- FEATURE_NOT_AVAILABLE
- RESOURCE_LIMIT_REACHED
- PLAN_LIMITS_EXCEEDED
- NO_SUBSCRIPTION
- SUBSCRIPTION_INACTIVE
- BILLING_MANAGED_BY_SHOPIFY
- BILLING_CHECKOUT_REQUIRED
- ZIPPY_ADDON_REQUIRED
- ZIPPY_MESSAGE_LIMIT_REACHED
- ZIPPY_NOT_ACTIVATED
- ZIPPY_INCLUDED_CREDITS_EXHAUSTED
- ZIPPY_DAILY_LIMIT_REACHED
- SHIPMENT_NOT_FOUND
- SHIPMENT_DOCUMENT_NOT_FOUND
- SHIPMENT_ALREADY_SENT
- SHIPMENT_INVALID_STATE
- SHIPMENT_SERVICE_POINT_REQUIRED
- SHIPMENT_SEND_NOT_ATTEMPTED
- PARCEL_NOT_FOUND
- PARCEL_INVALID_SPLIT
- PICKUP_NOT_FOUND
- PICKUP_FAILED
- CARRIER_ERROR
- CARRIER_AUTH_FAILED
- CARRIER_NOT_FOUND
- CARRIER_PRODUCT_NOT_FOUND
- CARRIER_PRODUCT_ROUTE_UNSUPPORTED
- CARRIER_CONFIG_INVALID
- CARRIER_PARAMETER_INVALID
- CARRIER_SERVER_UNAVAILABLE
- CARRIER_UNREACHABLE
- CARRIER_NOT_RESPONDING
- LABEL_DOWNLOAD_FAILED
- CARRIER_DOCUMENT_INCOMPLETE
- CARRIER_GLS_WRONG_ADDRESS
- CARRIER_DAO_INVALID_POSTAL_CODE
- CARRIER_POSTNORD_BOOKING_FAILED
- CARRIER_FEDEX_BOOKING_FAILED
- CARRIER_DHL_EXPRESS_BOOKING_FAILED
- CARRIER_UPS_BOOKING_FAILED
- CARRIER_MATKAHUOLTO_BOOKING_FAILED
- CARRIER_DPD_PL_BOOKING_FAILED
- CARRIER_POSTNL_BOOKING_FAILED
- CARRIER_ROYAL_MAIL_BOOKING_FAILED
- CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED
- CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT
- CARRIER_CUSTOMS_INCOMPLETE
- CARRIER_REQUEST_NOT_FOUND
- CARRIER_REQUEST_LOCKED
- CARRIER_REQUEST_DISPATCH_FAILED
- SHIPPING_RULE_NOT_FOUND
- SHIPPING_RULE_INVALID
- ADDRESS_NOT_FOUND
- ORDER_NOT_FOUND
- ORDER_EXISTS
- ORDER_CHANNEL_NOT_FOUND
- ORDER_CHANNEL_CONFIG_INVALID
- ORDER_CHANNEL_RATES_ONLY
- INTEGRATION_NOT_CONFIGURED
- INSTALLATION_NOT_FOUND
- WEBHOOK_SIGNATURE_INVALID
- WEBHOOK_PAYLOAD_INVALID
- SHOPIFY_PENDING_INSTALL_NOT_FOUND
- SHOPIFY_PENDING_INSTALL_EXPIRED
- SHOP_ALREADY_CONNECTED
- SHOP_CLAIMED_BY_ANOTHER_ORG
- WOOCOMMERCE_CONNECT_FAILED
- WOOCOMMERCE_AUTH_STATE_INVALID
- CHECKOUT_TOKEN_INVALID
- ORDER_CHANNEL_TYPE_UNSUPPORTED
- PRINTER_NOT_FOUND
- PRINTER_OFFLINE
- PRINTER_AUTH_TIMEOUT
- PRINTER_JOB_NOT_FOUND
- ORG_INTEGRATION_NOT_FOUND
- ORG_WEBHOOK_NOT_FOUND
- AUTOMATION_NOT_FOUND
- AUTOMATION_INVALID
- ZIPPY_DISABLED
- CONVERSATION_NOT_FOUND
- FILTER_INVALID
- SAVED_VIEW_NOT_FOUND
- SAVED_VIEW_LIMIT_REACHED
- ADMIN_FORBIDDEN
- JOB_HANDLER_NOT_REGISTERED
- JOB_QUEUE_NOT_CONFIGURED
- JOB_ENQUEUE_FAILED
- JOB_PAYLOAD_INVALID
- EMAIL_SEND_FAILED
- INTEGRATION_DELIVERY_FAILED
- WEBHOOK_DELIVERY_FAILED
- DOCUMENT_GENERATION_FAILED
- AI_UNAVAILABLE
- MIGRATION_PROVIDER_UNKNOWN
- MIGRATION_SOURCE_TOKEN_INVALID
- MIGRATION_SOURCE_UNREACHABLE
- MIGRATION_NOT_FOUND
- MIGRATION_IN_PROGRESS
- WMS_CONNECTION_NOT_FOUND
- WMS_CONNECTION_CONFIG_INVALID
- WMS_CONNECTION_DISABLED
- WMS_ACCOUNT_MISMATCH
- WMS_HOST_ID_UNMAPPED
- WMS_SERVICE_POINT_REQUIRED
- WMS_DANGEROUS_GOODS_UNSUPPORTED
- WMS_LABEL_IN_PROGRESS
- WMS_LABEL_ALREADY_BOOKED
- WMS_LABEL_COUNT_MISMATCH
- DATA_EXPORT_NOT_FOUND
- DATA_EXPORT_IN_PROGRESS
- DATA_EXPORT_NOT_READY
- DATA_EXPORT_EXPIRED
- DATA_EXPORT_FAILED
error:
type: string
description: Short human title
example: Bad Request
message:
type: string
description: Human-readable English detail (i18n fallback)
example: Failed to create address
required:
- error
- message
additionalProperties: false
x-codeSamples:
- lang: typescript
label: TypeScript
source: >-
import { Configuration, ShipmentsApi } from "@zippendo/sdk"
const api = new ShipmentsApi(new Configuration({ accessToken:
process.env.ZIPPENDO_API_TOKEN }))
const result = await api.fetchShipmentLabel({ orgId: "...",
shipmentId: "..." })
- lang: python
label: Python
source: >-
import os
import zippendo
config =
zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
result = zippendo.ShipmentsApi(client).fetch_shipment_label("...", "...")
- lang: php
label: PHP
source: >-
setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\ShipmentsApi(new GuzzleHttp\Client(),
$config);
$result = $api->fetchShipmentLabel("...", "...");
- lang: go
label: Go
source: >-
client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(),
zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.ShipmentsAPI.FetchShipmentLabel(ctx, "...",
"...").Execute()
- lang: ruby
label: Ruby
source: >-
require "zippendo"
Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"]
}
result = Zippendo::ShipmentsApi.new.fetch_shipment_label("...",
"...")
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT access token or API token (prefixed with zipp_)
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.