Cartographer API
Turns a product variant into cart lines that are ready to add: the line-item properties Birdy Grey's checkout expects, plus a rush-fee line for Rush Production. It also previews delivery estimates and checks whether a variant can arrive before a wedding.
What it servesβ
| Endpoint | What it does |
|---|---|
POST /lines | Prepares one or more variants for add-to-cart, in Admin API or Storefront API shape |
GET /estimates | Previews a product's delivery estimates for each production option |
GET /replacements | Checks whether a variant arrives by a wedding date as Standard or Rush Production, and which to offer |
Who calls itβ
- An exchange partner, to build exchange carts and orders
- Birdy Bot, to build replacement drafts
How it's reachedβ
| Environment | Base URL |
|---|---|
| Production | https://api.birdygrey.com/cartographer |
| Staging | https://api.birdystaging.com/cartographer |
Every request goes through the Birdy Grey API Gateway and needs an API key in the x-api-key header. The service can't be called directly.
API referenceβ
- Interactive docs: api.birdygrey.com/cartographer/public/docs
- OpenAPI spec: api.birdygrey.com/cartographer/public/openapi