The Order Protection API
Build on Order Protection with REST APIs, webhooks, OAuth apps and an Analytics API.
What it does
Use the Order Protection API to connect a platform we don’t support out of the box, pull your data into your own tools, or build an app other merchants can install. Send orders and fulfillments in, get claim events back through webhooks, and read your analytics with a personal access token.
What you can do
Integrate any platform. Send orders, fulfillments and products through the REST API, then act on claim resolution webhooks to reship or refund. How API integration works
Pull your data. The Analytics API returns raw tables and computed metrics, such as attach rate and claim rate, with no personal customer data. Analytics API
Script against your own account. Personal access tokens are limited to the stores and scopes you choose. Personal access tokens
React to events. Webhooks tell your app when claims are created, approved or resolved. Webhooks
Build an app. OAuth apps with scoped permissions, listed in the App Marketplace or kept private to your stores. App Marketplace
Good to know
Analytics tables refresh on a batch schedule, roughly every 8 hours
Every request is limited to your account and the stores your token can reach
Any Order Protection account can build private apps for its own stores
Who it’s for
Brands on custom or headless stacks, data teams that want Order Protection data in their warehouse, and partners building apps for Order Protection merchants.
