Gett Developer Portal
  • Welcome
  • Distribution Partners
  • Brand Partners
  • Commerce Partners
  • Ecosystem Partners
  • Errors
  • API Reference
Documentation
  • Get Started
  • Marketfront SDK
  • API Reference
Resources
  • Payments
Company
  • Gett
  • Terms of Service
  • Privacy Policy

Copyright 2026 Gett. All rights reserved.

Information
Catalog
    Notify Catalog UpdatepostGet Catalog Ingest Statusget
Store Status
    Get Store StatusgetSet Store Statuspost
Schemas
powered by Zuplo
Gett Commerce Partner API
Gett Commerce Partner API

Schemas


Address

address1
​null | string
address2
​null | string
city
​null | string
​LatLong
postalCode
​null | string
state
​null | string

AmountDetail

amount
​string · decimal · pattern: ^-?\d+(\.\d+)?$ · required

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

description
​string · required

Amounts

adjustments
​string · decimal · pattern: ^-?\d+(\.\d+)?$

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

​AmountDetail[]
currency
​null | string
fees
​string · decimal · pattern: ^-?\d+(\.\d+)?$

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

​AmountDetail[]
promotions
​string · decimal · pattern: ^-?\d+(\.\d+)?$

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

​AmountDetail[]
subTotal
​string · decimal · pattern: ^-?\d+(\.\d+)?$

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

taxes
​string · decimal · pattern: ^-?\d+(\.\d+)?$

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

​AmountDetail[]
tip
​string · decimal · pattern: ^-?\d+(\.\d+)?$

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

​AmountDetail[]
total
​string · decimal · pattern: ^-?\d+(\.\d+)?$

Monetary amount as a decimal string in the order currency's minor-unit scale (e.g. "10.50").

Cart

catalogSetId
​string · uuid · required
​LineItem[] · required
storeId
​string · uuid · required

CartModifierGroup

​LineItem[] · required
modifierGroupId
​string · uuid · required

CatalogIngestAccepted

`202` body for `POST /v1/commerce/catalogset-notification`. The CatalogIngestId correlates this async ingest run; poll StatusUrl to observe it reach a terminal `succeeded`/`failed` state.
catalogIngestId
​string · uuid

Opaque id for the accepted ingest run.

statusUrl
​string

Relative URL of the status resource to poll (also sent as Location).

CatalogIngestErrorWire

One sanitized catalog-ingest error.
message
​string

Human-readable, partner-safe explanation.

path
​string

Best-effort pointer into the pushed CatalogSet (may be empty).

CatalogIngestStatusResponse

Partner-facing status of an async catalog ingest, returned by `GET /v1/commerce/stores/{storeId}/catalog-ingest/{catalogIngestId}/status`.
catalogIngestId
​string · uuid

Echoes the requested id.

​CatalogIngestErrorWire[]

Sanitized, partner-safe errors; populated only when failed.

status
​string

Lowercase lifecycle value: queued → pulling → processing → succeeded | failed.

updatedAt
​string · date-time

UTC instant of the last status transition.

CatalogSetNotification

Request body for `POST /v1/commerce/catalogset-notification`. Only the catalog location is sent on the wire; the target store is identified by the `storeId` query parameter.
callbackUrl
​string · minLength: 1 · required

URL where Gett can download the CatalogSet JSON.

CatalogSyncWebhook

Standard Webhooks envelope for the optional outbound `catalog.sync.*` notification Gett POSTs to a StandardIntegrated partner's `{WebhookUrl}/catalog-sync` when an async catalog ingest reaches a terminal state. Shape follows the Standard Webhooks spec (standardwebhooks.com): hierarchical past-tense `type`, ISO-8601 `timestamp`, and a thin `data` body. The webhook is purely a push convenience — the `GET …/catalog-ingest/{id}/status` poll remains the authoritative signal.
​CatalogSyncWebhookData

Thin correlation payload — poll the status endpoint for full detail.

timestamp
​string · date-time

UTC instant the ingest reached its terminal state.

type
​string

catalog.sync.succeeded or catalog.sync.failed.

CatalogSyncWebhookData

Thin `data` body of a `CatalogSyncWebhook`; mirrors the poll response.
catalogIngestId
​string · uuid

The id returned in the original 202 — correlate it to your push.

​CatalogIngestErrorWire[]

Sanitized, partner-safe errors; populated only when failed.

status
​string

succeeded or failed.

storeId
​string · uuid

Gett's store id this catalog targets.

ClientContext

ip
​string · required
userAgent
​string · required

Customer

email
​string · required
firstName
​string · required
lastName
​string · required
phone
​string · required
partnerUserId
​null | string

DeliveryFulfillment

