Getting started

Make your first request

Send JSON, authenticate on the server, and retain the PX request ID.

Request conventions

Send Content-Type: application/json with a UTF-8 object for POST requests. Maximum body size is 256 KiB. Countries use uppercase ISO alpha-2 codes; currency uses uppercase ISO 4217. Weight is kg and dimensions are cm. Unknown request properties are rejected with 422.

Response conventions

Single resources are plain JSON objects. Lists use data; paginated lists include pagination. Labels return binary application/pdf. Responses include X-Request-ID and Cache-Control: no-store. The local sandbox marks X-PX-Environment: test. Supplier costs and credentials are excluded.

Try quotes

Use the Quotes reference for copyable cURL, Node.js, Python and PHP examples. Replace placeholder IDs with IDs returned by your requests. Examples use PX_BASE_URL and PX_API_KEY; configure them from the quickstart.