> ## Documentation Index > Fetch the complete documentation index at: https://docs-alpha.pepay.io/llms.txt > Use this file to discover all available pages before exploring further. # Get product pricing and offers > Retrieve current pricing offers for a product including seller information, shipping options, and availability. Results are sorted by best value. Optionally provide a zip code for location-specific shipping rates. ## OpenAPI ````yaml /api-reference/openapi.json get /api/commerce/products/{productId}/offers openapi: 3.0.0 info: title: Pepay API (SDK-scoped) version: 1.0.0 description: API documentation for Pepay API servers: - url: https://api-beta.pepay.io description: Beta server - url: http://localhost:3000 description: Local development security: - bearerAuth: [] tags: - name: Events description: Events API (history + debugging) for canonical notification envelopes. - name: Metrics description: Internal Prometheus metrics (restricted). - name: WebSockets description: WebSocket streams (upgrade endpoints) and message schemas. - name: Commerce - Devnet Simulator description: > Deterministic devnet-only endpoints for simulating Commerce V2 order state transitions. Use this when integrating as a merchant on devnet to test your backend/UI against realistic order lifecycle changes (payment confirmation, settlement gating, placement, tracking, cancellation, refunds) without placing real retailer orders or sending real on-chain refunds. How it works: - Requires a devnet `X-Commerce-Api-Key` (merchant-scoped). - Only operates on orders created in `networkEnvironment=devnet`. - Updates the order using the same reducer/persistence paths used in mainnet (provider snapshots are simulated). - After each simulation, Pepay emits the normal `commerce.order.updated` merchant webhook event. - name: Merchant Checkout description: > Merchant-scoped **three-step** checkout flow: 1) `POST /api/commerce/merchant/checkout/estimate` — validate items against current eligible offers and return `validItems[]` + `invalidItems[]`. 2) `POST /api/commerce/merchant/checkout/address` — attach and validate a shipping address for the estimate. 3) `POST /api/commerce/merchant/checkout/invoice` — create the final invoice + commerce order. Cart behavior (when `useCart: true`): - The estimate call **reads** the saved cart but does **not** remove or modify cart items. - Items with no eligible offers are returned in `invalidItems[]`. - To remove items from the saved cart, call the Merchant Cart APIs (`PUT /api/commerce/merchant/carts/items/:itemId` with `quantity: 0`, or `DELETE /api/commerce/merchant/carts/items/:itemId`). - To exclude items for *this checkout attempt* without mutating the cart, use `itemOverrides[]` with `quantity: 0`. - name: Payment Sessions description: > Payor-facing APIs used by the hosted payment page and other embedded checkout clients. Canonical base path: - All documented endpoints are under `/api/v1/payments/*`. Authentication: - These endpoints do **not** accept merchant API keys or bearer JWTs. - Send `x-session-token` and `x-signature` headers on every request (both are returned when creating an invoice). Typical flow: 1) Create an invoice (`POST /api/v1/invoices`) → receive `payment_url`, `session_token`, `signature`. 2) Render/open the `payment_url` for the payor. 3) Fetch invoice context (`GET /api/v1/payments/session-details`). 4) List supported tokens (`GET /api/v1/payments/available-tokens`). 5) Allocate a payment address (`POST /api/v1/payments/payment-addresses`) → use `ws_connection` for `/ws/payment`. 6) Track progress via polling (`GET /api/v1/payments/payment-status`) and/or websocket (`/ws/payment`). Security notes: - Treat `session_token` and `signature` as sensitive values (anyone with them can read the invoice/payment status). - Do not store them in long-lived browser storage; prefer in-memory usage on the payment page. - name: Quotes description: Token settlement quotes and rate calculations - name: Webhooks description: > Webhook endpoint management and delivery history for canonical notifications. Delivery model: - At-least-once delivery; receivers must dedupe by `event.id` (also sent as `X-Pepay-Event-ID`). - Payloads are canonical `PepayEvent` objects and match websocket `event_v1` frames for the same event type. Security: - Endpoints must be HTTPS. - Deliveries are signed using `HMAC_SHA256("${timestamp_ms}.${raw_body}")` and sent in `X-Pepay-Signature`. paths: /api/commerce/products/{productId}/offers: get: tags: - Commerce - Products summary: Get product pricing and offers description: > Retrieve current pricing offers for a product including seller information, shipping options, and availability. Results are sorted by best value. Optionally provide a zip code for location-specific shipping rates. operationId: getProductOffers parameters: - name: productId in: path required: true schema: type: string pattern: ^[A-Za-z0-9\-_]+$ minLength: 1 maxLength: 100 description: Product identifier example: B08N5WRWNW - name: retailer in: query required: false schema: type: string enum: - amazon - walmart default: amazon description: Retailer to fetch offers from - name: zipCode in: query required: false schema: type: string pattern: ^\d{5}(-\d{4})?$ description: US zip code for shipping calculations example: '10001' responses: '200': description: Product offers and pricing content: application/json: schema: $ref: >- #/components/schemas/GetapicommerceproductsproductIdoffersResponse200 '400': description: Bad request - Invalid parameters content: application/json: schema: $ref: >- #/components/schemas/GetapicommerceproductsproductIdoffersResponse400 '401': description: Unauthorized - Missing or invalid commerce API key content: application/json: schema: $ref: >- #/components/schemas/GetapicommerceproductsproductIdoffersResponse401 '403': description: Forbidden - API key suspended or expired content: application/json: schema: $ref: >- #/components/schemas/GetapicommerceproductsproductIdoffersResponse403 '404': description: Product not found content: application/json: schema: $ref: >- #/components/schemas/GetapicommerceproductsproductIdoffersResponse404 '429': description: Too Many Requests - Rate limit exceeded content: application/json: schema: $ref: >- #/components/schemas/GetapicommerceproductsproductIdoffersResponse429 '503': description: Service unavailable - Commerce disabled or API error content: application/json: schema: $ref: >- #/components/schemas/GetapicommerceproductsproductIdoffersResponse503 security: - commerceApiKey: [] - merchantApiKey: [] components: schemas: GetapicommerceproductsproductIdoffersResponse200: type: object properties: success: type: boolean example: true data: type: object properties: productId: type: string example: B08N5WRWNW retailer: type: string example: amazon offers: type: array description: Available offers sorted by best value items: type: object properties: offerId: type: string description: Unique offer identifier sellerId: type: string description: Seller merchant ID example: ATVPDKIKX0DER sellerName: type: string description: Seller display name example: Amazon.com price: type: number format: decimal description: Offer price in USD (converted from cents) example: 99.99 shipping: type: number format: decimal description: Shipping cost in USD (converted from cents) example: 0 totalCost: type: number format: decimal description: Total cost (price + shipping) example: 99.99 prime: type: boolean description: Prime eligible example: true primeOnly: type: boolean description: Prime exclusive example: false condition: type: string description: Product condition example: New handlingDays: type: object properties: min: type: integer max: type: integer description: Handling time range in days example: min: 0 max: 2 sellerRating: type: number description: Seller positive feedback percentage example: 98.5 sellerRatingCount: type: integer description: Number of seller ratings example: 10543 international: type: boolean description: International shipping available example: false available: type: boolean description: Offer availability (not an add-on item) meta: type: object properties: timestamp: type: integer example: 1738240496 GetapicommerceproductsproductIdoffersResponse400: type: object properties: success: type: boolean example: false error: type: object properties: code: type: string enum: - VALIDATION_ERROR example: VALIDATION_ERROR message: type: string example: Invalid request parameters details: type: array items: type: object properties: field: type: string example: zipCode message: type: string example: Invalid US zip code format GetapicommerceproductsproductIdoffersResponse401: type: object properties: success: type: boolean example: false error: type: object properties: code: type: string enum: - COMMERCE_API_KEY_MISSING - INVALID_COMMERCE_API_KEY example: COMMERCE_API_KEY_MISSING message: type: string example: Commerce API key required GetapicommerceproductsproductIdoffersResponse403: type: object properties: success: type: boolean example: false error: type: object properties: code: type: string enum: - COMMERCE_API_KEY_SUSPENDED - COMMERCE_API_KEY_EXPIRED example: COMMERCE_API_KEY_SUSPENDED message: type: string example: Commerce API key suspended GetapicommerceproductsproductIdoffersResponse404: type: object properties: success: type: boolean example: false error: type: object properties: code: type: string enum: - PRODUCT_NOT_FOUND example: PRODUCT_NOT_FOUND message: type: string example: Product not found or has no available offers GetapicommerceproductsproductIdoffersResponse429: type: object properties: success: type: boolean example: false error: type: object properties: code: type: string enum: - RATE_LIMIT_EXCEEDED example: RATE_LIMIT_EXCEEDED message: type: string example: Too many offer requests. Please wait before trying again. retryAfter: type: integer description: Seconds to wait before retrying example: 60 GetapicommerceproductsproductIdoffersResponse503: type: object properties: success: type: boolean example: false error: type: object properties: code: type: string enum: - COMMERCE_DISABLED - COMMERCE_API_ERROR example: COMMERCE_API_ERROR message: type: string example: Unable to retrieve product offers securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT token for wallet authentication commerceApiKey: type: apiKey in: header name: x-commerce-api-key description: >- Legacy alias for commerce-scoped API keys. Prefer `x-api-key` with scope=commerce. merchantApiKey: type: apiKey in: header name: x-api-key description: API key for server-to-server operations (scope=merchant or commerce) ````