openapi: 3.0.1
info:
title: Public Account Pairing Endpoints Storefront Endpoints API
description: "# Overview\n\nThe API endpoints are developed around [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) principles secure via the OAuth2.0 protocol.\n\nBeyond the entry points, the API also provides a line of communication into your system via [webhooks](https://en.wikipedia.org/wiki/Webhook).\n\nFor testing purposes, we offer a staging environment. Also, more detailed information about the business rules and workflows can be found on the [**Documentation Section**](/docs/)\n\n## Versioning\nEach API is versioned individually, but we follow these rules:\n- Non breaking changes (eg: adding new fields) are added in the current version without previous communication\n- Breaking changes (fields removal, semantic changed or schema update) have the version incremented\n- Users will be notified about new versions and will be given time to migrate (the time will be set on a case by case basis)\n- Once users migrate to the new version, we will deprecate the old ones\n- Once there is a new version for an API, we won't accept new integrations targeting old versions\n\n## API General Definitions\nThe APIs use resource-oriented URLs communicating, primarily, via JSON and leveraging the HTTP headers, [response status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status), and verbs.\n\nTo exemplify how the API is to be consumed, consider a fake GET resource endpoint invocation below:\n\n```\ncurl --request GET 'https://{{public-api-url}}/v1/resource/123' \\\n--header 'Authorization: Bearer 34fdabeeafds=' --header 'X-Store-Id: 321'\n```\n\n| Header | Description |\n| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|`Authorization` | Standard HTTP header is used to associate the request with the originating invoker. The content of this header is a `Bearer` token generated from you client_secret, defined in the [API Auth](#/section/Guides/API-Auth) guide.|\n|`X-Store-Id` | The ID of the store in your system this call acts on behalf of. |\n\n_All resource endpoints expect the `Authorization` header, the remaining headers are explicitly stated in the individual endpoint documentation section._\n\nWith these headers, the system will:\n - Validate the client token, making sure the call is originating from a trusted source.\n - Validate that the Application has the permission to access the `v1/resource/{id}` resource via the Application's pre-configured scopes.\n - Translate your X-Store-Id to our internal store ID (e.g. `AAA`).\n - Validate and retrieve resource `AAA`, that is associated to your Application via store id `321`.\n\nPOST/PUT methods will look similar to the GET calls, but they'll take in a body in the HTTP request (default to the application/json content-type).\n\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/resource' \\\n--header 'Authorization: Bearer 34fdabeeafds=' --header 'X-Store-Id: 321'\n--data '{\"foo\": \"bar\"}'\n```\n\n## API Authentication/Authorization\n\n<SecurityDefinitions />\n\n## Webhook\n\nThe Public API is able to send notifications to your system via HTTP POST requests.\n\nEvery webhook is signed using HMAC-SHA256 that is present in the header `X-HMAC-SHA256`, and you can also authenticate the requests using Basic Auth, Bearer Token or HMAC-SHA1 (legacy). Please, refer to [**Webhook Authentication Guide**](/docs/guides-webhook-authentication/) for more details.\n\n_Please work with your Account Representative to setup your Application's Webhook configurations._\n\n```\nExample Base-URL = https://{{your-server-url}}/webhook\n```\n\n### Notification Schema\n\n| **Name** | **Type** | **Description** |\n| ------------------------| ---------| -------------------------------------------------------------------- |\n| eventId | string | Unique id of the event. |\n| eventTime | string | The time the event occurred. |\n| eventType | string | The type of event (e.g. create_order). |\n| metadata.storeId | string | Id of the store for which the event is being published. |\n| metadata.applicationId | string | Id of the application for which the event is being published. |\n| metadata.resourceId | string | The external identifier of the resource that this event refers to. |\n| metadata.resourceHref | string | The endpoint to fetch the details of the resource. |\n| metadata.payload | object | The event object which will be detailed in each Webhook description. |\n\n### Notification Request Example\n\n```\ncurl --location --request POST 'https://{{your-server-url}}/webhook' \\\n--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36' \\\n--header 'Authorization: MAC <hash signature>' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"eventId\": \"123456\",\n \"eventTime\": \"2020-10-10T20:06:02:123Z\",\n \"eventType\": \"orders.new_order\",\n \"metadata\": {\n \"storeId\": \"755fd19a-7562-487a-b615-171a9f89d669\",\n \"applicationId\": \"e22f94b3-967c-4e26-bf39-9e364066b68b\",\n \"resourceHref\": \"https://{{public-api-url}}/v1/orders/bf9f1d81-f213-496e-a026-91b6af44996c\",\n \"resourceId\": \"bf9f1d81-f213-496e-a026-91b6af44996c\",\n \"payload\": {}\n }\n}\n```\n\n### Expected Response\n\nThe partner application should return an HTTP 200 response code with an empty response body to acknowledge receipt of the webhook event.\n## Rate Limiting\nPlease, refer to [**Rate Limiting Guide**](/docs/guides-rate-limiting/) for more details.\n\n## Error codes\nThe APIs use standard HTTP status codes to indicate the success or failure of a request. Error codes are divided into two categories: 4XX codes for client-side errors and 5xx codes for server-side errors.\n### 4XX Client-Side Errors\nClient-side errors are indicated by status codes in the 4xx range. These errors are typically the result of a problem with the request made by your application.\nIf a client-side error occurs, our API will return a response that includes an appropriate error message. This message will provide information about the cause of the error. The aim of these messages is to assist you in identifying and resolving the issue.\nFor example, if you submit a request with missing or invalid parameters, you might receive a 400 Bad Request error with a message indicating which parameters were missing or incorrect.\n### 5XX Server-Side Errors\nServer-side errors are represented by status codes in the 5xx range. These errors suggest a problem with our server, not with your application's request.\nServer-side errors are typically transient, meaning they are temporary. If a server-side error occurs, we recommend that the client retries the same request with the exact same parameters.\nFor example, if you get a 500 Internal Server Error, it's possible that our server is suffering a temporary problem. In such cases, retrying the request after a short delay is often successful.\nIf you continually receive server-side errors, reach out to our support team for further assistance."
version: v1
license:
name: Proprietary
contact:
name: Kin Lane
email: kin@apievangelist.com
x-generated-from: documentation
x-source-url: https://developer-guides.tryotter.com/api-reference/
x-last-validated: '2026-06-03'
servers:
- url: https://{public-api-url}/
description: Otter Public API base URL. The concrete host is provisioned per integration partner/account via your Otter account representative; substitute the value provided during onboarding.
variables:
public-api-url:
default: public-api-url
description: Account-specific Public API host provided by Otter during onboarding.
tags:
- name: Storefront Endpoints
description: Endpoints to manage storefront state
x-displayName: Storefront
paths:
/v1/storefront/availability:
post:
tags:
- Storefront Endpoints
summary: Otter Notify About Store Availability Change
description: '`RATE LIMIT: 16 per minute`
'
operationId: postStoreAvailabilityChange
parameters:
- $ref: '#/components/parameters/storeIdHeader'
- $ref: '#/components/parameters/eventIdOptionalHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoreAvailabilityEventResult'
examples:
PostStoreAvailabilityChangeRequestExample:
summary: Default postStoreAvailabilityChange request
x-microcks-default: true
value:
storeState: OPEN
statusChangedAt: '2007-12-03T10:15:30+01:00'
eventResultMetadata:
operationStatus: SUCCEEDED
additionalInformation: Completed without problems.
operationFinishedAt: '2007-12-03T10:15:30+01:00'
required: true
responses:
'204':
description: The store availability change was successfully processed
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
security:
- OAuth2.0:
- storefront.store_availability
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/storefront/hours:
post:
tags:
- Storefront Endpoints
summary: Otter Notify About Store Hours Configuration Change
description: '`RATE LIMIT: 16 per minute`
'
operationId: postStoreHoursConfigurationChange
parameters:
- $ref: '#/components/parameters/storeIdHeader'
- $ref: '#/components/parameters/eventIdOptionalHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoreHoursConfigurationEventResult'
examples:
PostStoreHoursConfigurationChangeRequestExample:
summary: Default postStoreHoursConfigurationChange request
x-microcks-default: true
value:
storeHoursConfiguration:
deliveryHours: {}
pickupHours: {}
timezone: America/Los_Angeles
statusChangedAt: '2007-12-03T10:15:30+01:00'
eventResultMetadata:
operationStatus: SUCCEEDED
additionalInformation: Completed without problems.
operationFinishedAt: '2007-12-03T10:15:30+01:00'
required: true
responses:
'204':
description: The store hours configuration change was successfully processed.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
security:
- OAuth2.0:
- storefront.store_hours_configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/storefront/pause:
post:
tags:
- Storefront Endpoints
summary: Otter Notify the Result of a Pause Request Event
description: '`RATE LIMIT: 8 per minute`
'
operationId: postPauseStoreEventResult
parameters:
- $ref: '#/components/parameters/storeIdHeader'
- $ref: '#/components/parameters/eventIdHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PauseStoreEventResult'
examples:
PostPauseStoreEventResultRequestExample:
summary: Default postPauseStoreEventResult request
x-microcks-default: true
value:
closureId: 4109d2c9-8bc5-413c-af3e-1c92aa381e41
eventResultMetadata:
operationStatus: SUCCEEDED
additionalInformation: Completed without problems.
operationFinishedAt: '2007-12-03T10:15:30+01:00'
required: true
responses:
'204':
description: The pause store event result was successfully processed
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
security:
- OAuth2.0:
- storefront.store_pause_unpause
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/storefront/unpause:
post:
tags:
- Storefront Endpoints
summary: Otter Notify the Result of an Unpause Request Event
description: '`RATE LIMIT: 8 per minute`
'
operationId: postUnpauseStoreEventResult
parameters:
- $ref: '#/components/parameters/storeIdHeader'
- $ref: '#/components/parameters/eventIdHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnpauseStoreEventResult'
examples:
PostUnpauseStoreEventResultRequestExample:
summary: Default postUnpauseStoreEventResult request
x-microcks-default: true
value:
eventResultMetadata:
operationStatus: SUCCEEDED
additionalInformation: Completed without problems.
operationFinishedAt: '2007-12-03T10:15:30+01:00'
required: true
responses:
'204':
description: The unpause store event result was successfully processed
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
security:
- OAuth2.0:
- storefront.store_pause_unpause
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/storefront/eater-side/status:
post:
tags:
- Storefront Endpoints
summary: Otter Notify About Store Availability Change from the Eater Side
description: '`RATE LIMIT: 16 per minute`
'
operationId: postEaterSideStoreAvailabilityChange
parameters:
- $ref: '#/components/parameters/storeIdHeader'
- $ref: '#/components/parameters/eventIdOptionalHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoreAvailabilityEventResult'
examples:
PostEaterSideStoreAvailabilityChangeRequestExample:
summary: Default postEaterSideStoreAvailabilityChange request
x-microcks-default: true
value:
storeState: OPEN
statusChangedAt: '2007-12-03T10:15:30+01:00'
eventResultMetadata:
operationStatus: SUCCEEDED
additionalInformation: Completed without problems.
operationFinishedAt: '2007-12-03T10:15:30+01:00'
required: true
responses:
'204':
description: The store availability change was successfully processed
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
security:
- OAuth2.0:
- storefront.store_availability
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/storefront/eater-side/hours:
post:
tags:
- Storefront Endpoints
summary: Otter Notify About Store Hours Configuration Change on Eater Side
description: '`RATE LIMIT: 16 per minute`
'
operationId: postEaterSideStoreHoursConfigurationChange
parameters:
- $ref: '#/components/parameters/storeIdHeader'
- $ref: '#/components/parameters/eventIdOptionalHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoreHoursConfigurationEventResult'
examples:
PostEaterSideStoreHoursConfigurationChangeRequestExample:
summary: Default postEaterSideStoreHoursConfigurationChange request
x-microcks-default: true
value:
storeHoursConfiguration:
deliveryHours: {}
pickupHours: {}
timezone: America/Los_Angeles
statusChangedAt: '2007-12-03T10:15:30+01:00'
eventResultMetadata:
operationStatus: SUCCEEDED
additionalInformation: Completed without problems.
operationFinishedAt: '2007-12-03T10:15:30+01:00'
required: true
responses:
'204':
description: The store hours configuration change was successfully processed.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
security:
- OAuth2.0:
- storefront.store_hours_configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/v1/market-intel/store-details:
post:
tags:
- Storefront Endpoints
summary: Otter Notify About Store Details Update
operationId: postGetStoreDetailsResult
parameters:
- $ref: '#/components/parameters/eventIdOptionalHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetStoreDetailsEventResult'
examples:
PostGetStoreDetailsResultRequestExample:
summary: Default postGetStoreDetailsResult request
x-microcks-default: true
value:
superRegion: LATAM
storeDetails:
- regionId: LATAM-N
provider: ubereats-provider
id: 12345
storeUrl: 30
location: {}
address: {}
phoneNumbers:
- 613-123-4567
storeName: McDonald's
menu: {}
storeHours: {}
tags:
- chinese
storeBannerPhotoUrl: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg
storeRating: {}
coordinates: {}
storeSales: {}
avgBasketAmount: 25.21
storePromotions:
- {}
storeChain: {}
storeDeliveryInformation: {}
logoPhotoUrl: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg
priceLevel: {}
required: true
responses:
'204':
description: The store details updates were successfully processed
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
security:
- OAuth2.0:
- marketintel.service_integration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
Address:
type: object
nullable: true
properties:
fullAddress:
type: string
nullable: true
description: Full, human comprehensible address. It is usually formatted in the order appropriate for your locale.
example: 123 Sample Street Ste 100, San Francisco, CA 94103
postalCode:
type: string
description: Postal code of the address.
example: '20500'
city:
type: string
description: The city/town portion of the address.
example: Washington
state:
type: string
description: Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, or a prefecture.
example: DC
countryCode:
type: string
description: CLDR country code. See http://cldr.unicode.org/
example: US
addressLines:
type: array
nullable: true
description: Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip).
example:
- 1600 Pennsylvania Avenue NW
- 123 Sample Street Ste 100, San Francisco, CA 94103
items:
type: string
linesOfAddress:
type: array
nullable: true
deprecated: true
description: 'Deprecated: use addressLines. Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip).'
example:
- 1600 Pennsylvania Avenue NW
- 123 Sample Street Ste 100, San Francisco, CA 94103
items:
type: string
location:
$ref: '#/components/schemas/Location'
description: Order delivery address.
UnpauseStoreEventResult:
type: object
properties:
eventResultMetadata:
$ref: '#/components/schemas/RequiredEventResultMetadata'
description: Result of an event that requested to unpause a store.
StoreAvailabilityEventResult:
type: object
properties:
storeState:
type: string
nullable: true
description: Represents the current state of a store.
enum:
- OPEN
- OFF_HOUR
- SERVICE_PROVIDER_PAUSED
- OPERATOR_PAUSED
- SERVICE_PROVIDER_PAUSED_COURIERS_UNAVAILABLE
- STORE_UNAVAILABLE
- HOLIDAY_HOUR
- MENU_UNAVAILABLE
- SERVICE_PROVIDER_PAUSED_MISCONFIGURED
- OPEN_FOR_PICKUP_ONLY
- OPEN_FOR_DELIVERY_ONLY
- CLOSED_FOR_UNDETERMINED_REASON
example: OPEN
statusChangedAt:
type: string
nullable: true
description: The time when the store changed to the current state.
format: date-time
example: '2007-12-03T10:15:30+01:00'
eventResultMetadata:
$ref: '#/components/schemas/EventResultMetadata'
description: The current state of a store.
StoreHoursConfigurationEventResult:
type: object
properties:
storeHoursConfiguration:
$ref: '#/components/schemas/StoreHoursConfiguration'
statusChangedAt:
type: string
description: The time when the store hours configuration changed.
format: date-time
example: '2007-12-03T10:15:30+01:00'
eventResultMetadata:
$ref: '#/components/schemas/EventResultMetadata'
description: The current store hours configuration.
RequiredEventResultMetadata:
type: object
properties:
operationStatus:
type: string
description: Status of the operation requested by an event.
enum:
- SUCCEEDED
- INTERNAL_ERROR
- AUTHENTICATION_FAILURE
- AUTHORIZATION_FAILURE
- UNKNOWN_FAILURE
- INVALID_STORE_STATE
- INVALID_STORE_CONFIGURATION
- OPERATION_NOT_SUPPORTED
- IGNORED_ALREADY_IN_REQUESTED_STATE
- INVALID_REQUEST
example: SUCCEEDED
additionalInformation:
type: string
nullable: true
description: Additional details about the event result, if available.
example: Completed without problems.
operationFinishedAt:
type: string
description: Time when the processing of the event finished.
format: date-time
example: '2007-12-03T10:15:30+01:00'
description: Information about the result of a storefront event.
Money:
required:
- amount
- currencyCode
type: object
properties:
currencyCode:
maxLength: 3
minLength: 3
type: string
description: The 3-letter currency code (ISO 4217) to use for all monetary values.
example: EUR
amount:
minimum: 0
exclusiveMinimum: false
type: number
description: Amount value.
example: 25.21
description: Money amount.
example: 25.21
Marketintel_StoreDetails:
type: object
properties:
regionId:
type: string
nullable: true
description: The region that store belongs to.
example: LATAM-N
provider:
type: string
description: The store information provider
example: ubereats-provider
id:
type: string
description: The external store id
example: 12345
storeUrl:
type: string
nullable: true
description: The store url
example: 30
location:
type: object
description: The Geographic location used to discover the store
$ref: '#/components/schemas/Marketintel_GeoLocationInformation'
address:
type: object
nullable: true
description: The store address
$ref: '#/components/schemas/Address'
phoneNumbers:
type: array
minItems: 0
description: The store phone numbers.
items:
type: string
example: 613-123-4567
storeName:
type: string
nullable: true
description: The name of the store.
example: McDonald's
menu:
type: object
nullable: true
description: The store menu.
$ref: '#/components/schemas/Marketintel_StoreMenu'
storeHours:
type: object
nullable: true
description: The store hours.
$ref: '#/components/schemas/Marketintel_HoursData'
tags:
type: array
minItems: 0
description: The store tags
items:
description: The store tag
example: chinese
storeBannerPhotoUrl:
type: string
nullable: true
description: The store bannel photo url.
example: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg
storeRating:
type: object
nullable: true
description: The store ratings.
$ref: '#/components/schemas/Marketintel_StoreRating'
coordinates:
type: object
nullable: true
description: The coordinates of the store.
$ref: '#/components/schemas/Marketintel_Coordinates'
storeSales:
type: object
nullable: true
description: The store sales information.
$ref: '#/components/schemas/Marketintel_StoreSales'
avgBasketAmount:
type: object
nullable: true
description: The average order amount.
$ref: '#/components/schemas/Money'
storePromotions:
type: array
minItems: 0
description: The store promotions.
items:
$ref: '#/components/schemas/Marketintel_StorePromotion'
storeChain:
type: object
description: The store chain information.
$ref: '#/components/schemas/Marketintel_StoreChain'
storeDeliveryInformation:
type: object
nullable: true
description: The Store delivery information.
$ref: '#/components/schemas/Marketintel_StoreDeliveryInformation'
logoPhotoUrl:
type: string
nullable: true
description: The store photo url.
example: https://www.ubereats.com/ca/store/mcdonalds-1000-rideau-street/1QY5X6QcQX2Q4Z3Z3QZQYQ.jpg
priceLevel:
type: string
nullable: true
description: The estimated delivery time in minutes.
$ref: '#/components/schemas/Marketintel_StorePriceLevel'
description: The Store delivery information.
ErrorDetail:
type: object
properties:
attribute:
type: string
description: The error attribute.
example: Order Currency Code
message:
type: string
description: The error detail description.
example: Order Currency Code must be exactly 3 characters
description: The error detail response object.
ErrorMessage:
type: object
properties:
message:
type: string
description: The error description.
example: The request body is invalid.
details:
type: array
description: The error details.
items:
$ref: '#/components/schemas/ErrorDetail'
description: The error response object.
Marketintel_StoreMenu:
type: object
properties:
category:
type: string
nullable: true
description: The grouping category name.
example: Fast Food
ids:
type: array
description: The list of external store ids in the list in rank order.
items:
type: string
description: The external id the store
example: 123456
location:
type: object
description: The geographic location of the stores that was searched from.
description: The Store listing in ranking order based on category.
Marketintel_StoreChain:
type: object
properties:
chainId:
type: string
nullable: true
description: The external chain id.
example: 1
chainName:
type: string
nullable: true
description: The name of the chain.
example: Macdonalds
description: The Store Chain information.
Marketintel_StorePromotion:
type: object
properties:
displayName:
type: string
nullable: true
description: The name of the promotion.
example: Flat rate discount on Christmas day
promotionType:
type: string
nullable: true
description: The type of promotion.
example: Flat rate discount
campaignType:
type: string
nullable: true
description: The type of promotion campaign.
example: Christmas
promotionId:
type: string
nullable: true
description: The external promotion id.
example: 12345
description: The Store Promotion information. At least one of the displayName, promotionType, campaignType or promotionId need to be present.
Location:
required:
- latitude
- longitude
type: object
nullable: true
properties:
latitude:
type: num
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/openapi/otter-storefront-endpoints-api-openapi.yml