Overview
This document introduces the All About Pawz API: what it is for, who may use it, where it is reached, and the conventions that apply across the API Reference. Read it first; every other document in this reference assumes the terms set out here.
Purpose
The API is the programmatic interface to the All About Pawz marketplace. It lets an approved partner account work with the same catalog, inventory, order, fulfillment, returns, payments, and pricing data it manages in the Seller Center, from its own systems: importing product data in bulk, keeping inventory and prices current, and receiving order and fulfillment events as they happen.
Access
API access is issued by the Company and is limited by seller type: manufacturer and supplier accounts receive API access for importing data; other account types use the Seller Center and file imports. The governing instrument is the Developer Agreement; the API Access Tiers govern use. Access is granted per account, is not transferable, and may be suspended or revoked under the Developer Agreement. There is no self-service sign-up: if your account has been approved for API access, your credentials are issued to you by the Company.
Base URL
All endpoints in this reference are reached over HTTPS at one base
https://www.aapawz.com/api
Endpoint paths in this reference are written relative to that base. For example, the catalog collection documented in Catalog Endpoints is reached at https://www.aapawz.com/api/catalog/products. Requests to any other host, or over plain HTTP, are not part of this API and are not supported.
Authentication
Every request carries the API key issued to your account as a bearer token
Authorization: Bearer <your-api-key>
Requests without a valid key are rejected with 401. A key identifies one account; everything the key can read or change is scoped to that account and to the permissions of its access tier. Treat the key as a secret: store it in a secrets manager, never in source control, never in a client application. Key issuance, rotation, and revocation are covered in Authentication Endpoints and in the API Key Management and Rotation Policy.
The resource model
The API is organized around the resources of a sale, in the order a sale moves
| Resource | What it holds | Reference |
|---|---|---|
| Catalog | Products, variants, and their content | Catalog Endpoints |
| Inventory | Stock levels by product and location | Inventory Endpoints |
| Orders | Orders placed with your account, line by line | Orders Endpoints |
| Fulfillment | Shipments, tracking, and delivery state | Fulfillment Endpoints |
| Returns | Return requests, labels, and refunds in progress | Returns Endpoints |
| Payments | Charges, payouts, and payment state | Payments Endpoints |
| Pricing | Prices and price changes for your products | Pricing Endpoints |
| Analytics | Sales and performance reporting | Analytics Endpoints |
Program-specific resources: governance and compliance records (Governance Endpoints), brand and manufacturer functions (Brand and Manufacturer Endpoints), franchise functions (Franchise Endpoints), and veterinary and pharmacy functions (Veterinary and Pharmacy Endpoints): are available only to accounts in those programs. Field and enum definitions shared across resources are collected in Data Types and Enums.
Conventions
- Format. Requests and responses are JSON, UTF-8 encoded. Send
Content-Type: application/jsonon every request with a body. - Identifiers. Every resource has an
id: an opaque string assigned by the Platform. Treat ids as indivisible values: do not parse, construct, or guess them. - Timestamps. All timestamps are ISO 8601 in UTC, for example
2026-10-14T10:42:32Z. - Money. Amounts are decimal strings accompanied by a
currencyfield, for example"amount": "24.99", "currency": "USD". Never send floating-point numbers for money. - Pagination. Collection endpoints return one page at a time with a cursor for the next page. See Pagination and Filtering (Pagination & Filtering).
- Idempotency. Writes accept an idempotency key so a retried request is applied once. See Idempotency Keys.
- Errors. A failed request returns a non-2xx status and a JSON error body of the form
{"error": {"code": "…", "message": "…"}}. Codes and their meanings are listed in Error Codes. - Rate limits. Requests are metered per key. Responses carry rate-limit headers; the limits and headers are specified in Rate Limit Headers.
- Unknown fields. Responses may gain fields as the API develops. Clients shall ignore fields they do not recognize rather than fail.
Webhooks
The Platform can notify your systems of events: an order placed, a shipment delivered, a return received: by HTTPS POST to an endpoint you register. Event payloads, signatures, and retry behavior are specified in Webhook Event Schemas and the Webhooks guide.
Versioning
The API is not versioned by URL. Changes are additive wherever possible: new resources, new endpoints, and new response fields do not break existing integrations. A change that cannot be made additively is announced in advance in the Changelog, which is the authoritative record of what changed and when.
Where to go next
Authentication Endpoints covers keys and request signing in full. Catalog Endpoints through Pricing Endpoints cover the commerce resources end to end. Request and Response Examples shows complete calls. The Developer Guide walks through a first integration step by step, beginning with Getting Started.
Questions about API access: support@aapawz.com.