Skip to main content

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​

EndpointWhat it does
POST /linesPrepares one or more variants for add-to-cart, in Admin API or Storefront API shape
GET /estimatesPreviews a product's delivery estimates for each production option
GET /replacementsChecks 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​

EnvironmentBase URL
Productionhttps://api.birdygrey.com/cartographer
Staginghttps://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​