Otter Inventory Endpoints API

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


    The API endpoints are developed around RESTful principles secure via the OAuth2.0 protocol.'
  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: Inventory Endpoints
  description: Endpoints to interact with product inventory.
  x-displayName: Inventory
paths:
  /inventories/v1/summaries:
    get:
      tags:
      - Inventory Endpoints
      summary: Otter List Inventory Summaries
      operationId: listInventorySummaries
      description: '`RATE LIMIT: 32 per minute`


        List inventory summaries by the requested parameters.'
      parameters:
      - $ref: '#/components/parameters/inventory-summary-limit'
      - $ref: '#/components/parameters/opaquePaginationToken'
      - $ref: '#/components/parameters/storeIdHeader'
      responses:
        '200':
          description: The inventory summaries were successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventorySummariesResponse'
              examples:
                ListInventorySummaries200Example:
                  summary: Default listInventorySummaries 200 response
                  x-microcks-default: true
                  value:
                    inventorySummaries:
                    - id: ZDlhYTc1NjUtMzU3Z
                      gtin: 00049000608779
                      name: Coca-Cola Classic Coke Soft Drink 12 oz. can
                      slug: coca-cola-classic-soft-drink-12-oz-can
                      externalId: some-id-from-a-vendor-123
                      sellableQuantity: 42
                      unsellableQuantity: 42
                      inboundQuantity: 8
                    nextToken: H12MAF2fFaFFFa
        '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:
        - catalog
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /inventories/v1/shipments:
    get:
      tags:
      - Inventory Endpoints
      summary: Otter List Shipments
      operationId: listInventoryShipments
      description: '`RATE LIMIT: 8 per minute`


        List shipments by the requested parameters.'
      parameters:
      - $ref: '#/components/parameters/inventory-limit'
      - $ref: '#/components/parameters/opaquePaginationToken'
      - $ref: '#/components/parameters/storeIdHeader'
      responses:
        '200':
          description: The shipments were successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListShipmentsResponse'
              examples:
                ListInventoryShipments200Example:
                  summary: Default listInventoryShipments 200 response
                  x-microcks-default: true
                  value:
                    shipments:
                    - id: 18695c43-c670-4c57-a714-e0d7b215db20
                      deliveryInfo: {}
                      lineItems:
                      - {}
                      stateChanges:
                      - {}
                    nextToken: H12MAF2fFaFFFa
        '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:
        - catalog
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Inventory Endpoints
      summary: Otter Create Shipment
      operationId: createShipment
      description: '`RATE LIMIT: 32 per minute`


        Create a new shipment.'
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShipmentRequest'
            examples:
              CreateShipmentRequestExample:
                summary: Default createShipment request
                x-microcks-default: true
                value:
                  deliveryInfo: {}
                  lineItems:
                  - id: 1b8aec80-21aa-43f1-b510-2199ac54156a
                    slug: pizza-pepperoni-12-inch
                    externalId: id-in-external-system
                    manifestQuantity: 5
                    receivedSellableQuantity: 5
                    receivedUnsellableQuantity: 5
        required: true
      responses:
        '200':
          description: The shipment was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShipmentResponse'
              examples:
                CreateShipment200Example:
                  summary: Default createShipment 200 response
                  x-microcks-default: true
                  value:
                    id: 18695c43-c670-4c57-a714-e0d7b215db20
        '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:
        - catalog
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    '401':
      description: Invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '404':
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    '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'
    '422':
      description: The request body is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  parameters:
    inventory-limit:
      name: limit
      in: query
      required: false
      schema:
        type: string
        description: Max number of entities to retrieve
        example: 5
        maximum: 50
    opaquePaginationToken:
      name: token
      in: query
      required: false
      schema:
        type: string
        description: Opaque token used for paging. Query parameters must be URL encoded.
        example: CgwI09+kjQYQwOvF2AM=/(urlencoded:CgwI09%2BkjQYQwOvF2AM%3D)
    inventory-summary-limit:
      name: limit
      in: query
      required: false
      schema:
        type: string
        description: Max number of entities to retrieve
        example: 5
        maximum: 200
    storeIdHeader:
      name: X-Store-Id
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/StoreId'
  schemas:
    Shipment:
      required:
      - id
      - deliveryInfo
      - lineItems
      - stateChanges
      type: object
      properties:
        id:
          type: string
          description: A UUID for the shipment.
          example: 18695c43-c670-4c57-a714-e0d7b215db20
        deliveryInfo:
          $ref: '#/components/schemas/ShipmentDeliveryInfo'
        lineItems:
          type: array
          description: A list of the shipment line items.
          items:
            $ref: '#/components/schemas/ShipmentLineItem'
        stateChanges:
          type: array
          minItems: 1
          description: The state changes for the shipment. The final state change represents the current state of the shipment.
          items:
            $ref: '#/components/schemas/ShipmentStateChange'
    SelfDropDeliveryInfo:
      allOf:
      - $ref: '#/components/schemas/DeliveryMetadata'
      - required:
        - delivererName
        type: object
        description: Detailed delivery information for self-delivered shipments.
        properties:
          delivererName:
            type: string
            description: The name of the deliverer.
            example: Local Delivery Service
          delivererEmailAddress:
            type: string
            description: The email address of the deliverer.
            example: foo.bar@deliver.com
        additionalProperties: true
    DeliveryWindow:
      required:
      - start
      - end
      type: object
      description: The delivery window in which the shipment is expected to arrive at the destination.
      properties:
        start:
          type: string
          description: ISO-8601 timestamp representing the start of the time range.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        end:
          type: string
          description: ISO-8601 timestamp representing the end of the time range.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
    CreateShipmentResponse:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the shipment.
          example: 18695c43-c670-4c57-a714-e0d7b215db20
      description: A response containing information about the created shipment.
    CreateShipmentRequest:
      required:
      - deliveryInfo
      - lineItems
      type: object
      properties:
        deliveryInfo:
          $ref: '#/components/schemas/ShipmentDeliveryInfo'
        lineItems:
          type: array
          description: A list of the shipment line items.
          items:
            $ref: '#/components/schemas/CreateShipmentLineItem'
    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
    ParcelCarrierDeliveryInfo:
      allOf:
      - $ref: '#/components/schemas/DeliveryMetadata'
      - required:
        - carrierName
        type: object
        description: Detailed delivery information for standard postal carriers who deliver parcel shipments.
        properties:
          carrierName:
            type: string
            description: The name of the company delivering the shipment.
            enum:
            - FED_EX
            - UPS
            - ON_TRAC
            - DHL
            - CORREOS
            - ESTAFETA
            - BR_POST
            - TNT
            - OTHER
          trackingNumber:
            type: string
            description: The tracking number for this shipment
            example: 18492b99ad000
        additionalProperties: true
    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.
    CreateShipmentLineItem:
      required:
      - manifestQuantity
      type: object
      properties:
        id:
          type: string
          description: A CSS SKU UUID for the product. One of id, slug or externalId is required.
          example: 1b8aec80-21aa-43f1-b510-2199ac54156a
        slug:
          type: string
          description: A CSS SKU slug for the product. One of id, slug or externalId is required.
          example: pizza-pepperoni-12-inch
        externalId:
          type: string
          description: A SKU external ID for the product. One of id, slug or externalId is required.
          example: id-in-external-system
        manifestQuantity:
          type: integer
          description: The expected quantity of the product in the shipment.
          example: 5
        receivedSellableQuantity:
          type: integer
          description: The quantity of the product in the shipment received that was sellable.
          example: 5
        receivedUnsellableQuantity:
          type: integer
          description: The quantity of the product in the shipment received that was unsellable (damaged, expired, etc.).
          example: 5
    CourierServiceDeliveryInfo:
      allOf:
      - $ref: '#/components/schemas/DeliveryMetadata'
      - required:
        - courierName
        type: object
        description: Detailed delivery information for shipments using small point-to-point courier operations that may offer specialized services (scheduling, chill chain, etc).
        properties:
          courierName:
            type: string
            description: The name of the company delivering the shipment.
            example: Express Local Delivery Services
          trackingId:
            type: string
            description: The tracking ID for this shipment
            example: 18492b99ad000
        additionalProperties: true
    ShipmentState:
      type: string
      description: The state of the shipment.
      enum:
      - SCHEDULED
      - ARRIVED
      - STOCKING
      - CLOSED
      - CANCELED
    ShipmentLineItem:
      required:
      - id
      - manifestQuantity
      type: object
      properties:
        id:
          type: string
          description: A CSS SKU UUID for the product.
          example: 1b8aec80-21aa-43f1-b510-2199ac54156a
        manifestQuantity:
          type: integer
          description: The expected quantity of the product in the shipment.
          example: 5
        receivedSellableQuantity:
          type: integer
          description: The quantity of the product in the shipment received that was sellable.
          example: 5
        receivedUnsellableQuantity:
          type: integer
          description: The quantity of the product in the shipment received that was unsellable (damaged, expired, etc.).
          example: 5
    Gtin:
      type: string
      description: A 14 digit Global Trade Item Number (GTIN). For GTIN values that are shorter than 14 digits, value will be padded with leading zeroes.
      example: 00049000608779
    ListShipmentsResponse:
      type: object
      properties:
        shipments:
          type: array
          description: A list of shipments.
          maxItems: 50
          items:
            $ref: '#/components/schemas/Shipment'
        nextToken:
          type: string
          description: Opaque token used to fetch the following page. If set, pass the value of nextToken to the next request. If not set, no more results are available.
          example: H12MAF2fFaFFFa
    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.
    InventorySummariesResponse:
      type: object
      properties:
        inventorySummaries:
          type: array
          description: A list of the inventory summaries.
          maxItems: 100
          items:
            $ref: '#/components/schemas/InventorySummary'
        nextToken:
          type: string
          description: Opaque token used to fetch the following page. If set, pass the value of nextToken to the next request. If not set, no more results are available.
          example: H12MAF2fFaFFFa
    ShipmentDeliveryInfo:
      type: object
      description: Delivery information for a shipment.
      discriminator:
        propertyName: deliveryType
        mapping:
          selfDropDeliveryInfo: '#/components/schemas/SelfDropDeliveryInfo'
          courierServiceDeliveryInfo: '#/components/schemas/CourierServiceDeliveryInfo'
          parcelCarrierDeliveryInfo: '#/components/schemas/ParcelCarrierDeliveryInfo'
      oneOf:
      - $ref: '#/components/schemas/CourierServiceDeliveryInfo'
      - $ref: '#/components/schemas/ParcelCarrierDeliveryInfo'
      - $ref: '#/components/schemas/SelfDropDeliveryInfo'
    InventorySummary:
      required:
      - id
      - name
      - sellableQuantity
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the product.
          example: ZDlhYTc1NjUtMzU3Z
        gtin:
          $ref: '#/components/schemas/Gtin'
        name:
          type: string
          description: The name of the product.
          example: Coca-Cola Classic Coke Soft Drink 12 oz. can
        slug:
          type: string
          description: short, unique human-readable id for the product
          example: coca-cola-classic-soft-drink-12-oz-can
        externalId:
          type: string
          description: id of the product provided by the seller
          example: some-id-from-a-vendor-123
        sellableQuantity:
          type: integer
          description: The total quantity of the product ready to be sold. Does not include pending or in-progress shipments.
          example: 42
        unsellableQuantity:
          type: integer
          description: The total quantity of the product that is in the facility but unable to be sold. This will include inventory that is damaged, expired or otherwise unsellable.
          example: 42
        inboundQuantity:
          type: integer
          description: The total quantity of the product inbound to the facility or waiting at the facility to be processed.
          example: 8
      description: The inventory summary for a specific product.
    ShipmentStateChange:
      required:
      - timestamp
      - state
      type: object
      properties:
        state:
          $ref: '#/components/schemas/ShipmentState'
        timestamp:
          type: string
          description: ISO-8601 timestamp representing when the state change occurred.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
    DeliveryMetadata:
      required:
      - deliveryWindow
      - deliveryType
      type: object
      properties:
        deliveryWindow:
          $ref: '#/components/schemas/DeliveryWindow'
          description: The delivery window for the shipment.
        deliveryType:
          type: string
          description: The type of delivery service for this shipment.
          example: string
      additionalProperties: true
  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