Order Booster Onboarding

Self-service store registration for the Gett network. The onboarding flow:

Register — POST /onboarding/stores with store details and catalog URL
Catalog Pull — Gett automatically downloads and validates your CatalogSet
Check Status — Poll GET /onboarding/stores/{id} to track progress
Activate — Once ready_to_activate, call activate to go live

Status pipeline: pending_catalog → catalog_ingesting → ready_to_activate → active (or catalog_failed if validation errors occur).

Register Store

POST

https://api.gett-tech.com

/v1/commerce/onboarding/stores

Register a new store for Order Booster. Provide your internal partnerStoreId, store details, and a catalogCallbackUrl where Gett can pull your CatalogSet.

After registration, Gett automatically pulls and validates the catalog. Poll the status endpoint to track progress through the pipeline: pending_catalog → catalog_ingesting → ready_to_activate (or catalog_failed).

The webhookUrl is where Gett will send order validation and placement requests once the store is active.

Register Store › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Register Store › Request Body

OnboardingRequest

partnerStoreId

string · required

Your internal store ID

name

string · required

Address · required

catalogCallbackUrl

string · uri · required

URL where Gett can pull the CatalogSet

webhookUrl

string · uri

URL for order webhooks

Register Store › Responses

Store registration started

OnboardingStatus

onboardingId

string · uuid

partnerStoreId

string

status

OnboardingStatusValue · enum

Onboarding pipeline status.

pending_catalog — Waiting for Gett to pull catalog
catalog_ingesting — Processing and validating the catalog
catalog_failed — Validation errors occurred (see error field)
ready_to_activate — Catalog validated, ready for activation
active — Store is live on the Gett network

Enum values:

pending_catalog

catalog_ingesting

catalog_failed

ready_to_activate

active

storeId

string · uuid

Assigned after activation

error

string

Error message if status is catalog_failed

createdAt

string · date-time

POST/v1/commerce/onboarding/stores

curl --request POST \
  --url https://api.gett-tech.com/v1/commerce/onboarding/stores \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partnerStoreId": "store-12345",
  "name": "Pizza Palace - Downtown",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "catalogCallbackUrl": "https://your-domain.com/api/catalogs/store-12345/latest.json",
  "webhookUrl": "https://your-domain.com/api/gett/webhooks"
}
'

Example Request Body

{
  "partnerStoreId": "store-12345",
  "name": "Pizza Palace - Downtown",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "catalogCallbackUrl": "https://your-domain.com/api/catalogs/store-12345/latest.json",
  "webhookUrl": "https://your-domain.com/api/gett/webhooks"
}

json

application/json

Example Responses

{
  "onboardingId": "00000000-0000-0000-0000-000000000000",
  "partnerStoreId": "partnerStoreId",
  "status": "pending_catalog",
  "storeId": "00000000-0000-0000-0000-000000000000",
  "error": "error",
  "createdAt": "2024-08-25T15:00:00Z"
}

json

application/json

Get Onboarding Status

GET

https://api.gett-tech.com

/v1/commerce/onboarding/stores/{onboardingId}

Check the status of a store onboarding. The status field tracks progress through the pipeline:

Status	Description
`pending_catalog`	Waiting for Gett to pull catalog
`catalog_ingesting`	Processing and validating catalog
`catalog_failed`	Validation errors (see `error` field)
`ready_to_activate`	Catalog validated, ready for activation
`active`	Live on the Gett network

Get Onboarding Status › path Parameters

onboardingId

string · uuid · required

Get Onboarding Status › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Onboarding Status › Responses

Onboarding status

OnboardingStatus

onboardingId

string · uuid

partnerStoreId

string

status

OnboardingStatusValue · enum

Onboarding pipeline status.

pending_catalog — Waiting for Gett to pull catalog
catalog_ingesting — Processing and validating the catalog
catalog_failed — Validation errors occurred (see error field)
ready_to_activate — Catalog validated, ready for activation
active — Store is live on the Gett network

Enum values:

pending_catalog

catalog_ingesting

catalog_failed

ready_to_activate

active

storeId

string · uuid

Assigned after activation

error

string

Error message if status is catalog_failed

createdAt

string · date-time

Cancel Onboarding

DELETE

https://api.gett-tech.com

/v1/commerce/onboarding/stores/{onboardingId}

Cancel an in-progress onboarding.

Cancel Onboarding › path Parameters

onboardingId

