Order Booster Onboarding

Register your merchant stores for the Gett network using the self-service onboarding API.

Flow Overview

Step	Action	Result
1	POST /onboarding/stores	Registration started
2	Gett pulls catalog	Automatic
3	GET /onboarding/stores/{id}	Check status
4	POST /onboarding/stores/{id}/activate	Store goes live

Register a Store

POST /onboarding/stores

{
  "partnerStoreId": "your-internal-id",
  "name": "Joe's Pizza",
  "address": {
    "street": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94102",
    "country": "US"
  },
  "catalogCallbackUrl": "https://api.yourplatform.com/catalog/123",
  "webhookUrl": "https://api.yourplatform.com/gett/webhooks"
}

Response:

{
  "onboardingId": "uuid",
  "partnerStoreId": "your-internal-id",
  "status": "pending_catalog",
  "createdAt": "2026-01-13T13:30:00Z"
}

Onboarding Status Values

Status	Meaning	Next Action
pending_catalog	Waiting for catalog pull	Wait
catalog_ingesting	Pulling catalog	Wait
catalog_failed	Validation failed	Fix catalog, re-register
ready_to_activate	Catalog valid	Call /activate
active	Store is live	Done!

Check Status

GET /onboarding/stores/{onboardingId}

Activate Store

Once status is ready_to_activate:

POST /onboarding/stores/{onboardingId}/activate

Returns the new Store object with its assigned storeId.

Cancel Onboarding

DELETE /onboarding/stores/{onboardingId}