deliveryType
​DeliveryType · enum · required
Enum values:
DOOR_TO_DOOR
LEAVE_AT_DOOR
mode
​string · enum · required

Fulfillment mode discriminator.

Enum values:
DELIVERY_BY_MERCHANT
scheduleType
​ScheduleType · enum · required
Enum values:
ASAP
SCHEDULED
​Address
instructions
​null | string
scheduledTime
​null | string · date-time

DeliveryType

string · enum
Enum values:
DOOR_TO_DOOR
LEAVE_AT_DOOR

Fulfillment

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · mode="PICKUP" · requires: scheduleType
type = object · mode="DELIVERY_BY_MERCHANT" · requires: scheduleType, deliveryType
Properties for Variant 1:
PickupFulfillment
mode
​string · enum · required

Fulfillment mode discriminator.

Enum values:
PICKUP
scheduleType
​ScheduleType · enum · required
Enum values:
ASAP
SCHEDULED
scheduledTime
​null | string · date-time

LatLong

lat
​number · double
lng
​number · double

LineItem

itemId
​string · uuid · required
​CartModifierGroup[] · required
quantity
​integer · int32 · required
lineItemId
​null | string · uuid

Order

OrderCore

​Cart · required
​ClientContext · required
​Fulfillment · required
​Amounts
​Customer

OrderError

code
​OrderErrorReasons

Canonical order error reason codes; treat unrecognized values as OTHER (x-extensible-enum).

message
​string
pointer
​null | string

OrderErrorReasons

string

Canonical order error reason codes; treat unrecognized values as OTHER (x-extensible-enum).

OrderPlaceWebhook

PickupFulfillment

mode
​string · enum · required

Fulfillment mode discriminator.

Enum values:
PICKUP
scheduleType
​ScheduleType · enum · required
Enum values:
ASAP
SCHEDULED
scheduledTime
​null | string · date-time

ProblemDetail

RFC 9457 Problem Details for HTTP APIs. Standard error response format with operational extension members for deterministic retry/escalation decisions.
status
​integer · int32 · required

The HTTP status code.

title
​string · required

A short, human-readable summary of the problem type.

type
​string · required

A URI reference that identifies the problem type.

detail
​null | string

A human-readable explanation specific to this occurrence.

errorCategory
​null | string

Machine-readable error category (e.g. validation, rate_limit, payment, availability, server_error).

errorCode
​null | string

Machine-readable error code for domain-specific errors.

​null | array

Validation error details, when applicable. Same element shape (OrderError) as the inline order.errors[] on a 200-with-isValid:false validate response, so partners parse one error shape across both paths (gett-83e0.9).

instance
​null | string

A URI reference that identifies the specific occurrence.

requestId
​null | string

Unique identifier for this request, useful for support.

retryAfter
​null | integer · int32

Seconds to wait before retrying. Present when retryable is true and a wait period is known.

retryable
​null | boolean

Whether the request can be retried with a reasonable expectation of success.

timestamp
​null | string · date-time

When the error occurred.

traceId
​null | string

W3C trace id (32-hex) for this request. Paste into SigNoz trace search to find the distributed trace and correlated logs. Populated by the global exception filter.

ScheduleType

string · enum
Enum values:
ASAP
SCHEDULED

StoreStatusResponse

Partner-facing wire shape for a store's operational status. `Status` is the lowercase wire value (`online` / `paused`). Returned by both the GET and POST `/v1/commerce/stores/{storeId}/status` operations.
pauseReason
​null | string
resumeAt
​null | string · date-time
status
​string

StoreStatusUpdate

Request body for `POST /v1/commerce/stores/{storeId}/status`. `Status` is required and must be `online` or `paused` (case-insensitive). `PauseReason` and `ResumeAt` are only meaningful when pausing — on resume they are ignored and the stored values are cleared. `ResumeAt` (if supplied) must be a future UTC instant and drives auto-resume; omit it to pause indefinitely.
status
​string · minLength: 1 · required
pauseReason
​null | string
resumeAt
​null | string · date-time
On this page
  • Address
  • AmountDetail
  • Amounts
  • Cart
  • CartModifierGroup
  • CatalogIngestAccepted
  • CatalogIngestErrorWire
  • CatalogIngestStatusResponse
  • CatalogSetNotification
  • CatalogSyncWebhook
  • CatalogSyncWebhookData
  • ClientContext
  • Customer
  • DeliveryFulfillment
  • DeliveryType
  • Fulfillment
  • LatLong
  • LineItem
  • Order
  • OrderCore
  • OrderError
  • OrderErrorReasons
  • OrderPlaceWebhook
  • PickupFulfillment
  • ProblemDetail
  • ScheduleType
  • StoreStatusResponse
  • StoreStatusUpdate