CloudKitchens Manager Storefront Endpoints API

openapi: 3.2.0
info:
  title: Public Manager Storefront Endpoints API
  description: '# Overview


    The API endpoints are developed around RESTful principles secure via the OAuth2.0 protocol.'
  version: v1
  license:
    name: Proprietary
servers:
- url: https://{{public-api-url}}
  description: Staging server url
tags:
- name: Manager Storefront Endpoints
  description: Endpoints for applications managing storefront related data and operations.
  x-displayName: Storefront Manager
paths:
  /manager/storefront/v1/storefront/pause:
    post:
      tags:
      - Manager Storefront Endpoints
      summary: Request pausing storefronts of a store
      description: '`RATE LIMIT: 8 per minute`'
      operationId: pauseStorefronts
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PauseRequest'
        required: true
      responses:
        '200':
          description: The pause request was successfully accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PauseResponse'
        '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:
        - manager.storefront
  /manager/storefront/v1/storefront/unpause:
    post:
      tags:
      - Manager Storefront Endpoints
      summary: Request unpausing storefronts of a store
      description: '`RATE LIMIT: 8 per minute`'
      operationId: unpauseStorefronts
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnpauseRequest'
        required: true
      responses:
        '200':
          description: The unpause request was successfully accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnpauseResponse'
        '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:
        - manager.storefront
  /manager/storefront/v1/storefront/pause/request/{requestId}/status:
    get:
      tags:
      - Manager Storefront Endpoints
      summary: Get the process status details of a pause request
      description: '`RATE LIMIT: 8 per minute`'
      operationId: getPauseRequestStatus
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/requestId'
      responses:
        '200':
          description: The get request processing details was successfully accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingStatusResponse'
        '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:
        - manager.storefront
  /manager/storefront/v1/storefront/unpause/request/{requestId}/status:
    get:
      tags:
      - Manager Storefront Endpoints
      summary: Get the process status details of an unpause request
      description: '`RATE LIMIT: 8 per minute`'
      operationId: getUnpauseRequestStatus
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/requestId'
      responses:
        '200':
          description: The get request processing details was successfully accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingStatusResponse'
        '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:
        - manager.storefront
