Schemas

CatalogSetNotification

callbackUrl

string · uri · required

URL where Gett can download the CatalogSet JSON

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

StoreUpdate

name

string

phone

string

logoUrl

string · uri

description

string

Address

street

string

city

string

state

string

postalCode

string

country

string

StoreStatus

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

reason

PauseReason · enum

Reason for pausing a store.

operational_issues — Equipment failure or other operational problems
staff_shortage — Not enough staff to fulfill orders
too_busy — Order volume too high
maintenance — Scheduled maintenance
other — Other reason

Enum values:

operational_issues

staff_shortage

too_busy

maintenance

other

pausedAt

string · date-time

resumeAt

string · date-time

If set, store will auto-resume at this time

StoreStatusUpdate

status

StoreStatusValue · enum · required

Store availability state.

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

Enum values:

online

paused

reason

PauseReason · enum

Reason for pausing a store.

operational_issues — Equipment failure or other operational problems
staff_shortage — Not enough staff to fulfill orders
too_busy — Order volume too high
maintenance — Scheduled maintenance
other — Other reason

Enum values:

operational_issues

staff_shortage

too_busy

maintenance

other

resumeAt

string · date-time

Optional: auto-resume at this time

StoreStatusValue

string · enum

Enum values:

online

paused

Store availability state.

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

PauseReason

string · enum

Enum values:

operational_issues

staff_shortage

too_busy

maintenance

other

Reason for pausing a store.

operational_issues — Equipment failure or other operational problems
staff_shortage — Not enough staff to fulfill orders
too_busy — Order volume too high
maintenance — Scheduled maintenance
other — Other reason

OrderStatusUpdate

Send status updates for progress within an open order, or state transitions to close an order.

state

OrderStateValue · enum

Set to 'completed' or 'cancelled' to close the order

Enum values:

open

completed

cancelled

status

OrderStatusValue · enum

Progress update within the open state

Enum values:

confirmed

preparing

ready

inTransit

estimatedReadyAt

string · date-time

cancelReason

string

Required if state is cancelled

OrderStateValue

string · enum

Enum values:

open

completed

cancelled

High-level order lifecycle state.

open — Order is active and progressing
completed — Order successfully fulfilled
cancelled — Order was cancelled (include cancelReason)

OrderStatusValue

string · enum

Enum values:

confirmed

preparing

ready

inTransit

Granular progress within the open state. Progresses in order:

confirmed — Store accepted the order
preparing — Kitchen is working on it
ready — Ready for pickup or courier handoff
inTransit — Being delivered to customer

Note: pending is set automatically by Gett and is not a value you send.

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

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

OnboardingStatusValue

string · enum

Enum values:

pending_catalog

catalog_ingesting

catalog_failed

ready_to_activate

active

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

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

StoreStatus

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

reason

PauseReason · enum

Reason for pausing a store.

operational_issues — Equipment failure or other operational problems
staff_shortage — Not enough staff to fulfill orders
too_busy — Order volume too high
maintenance — Scheduled maintenance
other — Other reason

Enum values:

operational_issues

staff_shortage

too_busy

maintenance

other

pausedAt

string · date-time

resumeAt

string · date-time

If set, store will auto-resume at this time

StoreStatusUpdate

status

StoreStatusValue · enum · required

Store availability state.

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

Enum values:

online

paused

reason

PauseReason · enum

Reason for pausing a store.

operational_issues — Equipment failure or other operational problems
staff_shortage — Not enough staff to fulfill orders
too_busy — Order volume too high
maintenance — Scheduled maintenance
other — Other reason

Enum values:

operational_issues

staff_shortage

too_busy

maintenance

other

resumeAt

string · date-time

Optional: auto-resume at this time

PauseReason

string · enum

Enum values:

operational_issues

staff_shortage

too_busy

maintenance

other

Reason for pausing a store.

operational_issues — Equipment failure or other operational problems
staff_shortage — Not enough staff to fulfill orders
too_busy — Order volume too high
maintenance — Scheduled maintenance
other — Other reason

OrderStatusUpdate

Send status updates for progress within an open order, or state transitions to close an order.

state

OrderStateValue · enum

Set to 'completed' or 'cancelled' to close the order

Enum values:

open

completed

cancelled

status

OrderStatusValue · enum

Progress update within the open state

Enum values:

confirmed

preparing

ready

inTransit

estimatedReadyAt

string · date-time

cancelReason

string

Required if state is cancelled

OrderStatusValue

string · enum

Enum values:

confirmed

preparing

ready

inTransit

Granular progress within the open state. Progresses in order:

confirmed — Store accepted the order
preparing — Kitchen is working on it
ready — Ready for pickup or courier handoff
inTransit — Being delivered to customer

Note: pending is set automatically by Gett and is not a value you send.

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

OnboardingStatusValue

string · enum

Enum values:

pending_catalog

catalog_ingesting

catalog_failed

ready_to_activate

active

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