string · uuid · required

Cancel Onboarding › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Cancel Onboarding › Responses

Onboarding cancelled

No data returned

Activate Store

POST

https://api.gett-tech.com

/v1/commerce/onboarding/stores/{onboardingId}/activate

Activate the store to go live on the Gett network. Only valid when status is ready_to_activate — calling with any other status will return an error.

Returns the final Store object with its assigned global storeId. After activation, the store will begin receiving order webhooks.

Activate Store › path Parameters

onboardingId

string · uuid · required

Activate Store › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Activate Store › Responses

Store activated

Store

storeId

string · uuid

name

string

Address

phone

string

timezone

string

logoUrl

string · uri

description

string

status

StoreStatusValue · enum

Store availability state.

online — Store is accepting orders
paused — Store is temporarily not accepting orders (see reason for why)

Enum values:

online

paused

Order Updates

POST

https://api.gett-tech.com

/v1/commerce/onboarding/stores

Register a new store for Order Booster. Provide your internal partnerStoreId, store details, and a catalogCallbackUrl where Gett can pull your CatalogSet.

The webhookUrl is where Gett will send order validation and placement requests once the store is active.

Register Store › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Register Store › Request Body

OnboardingRequest

partnerStoreId

string · required

Your internal store ID

name

string · required

Address · required

catalogCallbackUrl

string · uri · required

URL where Gett can pull the CatalogSet

webhookUrl

string · uri

URL for order webhooks

Register Store › Responses

Store registration started

OnboardingStatus

onboardingId

string · uuid

partnerStoreId

string

status

OnboardingStatusValue · enum

Onboarding pipeline status.

pending_catalog — Waiting for Gett to pull catalog
catalog_ingesting — Processing and validating the catalog
catalog_failed — Validation errors occurred (see error field)
ready_to_activate — Catalog validated, ready for activation
active — Store is live on the Gett network

Enum values:

pending_catalog

catalog_ingesting

catalog_failed

ready_to_activate

active

storeId

string · uuid

Assigned after activation

error

string

Error message if status is catalog_failed

createdAt

string · date-time

Get Onboarding Status

GET

https://api.gett-tech.com

/v1/commerce/onboarding/stores/{onboardingId}

Check the status of a store onboarding. The status field tracks progress through the pipeline:

Status	Description
`pending_catalog`	Waiting for Gett to pull catalog
`catalog_ingesting`	Processing and validating catalog
`catalog_failed`	Validation errors (see `error` field)
`ready_to_activate`	Catalog validated, ready for activation
`active`	Live on the Gett network

Get Onboarding Status › path Parameters

onboardingId

string · uuid · required

Get Onboarding Status › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Onboarding Status › Responses

Onboarding status

OnboardingStatus

onboardingId

string · uuid

partnerStoreId

string

status

OnboardingStatusValue · enum

Onboarding pipeline status.

pending_catalog — Waiting for Gett to pull catalog
catalog_ingesting — Processing and validating the catalog
catalog_failed — Validation errors occurred (see error field)
ready_to_activate — Catalog validated, ready for activation
active — Store is live on the Gett network

Enum values:

pending_catalog

catalog_ingesting

catalog_failed

ready_to_activate

active

storeId

string · uuid

Assigned after activation

error

string

Error message if status is catalog_failed

createdAt

string · date-time

Cancel Onboarding

DELETE

https://api.gett-tech.com

/v1/commerce/onboarding/stores/{onboardingId}

Cancel an in-progress onboarding.

Cancel Onboarding › path Parameters

onboardingId

string · uuid · required

Cancel Onboarding › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Cancel Onboarding › Responses

Onboarding cancelled

No data returned

Activate Store

POST

https://api.gett-tech.com

/v1/commerce/onboarding/stores/{onboardingId}/activate

Activate the store to go live on the Gett network. Only valid when status is ready_to_activate — calling with any other status will return an error.

Returns the final Store object with its assigned global storeId. After activation, the store will begin receiving order webhooks.

Activate Store › path Parameters

onboardingId

string · uuid · required

Activate Store › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Activate Store › Responses

Store activated

Store

storeId

string · uuid

name

string

Address

phone

string

timezone

string

logoUrl

string · uri

description

string

status

StoreStatusValue · enum

Store availability state.

online — Store is accepting orders
paused — Store is temporarily not accepting orders (see reason for why)

Enum values:

online

paused