components:
  schemas:
    ProcessStoreServiceProviderStatus:
      type: object
      properties:
        requestId:
          type: string
          description: The request id of the operation specific to service provider.
        provider:
          type: string
          description: The service provider.
          example: doordash
        startedAt:
          type:
          - string
          - 'null'
          description: The time at which the provider level request was started.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        finishedAt:
          type:
          - string
          - 'null'
          description: The time at which the provider level request was completed.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        stateInfo:
          type: array
          minItems: 0
          description: List of request state details.
          items:
            $ref: '#/components/schemas/RequestStateInfo'
        requestStatus:
          $ref: '#/components/schemas/Status'
        currentState:
          $ref: '#/components/schemas/RequestState'
      description: Provider level request status details
    ProcessingStatusResponse:
      type: object
      properties:
        processRequestStatuses:
          type: array
          minItems: 0
          description: List of provider level requests
          items:
            $ref: '#/components/schemas/ProcessStoreServiceProviderStatus'
      description: Processing status response
    RequestAction:
      type: object
      properties:
        operationType:
          $ref: '#/components/schemas/OperationType'
        status:
          $ref: '#/components/schemas/Status'
        retryAttempt:
          type: number
          description: The current retry attempt.
          example: 2
        error:
          $ref: '#/components/schemas/StorefrontError'
      description: Request action details of the current state
    StoreId:
      type: string
      description: The unique identifier of the store in the partner application. This ID, along with the `Application ID`, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to `onboarding:905bb725-b141-4a9b-832a-1f254f772c94` (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided `internalStoreId` (a.k.a. Sku-Sku ID).
      example: partner-store-unique-identifier
    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.
    RequestStateInfo:
      type: object
      properties:
        startedAt:
          type:
          - string
          - 'null'
          description: The time at which the request was started.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        state:
          $ref: '#/components/schemas/RequestState'
        status:
          $ref: '#/components/schemas/Status'
        finishedAt:
          type:
          - string
          - 'null'
          description: The time at which the request was completed.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        action:
          type: array
          minItems: 0
          description: List of request actions.
          items:
            $ref: '#/components/schemas/RequestAction'
        error:
          $ref: '#/components/schemas/StorefrontError'
      description: Request state details
    Status:
      type: string
      description: Status of the operation
      enum:
      - UNKNOWN
      - SUCCESS
      - FAIL
      - IN_PROGRESS
    UnpauseResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The requestId of the unpause request.
      description: Unpause response details
    OperationType:
      type: string
      description: Type of the operation
      enum:
      - UNKNOWN
      - PAUSE
      - UNPAUSE
    PauseRequest:
      type: object
      properties:
        start:
          type:
          - string
          - 'null'
          description: Start time for the pause. Executed immediately if not set.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        end:
          type:
          - string
          - 'null'
          description: Time when the pause should expire. If not provided, uses the default which is 4 AM at store timezone.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        comment:
          type:
          - string
          - 'null'
          description: Comment for the pause
          example: Some comment
        reason:
          $ref: '#/components/schemas/PauseReason'
      description: Pause request parameters
    PauseReason:
      type: string
      description: Reason for pausing the storefronts
      enum:
      - STORE_MAINTENANCE
      - OTHER
    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.
    UnpauseRequest:
      type: object
      properties:
        comment:
          type:
          - string
          - 'null'
          description: Comment for the unpause
          example: Some comment
      description: Unpause request parameters
    StorefrontError:
      type: object
      properties:
        errorType:
          type: string
          description: The type of the error.
        message:
          type: string
          description: The error messageß.
      description: Unpause response details
    RequestState:
      type: string
      description: State of the requested operation
      enum:
      - UNKNOWN
      - QUEUED
      - IN_PROGRESS
      - PROVIDER_REQUEST_IN_PROGRESS
      - VALIDATION
      - COMPLETED
      - FAILED
      - CANCELLED
    PauseResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The requestId of the pause request.
      description: Pause response details
  responses:
    '403':
      description: Authorization not valid for the requested resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '400':
      description: The request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '404':
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '401':
      description: Invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '422':
      description: The request body is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  parameters:
    storeIdHeader:
      name: X-Store-Id
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/StoreId'
    requestId:
      name: requestId
      in: path
      required: true
      schema:
        type: string
        description: A unique identifier of the order in a UUID format.
        example: 295f76b4-5725-4bf5-a8ab-97943dbdc3b4
  securitySchemes:
    OAuth2.0:
      type: oauth2
      description: "The **Authorization API** is based on the [OAuth2.0 protocol](https://tools.ietf.org/html/rfc6749), supporting the (Client Credentials)[https://datatracker.ietf.org/doc/html/rfc6749#section-4.4] and the (Authorization Code)[https://datatracker.ietf.org/doc/html/rfc6749#section-4.1] flows. Resources expect a valid token sent as a `Bearer` token in the HTTP `Authorization` header.\n### Scopes\nScopes must be configured by our internal team to be enabled for an app. Once the scopes are configured they can be enabled on the Application Settings Page in Developer Portal. Each endpoint requires a given scope that can be verified on each endpoint documentation. When generating an OAuth2.0 token multiple scopes can be requested.\n\n### Authorization Code Flow\nTo perform this flow, the authorization code flow must be enabled in the Application Settings Page in Developer Portal. When enabling the flow it is mandatory to provide a redirect URI pointing to your application. Once the flow is complete we will redirect the user to this URI passing the 'code' and 'state' parameters.\nThe Authorization Code flow provides a temporary code that the client application can exchange for an access token. To start the flow the application must request the user authorization. This is done by sending a request to https://{{public-api-url}}/v1/auth/oauth2/authorize.\nExample\n```\ncurl --location 'https://{{public-api-url}}/v1/auth/oauth2/authorize?client_id=[CLIENT_ID]&redirect_uri=[REDIRECT_URI]&response_type=code&scope=organization.read&state=8A9D16B4C3E25F6A'\n```\nThis call will return a 302 redirecting the user to our authorization page. If the user approves the application, we will redirect to configured URI passing the authorization code in the query parameter 'code'. The 'state' parameter is also sent to ensure the source of the data.\nWith the authorization code, the client application can generate the token.\n### Client Credentials Flow\nThe client_credentials flow does not require any steps before generating the token. Once your application is ready, and the client_id and client_secret are available, the token can be generated by following the instructions in the next section.\n\n### Generate Token\nTo generate the token, use the `Client ID` and `Client Secret` (provided during onboarding), and optionally the authorization code obtained after performing the Authorization Code flow, to the [Token Auth endpoint](#operation/requestToken) endpoint. The result of this invocation is a token that is valid for a pre-determined time or until it is manually revoked.\n\nThe access token obtained will be sent as a `Bearer` value of the `Authorization` HTTP header.\n\nClient credentials in the request-body and HTTP Basic Auth are supported.\n\n#### Request Example for client_credentials\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/auth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'scope=ping' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'client_id=[APPLICATION_ID]' \\\n  --data-urlencode 'client_secret=[CLIENT_SECRET]'\n\n```\n#### Request Example for authorization_code\n```\ncurl --location --request POST 'https://{{public-api-url}}/v1/auth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'scope=ping' \\\n  --data-urlencode 'grant_type=authorization_code' \\\n  --data-urlencode 'client_id=[APPLICATION_ID]' \\\n  --data-urlencode 'client_secret=[CLIENT_SECRET]' \\\n  --data-urlencode 'code=[code]' \\\n  --data-urlencode 'redirect_uri=[redirect_uri]'\n\n```\n#### Response Example\n```\n{\n  \"access_token\": \"oMahtBwBbnZeh4Q66mSuLFmk2V0_CLCKVt0aYcNJlcg.yditzjwCP7yp0PgR6AzQR3wQ1rTdCjkcPeAMuyfK-NU\",\n  \"expires_in\": 2627999,\n  \"scope\": \"ping orders.create\",\n  \"token_type\": \"bearer\"\n}\n```\n\n### Token Usage\n\nThe token provided in field `access_token` is used to authenticate when consuming the API endpoints. Send the token value in the `Authorization` header of every request. The token expiration time is represented in the field `expired_in`, in seconds. Currently, all tokens are valid for 30 days and should be stored and re-used while still valid.\n\nNote that occasionally, a 401 error may be returned for a valid token due to an internal service issue. Such occurrences should be rare. To prevent exposing potential vulnerabilities to attackers, the Public API does not disclose other types of errors in the authentication flow if for any reason the token can't be validated (when it's a valid token then it's ok to return 5XX or other 4XX though - such as 403). In such scenarios, although the internal auth flow avoids retries to prevent attacks, if the token is known to be valid and not expired, a retry with a backoff interval by the client is advised. Another option is to request a new token.\n\n#### Example\n\n```\ncurl --location --request GET 'https://{{public-api-url}}/v1/ping' \\\n  --header 'Authorization: Bearer <access_token>' \\\n  --header 'X-Store-Id: <storeId>'\n\n```\n"
      flows:
        clientCredentials:
          tokenUrl: /v1/auth/token
          scopes:
            catalog: Permission to interact with product inventory for existing stores.
            delivery.provider: Permission to provide delivery services for existing orders.
            finance: Permission to provide financial data for orders/stores.
            manager.menus: Permission to manage menus.
            manager.orders: Permission to manage orders.
            manager.storefront: Permission to manage storefront.
            menus.async_job.read: Permission to read the status of a menu upsert job.
            menus.entity_suspension: Permission to notify the result of a menu entity availability update, after being requested by a webhook event.
            menus.get_current: Permission to send the current state of a menu, after being requested by a webhook event.
            menus.publish: Permission to notify the result of a publish menus operation for a given store.
            menus.read: Permission to read the current menus for a given store.
            menus.upsert: Permission to create/update menus for a given store.
            menus.upsert_hours: Permission to notify the receiving of the upsert hours menu event, after being requested by a webhook event.
            orders.create: Permission to create new order for a given store.
            orders.read: Permission to read orders and connected data.
            orders.update: Permission to create and update new orders for a given store.
            ping: Permission to ping the system.
            reports.generate_report: Permission to request reports for given store(s) and period of time.
            reviews.reply: Permission to reply to reviews.
            storefront.store_pause_unpause: Permission to notify the result of a pause/unpause operation, after being requested by a webhook event.
            storefront.store_availability: Permission to send the current state of store.
            storefront.store_hours_configuration: Permission to send the current store hours configuration.
            stores.manage: Permission to onboard stores and update the identifier.
            callback.error.write: Token has permission to send failed webhook event results.
            manager.loyalty: Permission to interact with loyalty services.
            direct.orders: Permission to interact with direct order services.
            store.read: Permission to query store information.
        authorizationCode:
          authorizationUrl: /v1/auth/oauth2/authorize
          tokenUrl: /v1/auth/token
          scopes:
            organization.read: Permission to read data for organization/brands/stores on behalf of a user.
            organization.service_integration: Permission to manage the your integration with a given store on behalf of a user.
x-tagGroups:
- name: Endpoints
  tags:
  - account_pairing_endpoints
  - auth_endpoints
  - callback_endpoints
  - delivery_endpoints
  - finance_endpoints
  - inventory_endpoints
  - manager_menu_endpoints
  - manager_order_endpoints
  - manager_storefront_endpoints
  - menus_endpoints
  - orders_endpoints
  - organization_endpoints
  - ping_endpoints
  - reports_endpoints
  - reviews_endpoints
  - storefront_endpoints
  - manager_loyalty_endpoints
  - direct_orders_endpoints
  - store_endpoints
- name: Webhooks
  tags:
  - account_pairing_webhooks
  - delivery_webhooks
  - manager_orders_webhooks
  - menus_webhooks
  - orders_webhooks
  - ping_webhooks
  - reports_webhooks
  - storefront_webhooks
x-provenance:
  method: harvested
  publisher: CloudKitchens
  source: https://connect.cloudkitchens.com/docs/openapi/public-api.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)