Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastContentCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "c8a516f"
helix-mixer:
version: "v1.6.1"
lastReviewedCommit: "b8acff4"
Expand Down Expand Up @@ -345,8 +345,10 @@ Learn more about [image handling](/schema-reference#productbusmedia) in the sche

To delete products, send the bulk request with `?delete=true`. Each item must be an object containing an extensionless product `path`. Deletes are unconditional and duplicate paths are processed once. The API validates all items before deleting anything.

Use `?forceUpdate=true` with bulk deletion to emit an index-removal event for each item that returns `404` because the product is already absent from the catalog. This can clear an orphaned index entry. The request body may include `forceUpdate: true` as an alias; if both the query parameter and body field are provided, they must have the same value.

```bash
curl "https://api.adobecommerce.live/{org}/sites/{site}/catalog?delete=true" \
curl "https://api.adobecommerce.live/{org}/sites/{site}/catalog?delete=true&forceUpdate=true" \
-X POST \
-H "Authorization: Bearer {your-api-key}" \
-H "Content-Type: application/json" \
Expand Down Expand Up @@ -384,6 +386,8 @@ curl -i "https://api.adobecommerce.live/{org}/sites/{site}/catalog/us/en/product

This endpoint requires authentication. A successful deletion returns `204 No Content`. If the product doesn't exist at the specified path, you'll receive a `404 Not Found` response. You can send `If-Match` or `If-None-Match` to conditionally delete the product. A failed precondition returns `412 Precondition Failed`, and the product remains in place.

A single `DELETE` always emits an index-removal event, including when the product already returns `404`, so repeating a delete can clear an orphaned index entry. This behavior does not occur when a conditional request fails with `412 Precondition Failed`.

```bash
curl -X DELETE \
-H "Authorization: Bearer {your-api-key}" \
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.62.0"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "6fb1e2b"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "59379a6"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.3"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "59379a6"
---

Expand Down
14 changes: 10 additions & 4 deletions docs/coupons.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastContentCommit: "844b959"
lastReviewedCommit: "c8a516f"
lastContentCommit: "c8a516f"
migration:
from: "helix-commerce-documentation/documentation/coupons.md"
migratedAt: "2026-06-15"
Expand Down Expand Up @@ -72,6 +72,12 @@ To retrieve, update, or delete a type, use `GET`, `PUT`, or `DELETE` at `/{org}/
| `defaultUsesPerCode` | number | No | Default `usesPerCustomer` applied to codes created under this type |
| `notes` | string | No | Internal notes. Not surfaced to customers |

### Category eligibility

Category scope is resolved from the authoritative product entry associated with each cart line's product path. The API does not rely only on category data supplied in the cart request. When a coupon uses `includedCategories` or `excludedCategories`, the estimate flow retrieves the product data needed to evaluate the product's categories.

Product-level scope takes precedence over category-level scope. If product include or exclude conditions are present, they determine eligibility for the line; category conditions do not override that product-level decision. Within either scope level, exclusions take precedence over inclusions.

### Discount calculation

For `"percentage"` discount types, the discount is `(eligibleSubtotal × discountValue) / 100`, capped at `maximumDiscountAmount` when set. For `"fixed"` discount types, the discount is the lesser of `discountValue` and the eligible subtotal, ensuring the subtotal never goes negative.
Expand Down Expand Up @@ -174,7 +180,7 @@ curl "https://api.adobecommerce.live/{org}/sites/{site}/coupons?active=true" \
-H "Authorization: Bearer {your-api-key}"
```

The response includes a `cursor` field for pagination. Pass `cursor` as a query parameter in the next request to retrieve the following page.
The optional `limit` query parameter controls the number of codes returned per page. It defaults to `100` and is clamped to the range `1`–`1000`. The response includes a `cursor` field when more results are available; pass that cursor as a query parameter in the next request to retrieve the following page.

### Code format and tracking suffixes

Expand Down Expand Up @@ -243,4 +249,4 @@ After a successful order payment, the system asynchronously increments `usageCou

- [Promotions guide](/promotions): Set up automatic catalog and cart discounts that apply without a code
- [Rendering guide](/rendering-guide#catalog-price-rules): How promotions affect rendered product pages and indexes
- [API reference](/api-reference): Complete API endpoint reference
- [API reference](/api-reference): Complete API endpoint reference
17 changes: 14 additions & 3 deletions docs/customers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastContentCommit: "05b753f"
lastReviewedCommit: "c8a516f"
lastContentCommit: "c8a516f"
---

# Customers and account data
Expand Down Expand Up @@ -46,6 +46,17 @@ When checkout finds an existing profile, it preserves the profile's existing val
| List a customer's orders | `GET /{org}/sites/{site}/customers/{email}/orders` | `orders:read` and authenticated user matching `{email}` |
| Retrieve one customer order | `GET /{org}/sites/{site}/customers/{email}/orders/{orderId}` | Optional bearer token. Email plus order ID is used for guest order-status lookup |

### List customers

The customer collection supports cursor-based pagination. Use the optional `limit` query parameter to set the maximum number of customers returned per page. The default is `100`; values are clamped to the range `1`–`1000`.

When more customers are available, the response includes an opaque `cursor`. Pass that cursor in the next request's `cursor` query parameter to retrieve the next page.

```bash
curl "https://api.adobecommerce.live/{org}/sites/{site}/customers?limit=100&cursor={cursor}" \
-H "Authorization: Bearer {your-service-token-or-admin-token}"
```

## Customer profile shape

A customer profile contains checkout contact information and optional site-specific custom attributes. Custom attributes are string-valued and can store site-specific data such as a marketing opt-in, preferred contact method, or consent timestamp. See [Schema reference](/schema-reference#customer) for the generated schema.
Expand All @@ -58,7 +69,7 @@ A customer profile contains checkout contact information and optional site-speci
| `phone` | No | Customer phone number |
| `custom` | No | Site-specific customer attributes with string values |

The API adds timestamps when the profile is stored.
The API adds timestamps when the profile is stored. Customer phone numbers are normalized to digits-only when stored. The stored customer metadata also mirrors `firstName`, `lastName`, and `phone` for downstream customer-data consumers.

## Customer passwords

Expand Down
2 changes: 1 addition & 1 deletion docs/data-ingestion.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "1c6fd97"
helix-mixer:
version: "v1.6.1"
Expand Down
2 changes: 1 addition & 1 deletion docs/emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.56.0"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "fc749dd"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/estimates.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "8f53823"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/fraud-forter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "e77382f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.56.0"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "59379a6"
helix-mixer:
version: "v1.6.1"
Expand Down
2 changes: 1 addition & 1 deletion docs/identity-idme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "fc749dd"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/indexing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "1c6fd97"
helix-mixer:
version: "v1.6.1"
Expand Down
2 changes: 1 addition & 1 deletion docs/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "1c6fd97"
helix-mixer:
version: "v1.6.1"
Expand Down
8 changes: 4 additions & 4 deletions docs/order-journal.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.56.0"
lastReviewedCommit: "1c6fd97"
lastContentCommit: "05b753f"
lastReviewedCommit: "c8a516f"
lastContentCommit: "c8a516f"
---

# Order journal
Expand Down Expand Up @@ -75,7 +75,7 @@ The `payment_requires_confirmation` event is emitted when a buyer has approved a

For `payment_cancelled` entries, `configuration_error` indicates that review mode could not resolve a valid review URL. `order_not_approved` indicates that express review validation found that the PayPal order was not approved or was not found. Other upstream validation failures remain retryable and do not cancel the order.

Payment-cancellation journal entries contain the internal cancellation `reason` and provider diagnostics for administrative troubleshooting.
Payment-cancellation journal entries contain the internal cancellation `reason` and provider diagnostics for administrative troubleshooting. For Chase payment declines, diagnostics can also include the provider transaction reference and, when available, the gateway processing status and status message. These values help correlate a failed attempt with the provider and identify gateway-level declines.

For failed provider requests, diagnostic response bodies are limited to 512 characters and receive basic redaction for apparent bearer tokens and payment card number patterns. Treat all diagnostic response details as sensitive and do not expose them in storefronts or other customer-facing views.

Expand Down Expand Up @@ -199,4 +199,4 @@ Use the current order document for storefront state. Use the journal for debuggi
- [Transactional email](/emails): Understand order confirmation email outcomes
- [Payments overview](/checkout/payments/overview): Understand payment initiation and provider actions
- [Service tokens](/authentication/service-tokens): Create read-only journal tokens
- [API reference](/api-reference): Complete endpoint details
- [API reference](/api-reference): Complete endpoint details
2 changes: 1 addition & 1 deletion docs/order-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "05b753f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.56.0"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "59379a6"
helix-mixer:
version: "v1.6.1"
Expand Down
2 changes: 1 addition & 1 deletion docs/payments-affirm.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "05b753f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/payments-apple-pay.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "e77382f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/payments-chase.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "05b753f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/payments-paypal.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "05b753f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/payments.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "05b753f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/paypal-order-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "unknown"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "05b753f"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/places.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.52.2"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "8f53823"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/product-catalog-modeling.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sourceFormat: markdown
sources:
helix-commerce-api:
version: "v2.49.1"
lastReviewedCommit: "1c6fd97"
lastReviewedCommit: "c8a516f"
lastContentCommit: "1c6fd97"
helix-product-pipeline:
version: "v2.9.1"
Expand Down
Loading