Otter Delivery Endpoints API

Endpoints to manage delivery.

OpenAPI Specification

otter-delivery-endpoints-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Public Account Pairing Endpoints Delivery 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: Delivery Endpoints
  description: Endpoints to manage delivery.
  x-displayName: Delivery
paths:
  /v1/delivery/{deliveryReferenceId}/status:
    put:
      tags:
      - Delivery Endpoints
      summary: Otter Update Delivery Status
      description: '`RATE LIMIT: 8 per minute`

        '
      operationId: updateDeliveryStatus
      parameters:
      - $ref: '#/components/parameters/deliveryReferenceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryStatusUpdateRequest'
            examples:
              UpdateDeliveryStatusRequestExample:
                summary: Default updateDeliveryStatus request
                x-microcks-default: true
                value:
                  deliveryStatus: REQUESTED
                  estimatedDeliveryTime: '2007-12-03T10:15:30+01:00'
                  estimatedPickupTime: '2007-12-03T10:15:30+01:00'
                  courier:
                    name: Jane Doe
                    phone: +1-555-555-5555
                    phoneCode: 111 11 111
                    email: email@email.com
                    personalIdentifiers: {}
                  location:
                    latitude: 38.8977
                    longitude: 77.0365
                  createdAt: '2007-12-03T10:15:30+01:00'
                  vehicleInformation:
                    vehicleType: WALKER
                    licensePlate: ABCD 123
                    makeModel: Honda Civic
                  currencyCode: EUR
                  cost:
                    baseCost: 4.99
                    extraCost: 0.99
                  providerDeliveryId: store_123
                  dropoffInfo:
                    courierNote: string
                    proofOfDelivery: {}
                  deliveryTrackingUrl: https://example.com/resource
        required: true
      responses:
        '204':
          description: The event callback was successfully accepted.
        '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:
        - delivery.provider
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/delivery/{deliveryReferenceId}/quotes:
    post:
      tags:
      - Delivery Endpoints
      summary: Otter Notify the Result of a Request Delivery Quote Event
      description: '`RATE LIMIT: 8 per minute`

        '
      operationId: requestDeliveryQuoteCallback
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      - $ref: '#/components/parameters/deliveryReferenceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestDeliveryQuoteCallbackRequest'
            examples:
              RequestDeliveryQuoteCallbackRequestExample:
                summary: Default requestDeliveryQuoteCallback request
                x-microcks-default: true
                value:
                  minPickupDuration: 5
                  maxPickupDuration: 10
                  deliveryDistance:
                    unit: KILOMETERS
                    value: 1.0
                  currencyCode: EUR
                  cost:
                    baseCost: 4.99
                    extraCost: 0.99
                  provider: doordash
                  fulfillmentPath:
                  - name: rappi
                    type: FULFILLMENT_PROCESSOR
                  createdAt: '2007-12-03T10:15:30+01:00'
                  accountBalance: 1068.32
        required: true
      responses:
        '204':
          description: The event callback was successfully accepted.
        '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:
        - delivery.provider
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/delivery/{deliveryReferenceId}/accept:
    post:
      tags:
      - Delivery Endpoints
      summary: Otter Notify the Result of an Accept Delivery Event
      description: '`RATE LIMIT: 8 per minute`

        '
      operationId: acceptDeliveryCallback
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      - $ref: '#/components/parameters/deliveryReferenceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptDeliveryCallbackRequest'
            examples:
              AcceptDeliveryCallbackRequestExample:
                summary: Default acceptDeliveryCallback request
                x-microcks-default: true
                value:
                  deliveryDistance:
                    unit: KILOMETERS
                    value: 1.0
                  currencyCode: EUR
                  cost:
                    baseCost: 4.99
                    extraCost: 0.99
                  fulfillmentPath:
                  - name: rappi
                    type: FULFILLMENT_PROCESSOR
                  estimatedDeliveryTime: '2007-12-03T10:15:30+01:00'
                  estimatedPickupTime: '2007-12-03T10:15:30+01:00'
                  confirmedAt: '2007-12-03T10:15:30+01:00'
                  deliveryTrackingUrl: www.example.com
                  providerDeliveryId: store_123
        required: true
      responses:
        '204':
          description: The event callback was successfully accepted.
        '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:
        - delivery.provider
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/delivery/{deliveryReferenceId}/cancel:
    post:
      tags:
      - Delivery Endpoints
      summary: Otter Notify the Result of a Cancel Delivery Event
      description: '`RATE LIMIT: 8 per minute`

        '
      operationId: cancelDeliveryCallback
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      - $ref: '#/components/parameters/deliveryReferenceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelDeliveryCallbackRequest'
            examples:
              CancelDeliveryCallbackRequestExample:
                summary: Default cancelDeliveryCallback request
                x-microcks-default: true
                value:
                  canceledAt: '2007-12-03T10:15:30+01:00'
        required: true
      responses:
        '204':
          description: The event callback was successfully accepted.
        '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:
        - delivery.provider
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/delivery/callback/error:
    post:
      tags:
      - Delivery Endpoints
      summary: Otter Publish Delivery Callback Error
      description: '`RATE LIMIT: 16 per minute`

        '
      operationId: deliveryCallbackError
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventCallbackError'
            examples:
              DeliveryCallbackErrorRequestExample:
                summary: Default deliveryCallbackError request
                x-microcks-default: true
                value:
                  errorCode: NOT_FOUND
                  errorMessage: The store was not found.
        required: true
      responses:
        '200':
          description: The callback error was successfully accepted.
        '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:
        - callback.error.write
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/delivery/{deliveryReferenceId}/update:
    post:
      tags:
      - Delivery Endpoints
      summary: Otter Notify the Result of an Update Delivery Request Event
      description: '`RATE LIMIT: 8 per minute`

        '
      operationId: updateDeliveryRequestCallback
      parameters:
      - $ref: '#/components/parameters/storeIdHeader'
      - $ref: '#/components/parameters/eventIdHeader'
      - $ref: '#/components/parameters/deliveryReferenceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeliveryRequestCallbackRequest'
            examples:
              UpdateDeliveryRequestCallbackRequestExample:
                summary: Default updateDeliveryRequestCallback request
                x-microcks-default: true
                value:
                  currencyCode: EUR
                  cost:
                    baseCost: 4.99
                    extraCost: 0.99
        required: true
      responses:
        '204':
          description: The event callback was successfully accepted.
        '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:
        - delivery.provider
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DeliveryCost:
      type: object
      properties:
        baseCost:
          type: number
          format: double
          description: Base delivery cost value.
          example: 4.99
        extraCost:
          type: number
          format: double
          description: Extra delivery cost value.
          example: 0.99
      description: Delivery cost details.
    Person:
      type: object
      nullable: true
      properties:
        name:
          type: string
          nullable: true
          description: The person's name as it should be displayed.
          example: Jane Doe
          maxLength: 255
        phone:
          type: string
          nullable: true
          description: The person's phone number.
          example: +1-555-555-5555
          maxLength: 25
        phoneCode:
          type: string
          nullable: true
          description: A code or extension of the phone number.
          example: 111 11 111
          maxLength: 25
        email:
          type: string
          nullable: true
          description: The person's email address.
          example: email@email.com
        personalIdentifiers:
          $ref: '#/components/schemas/PersonalIdentifiers'
      description: The recipient information.
    EventCallbackError:
      type: object
      properties:
        errorCode:
          type: string
          description: 'Errors that occur processing the webhook, modeled after Google''s gRPC error codes.

            For callback errors responding to menu-related webhooks, any error with status code in:  "INVALID_ARGUMENT", "FAILED_PRECONDITION", "NOT_FOUND", "PERMISSION_DENIED", "ALREADY_EXISTS", "UNIMPLEMENTED", "DATA_LOSS", "UNAUTHENTICATED" will be considered fatal and will fail the operation without retrying.'
          enum:
          - CANCELLED
          - UNKNOWN
          - INVALID_ARGUMENT
          - FAILED_PRECONDITION
          - DEADLINE_EXCEEDED
          - NOT_FOUND
          - PERMISSION_DENIED
          - ALREADY_EXISTS
          - RESOURCE_EXHAUSTED
          - ABORTED
          - OUT_OF_RANGE
          - UNIMPLEMENTED
          - INTERNAL
          - UNAVAILABLE
          - DATA_LOSS
          - UNAUTHENTICATED
          example: NOT_FOUND
        errorMessage:
          type: string
          nullable: true
          description: Additional information about the error. This message will be displayed to the user, so ideally it should be friendly.
          example: The store was not found.
      description: The error container for a processed callback.
    AcceptDeliveryCallbackRequest:
      type: object
      properties:
        deliveryDistance:
          $ref: '#/components/schemas/Distance'
        currencyCode:
          type: string
          minLength: 3
          maxLength: 3
          description: The 3-letter currency code (ISO 4217) to use for all monetary values.
          example: EUR
        cost:
          $ref: '#/components/schemas/DeliveryCost'
        fulfillmentPath:
          type: array
          nullable: true
          description: List of entities involved in the fulfillment processing path.
          items:
            $ref: '#/components/schemas/FulfillmentPathEntity'
        estimatedDeliveryTime:
          type: string
          nullable: true
          description: The expected delivery time.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        estimatedPickupTime:
          type: string
          nullable: true
          description: The expected pickup time.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        confirmedAt:
          type: string
          description: The time that the request was accepted.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        deliveryTrackingUrl:
          type: string
          nullable: true
          description: URL to a web page that tracks the delivery.
          example: www.example.com
        providerDeliveryId:
          type: string
          nullable: true
          description: The provider's internal identifier for the delivery used for tracking purposes.
          example: store_123
      description: Delivery information.
    RequestDeliveryQuoteCallbackRequest:
      type: object
      properties:
        minPickupDuration:
          type: integer
          minimum: 0
          format: int32
          description: Minimum time required for courier to arrive at pickup location in minutes It is an estimation.
          example: 5
        maxPickupDuration:
          type: integer
          nullable: true
          description: Maximum time that the courier's arrival at pick up location can be delayed. If not provided, it will default to 60 minutes or minPickUpDuration, whichever is greater. This value is an estimation and expressed in minutes.
          format: int32
          example: 10
        deliveryDistance:
          $ref: '#/components/schemas/Distance'
        currencyCode:
          type: string
          minLength: 3
          maxLength: 3
          description: The 3-letter currency code (ISO 4217) to use for all monetary values.
          example: EUR
        cost:
          $ref: '#/components/schemas/DeliveryCost'
        provider:
          type: string
          nullable: true
          description: Delivery Service Provider Slug.
          example: doordash
        fulfillmentPath:
          type: array
          nullable: true
          description: List of entities involved in the fulfillment processing path.
          items:
            $ref: '#/components/schemas/FulfillmentPathEntity'
        createdAt:
          type: string
          description: The time that the quote was created.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        accountBalance:
          type: number
          nullable: true
          description: The remaining account balance of the requester for the delivery provider.
          example: 1068.32
      description: Delivery quote information.
    CancelDeliveryCallbackRequest:
      type: object
      properties:
        canceledAt:
          type: string
          description: The time that the request was cancelled.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
      description: Cancellation result callback request.
    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.
    DeliveryStatusUpdateRequest:
      type: object
      properties:
        deliveryStatus:
          $ref: '#/components/schemas/DeliveryStatus'
        estimatedDeliveryTime:
          type: string
          nullable: true
          description: The expected delivery time.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        estimatedPickupTime:
          type: string
          nullable: true
          description: The expected pickup time.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        courier:
          $ref: '#/components/schemas/Person'
        location:
          $ref: '#/components/schemas/Location'
        createdAt:
          type: string
          description: The time that the update was created.
          format: date-time
          example: '2007-12-03T10:15:30+01:00'
        vehicleInformation:
          nullable: true
          $ref: '#/components/schemas/VehicleInformation'
        currencyCode:
          type: string
          nullable: true
          minLength: 3
          maxLength: 3
          description: The 3-letter currency code (ISO 4217) to use for all monetary values.
          example: EUR
        cost:
          nullable: true
          $ref: '#/components/schemas/DeliveryCost'
        providerDeliveryId:
          type: string
          nullable: true
          description: The provider's internal identifier for the delivery used for tracking purposes.
          example: store_123
        dropoffInfo:
          nullable: true
          $ref: '#/components/schemas/DropoffInfo'
          description: Details on delivery dropoff.
        deliveryTrackingUrl:
          type: string
          nullable: true
          description: Delivery tracking url.
          example: https://example.com/resource
      description: Update delivery status request.
    Location:
      required:
      - latitude
      - longitude
      type: object
      nullable: true
      properties:
        latitude:
          type: number
          description: The latitude of the location.
          format: double
          example: 38.8977
        longitude:
          type: number
          description: The longitude of the location.
          format: double
          example: 77.0365
      description: Latitude and longitude of the address.
    VerificationProof:
      type: object
      nullable: true
      properties:
        signatureProof:
          nullable: true
          $ref: '#/components/schemas/SignatureProof'
        pictureProof:
          nullable: true
          $ref: '#/components/schemas/PictureProof'
      description: Verification details.
    FulfillmentPathEntity:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: Describes the entity name.
          example: rappi
        type:
          type: string
          description: Type of entities in the fulfillment path.
          enum:
          - FULFILLMENT_PROCESSOR
          - INTERMEDIARY
          example: FULFILLMENT_PROCESSOR
      description: Delivery distance.
    UpdateDeliveryRequestCallbackRequest:
      type: object
      properties:
        currencyCode:
          type: string
          nullable: true
          minLength: 3
          maxLength: 3
          description: The 3-letter currency code (ISO 4217) to use for all monetary values.
          example: EUR
        cost:
          nullable: true
          $ref: '#/components/schemas/DeliveryCost'
          description: Updated delivery cost.
      description: Updated Delivery information.
    PictureProof:
      type: object
      nullable: true
      properties:
        pictureUrl:
          type: string
          description: Image url.
          example: https://example.com/resource
      description: Picture info captured.
    Distance:
      type: object
      nullable: true
      properties:
        unit:
          type: string
          description: Distance unit value.
          enum:
          - KILOMETERS
          - MILES
          example: KILOMETERS
        value:
          type: number
          description: Distance value.
          example: 1.0
      description: Delivery distance.
    DropoffInfo:
      type: object
      nullable: true
      properties:
        courierNote:
          nullable: true
          type: string
          description: Courier supplied dropoff note.
          example: string
        proofOfDelivery:
          nullable: true
          $ref: '#/components/schemas/VerificationProof'
          description: Proof of delivery.
      description: Delivery dropoff details.
    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
    PersonalIdentifiers:
      type: object
      nullable: true
      properties:
        taxIdentificationNumber:
          type: string
          nullable: true
          description: Person tax identification number.
          example: 1234567890
        serviceProviderId:
          type: string
          nullable: true
          description: External service provider ID i.e. Courier Id.
          example: 12345ba6-789e-123f-4e56-d78db90d123b
      description: The person's personal identifiers (e.g. tax identification number).
    SignatureProof:
      type: object
      nullable: true
      properties:
        signatureImageUrl:
          type: string
          description: Signature image url.
          example: https://example.com/resource
        signerName:
          nullable: true
          type: string
          description: The name of the signer.
          example: Sample Name
        signerRelationship:
          nullable: true
          type: string
          description: The relationship of signer to the intended recipient.
          example: string
      description: Signature info captured.
    DeliveryStatus:
      type: string


# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/openapi/otter-delivery-endpoints-api-openapi.yml