In SCAPI, we use different techniques to maximize the availability of your instance:
With these protection mechanisms, customers have uninterrupted access to your storefront.
If the system reaches a load threshold after scaling to maximum capacity, an HTTP 503 status code is returned. Load shedding is not used for checkout-related endpoints, such as the Shopper Baskets and Shopper Orders API families, to ensure that shoppers can complete an in-progress checkout.
Endpoints protected by load shedding include the following HTTP response headers:
sfdc_load: System capacity in use (percentage): 0 to 100sfdc_load_status: Relative health of the system:
When system capacity reaches 80% or 90%, the sfdc_load_status header is sent.
Some API families, such as SLAS and Omnichannel Inventory (OCI) only use rate limiting.
Note
To maintain the quality of service and improve platform stability, some B2C Commerce APIs have rate limits. When the number of requests received reaches the rate limit, the API returns an HTTP 429 response.
Rate limits can be adjusted based on specific customer scenarios or use cases. Contact your Customer Success Manager or Account Executive for questions around rate limits, use cases, and potential adjustments required for these rates.
All other endpoints not mentioned in this document are no longer rate limited.
Important
The following tables show the rate limits for different API families. The limit column shows the maximum number of requests allowed for specific endpoints.
SLAS supports the following rate limits:
When a rate limit is reached, SLAS responds with an HTTP 429 Too Many Requests with an HTTP response header Retry-After. The value in the Retry-After header is set to the time in seconds to wait before retrying the request:
1HTTP/1.1 429 Too Many Requests
2Retry-After: 3600Your client code must be able to handle this response. To make sure that the next request is successful, always wait for the specified time before retrying.
Be aware that the rate limits defined for OCI are rolling rate limits. This means that there’s a maximum number of concurrent requests allowed per time period defined. This helps OCI to prevent denial-of-service attacks by limiting the amount of traffic that can be sent from one organization over that defined period. The limit is measured in seconds and will reset at regular intervals so it’s always “rolling” forward. If any organization exceeds its allotted quota for too long, it is blocked until its usage drops below the threshold again. By setting these rules, OCI is able to detect suspicious activity and block the traffic before it becomes a problem for all consumers of the service.
Rate limits are outlined below, by service, by endpoint, and by request type.
The following APIs are included in the omnichannel inventory API family:
Base URI: https://{shortCode}.api.commercecloud.salesforce.com +
/inventory/availability/v1/organizations/{organizationId} +
| Endpoint | Method | Requests | Second(s) |
|---|---|---|---|
/availability-records/actions/batch-update | POST | 100 | 10 |
/availability-records/actions/get-deltas | POST | 500 | 10 |
/availability-records/actions/get-availability | POST | 10,000 | 10 |
/locations/{locationId}/availability-records/skus/{sku}/{requestId} | DELETE | 400 | 10 |
/locations/{locationId}/availability-records/skus/{sku}/{requestId} | PUT | 100 | 10 |
/locations/{locationId}/availability-records/skus/{sku}/{requestId} | PATCH | 100 | 10 |
/product-segmentation/actions/batch-update | POST | N/A | N/A |
Base URI: https://{shortCode}.api.commercecloud.salesforce.com +
/inventory/impex/v1/organizations/{organizationId} +
| Endpoint | Method | Requests | Second(s) |
|---|---|---|---|
/availability-records/exports | POST | 40 | 60 |
/availability-records/exports/{exportId} | DELETE | 40 | 60 |
/availability-records/exports/{exportId}/file-content | GET | 40 | 60 |
/availability-records/exports/{exportId}/status | GET | 20 | 10 |
/availability-records/imports | POST | 2 | 10 |
/availability-records/imports | GET | 2 | 10 |
/availability-records/imports/{importId} | DELETE | 2 | 10 |
/availability-records/imports/{importId}/status | GET | 20 | 10 |
/availability-records/imports/{importId}/file-content | GET | 2 | 10 |
/availability-records/imports/uploadlink/{uploadLinkId} | POST | 2 | 10 |
/event-log/exports | POST | 40 | 60 |
/event-log/exports/{exportId}/status | GET | 40 | 60 |
/event-log/exports/{exportId}/file-content | GET | 40 | 60 |
/location-graph/exports | POST | 2 | 60 |
/location-graph/exports/{exportId} | DELETE | 2 | 60 |
/location-graph/exports/{exportId}/status | GET | 20 | 10 |
/product-segmentation/imports | POST | 2 | 60 |
/product-segmentation/imports/{importId} | DELETE | 2 | 60 |
/product-segmentation/imports/{importId}/file-content | GET | 40 | 60 |
/product-segmentation/imports/{importId}/status | GET | 20 | 10 |
/product-segmentation/imports/uploadLink/{uploadLinkId} | POST | 2 | 60 |
/product-segmentation/exports | POST | 40 | 60 |
/product-segmentation/exports/{exportId} | DELETE | 40 | 60 |
/product-segmentation/exports/{exportId}/file-content | GET | 40 | 60 |
/product-segmentation/exports/{exportId}/status | GET | 20 | 10 |
/transfers/location-graph/exports/{exportId}/file-content | GET | 2 | 60 |
Base URI: https://{shortCode}.api.commercecloud.salesforce.com +
/inventory/reservation/v1/organizations/{organizationId} +
| Endpoint | Method | Requests | Second(s) |
|---|---|---|---|
/fulfillments | POST | 10,000 | 10 |
/releases | POST | 10,000 | 10 |
/reservation-documents/{reservationId} | PUT | 10,000 | 10 |
/reservation-documents/{reservationId} | PATCH | 10,000 | 10 |
/transfers | POST | 10,000 | 10 |
j