Orders
Quote an order
Prices an order without creating it: the amount createOrder would debit for the same body, with the account's balance and whether it is enough. Send the body you would send to createOrder: the country is read from countryCode, else shipTo.address.countryCode, else shipTo.servicePoint.country; the rest of shipTo, reference and metadata are not read, and only the presence of printingVisuals counts. Nothing is created or debited.
Request
Authorization
Bearer token
Send your API key in the Authorization header: Authorization: Bearer sk_test_…. A sk_test_ key creates and sees test orders only. Keys and test mode.
Path parameters
accountIdstringrequiredUnique identifier of the account, or the alias@mefor the account authenticated by the token. An API key or an OAuth token acts on its own account only: another account's id is refused with 403ACCOUNT_ACCESS_DENIED.
Body application/json
countryCodestringDelivery country (ISO 3166-1 alpha-2), instead ofshipToshipToobjectAs increateOrder: only its country is readcarrierServiceIdstringID of the carrier service to use for shipping. Defaults to 'lpf_standard' if not provided. Use a service that supports service points when shipTo contains a servicePoint.itemsarray of objectrequireditems[].quantityintegerrequiredQuantity of the productitems[].productIdstring:pvccard_white,mifare1k_pvccard_white,ntag213_pvccard_white,ntag216_pvccard_white,ntag424_pvccard_white,ntag424_woodcardrequiredProduct ID of the productitems[].metadataobjectAdditional metadata for the productitems[].packagingIdstringID of the packagingitems[].printingVisualsarray of string (uuid), nullableList of printing visuals for the product, obtained from the files API
Responses
200The quote
successbooleanquoteQuote
400No country (MISSING_COUNTRY_CODE), an invalid line (INVALID_PARAMETERS, INVALID_QUANTITY), an unknown product (UNKNOWN_PRODUCT), or a carrier service that does not serve the parcel or the country (CARRIER_SERVICE_NOT_AVAILABLE)
Type: Error
401Unauthorized, authentication required, or an OAuth access token unknown, expired or revoked (INVALID_TOKEN)
Type: Error
402The account has no plan, so no price (SUBSCRIPTION_REQUIRED)
Type: Error
403The API key is inactive or revoked (INACTIVE_API_KEY), or the path names another account (ACCOUNT_ACCESS_DENIED); with an OAuth access token: a token of scope mcp (INSUFFICIENT_SCOPE), a path naming another account or a person no longer a member of it (ACCOUNT_ACCESS_DENIED), a real token on the sandbox host (SANDBOX_REQUIRES_TEST_KEY)
Type: Error
500Internal server error
Type: Error