> ## Documentation Index
> Fetch the complete documentation index at: https://api-doc.xmenu.it/llms.txt
> Use this file to discover all available pages before exploring further.

# Pickup / delivery times

> Retrieval of available times for pickup at the location or home delivery

<Badge color="blue" icon="key">`write:orders`</Badge>


## OpenAPI

````yaml openapi-en.json POST /order/pickup_delivery_times
openapi: 3.1.0
info:
  title: xMenu API
  description: xMenu Public API - REST endpoints and webhook notifications
  version: 1.0.0
servers:
  - url: https://app.xmenu.it/api
    description: xMenu API Production
security: []
paths:
  /order/pickup_delivery_times:
    post:
      tags:
        - Order Insertion
      summary: Pickup / delivery times
      description: Retrieval of available times for pickup at the location or home delivery
      operationId: orderPickupDeliveryTimes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - dmethod
              properties:
                subrestaurant_uid:
                  type: string
                  description: Location identifier. Required for multi-location restaurants
                dmethod:
                  type: string
                  description: |-
                    Delivery method:
                    - `0` = pickup at location
                    - `1` = home delivery
                    - `0t` = at table
                    - `20` = pickup at pickup point
                    - `0e-{id}` = event (where {id} is the event ID)
                    - `dcf-{id}` = custom method (where {id} is the method ID)
                place_id:
                  type: string
                  description: >-
                    Address identifier (obtained from address validation).
                    Required if `dmethod` = 1 (home delivery)
                language:
                  type: string
                  description: ISO 639-1 language code; defaults to restaurant settings
      responses:
        '200':
          description: Available times response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderPickupDeliveryTimesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - clientId: []
          clientSecret: []
        - oauth2: []
components:
  schemas:
    OrderPickupDeliveryTimesResponse:
      type: object
      required:
        - success
      properties:
        success:
          type: boolean
          description: 'Operation result: `true` if successful, `false` if failed'
        error:
          type: string
          description: >-
            Error code if the operation failed. Possible values:

            - `SUBRESTAURANT_NOT_FOUND` = location not found

            - `INVALID_ADDRESS` = invalid address


            See [Error codes](/docs/en/overview/error-codes) for general error
            codes that may occur.
        message:
          type: string
          description: Human-readable error description if the operation failed
        data:
          type: object
          description: Available times data (present only if success = true)
          properties:
            pickup_times:
              type: array
              description: >-
                Available pickup times (present if `dmethod` = 0 or similar).
                Empty array if no availability
              items:
                type: object
                required:
                  - date
                  - formatted
                properties:
                  date:
                    type: string
                    format: date-time
                    description: Date and time in ISO format
                  formatted:
                    type: string
                    description: Formatted date and time for localized display
            delivery_times:
              type: array
              description: >-
                Available delivery times (present if `dmethod` = 1 or similar).
                Empty array if no availability
              items:
                type: object
                required:
                  - date
                  - formatted
                properties:
                  date:
                    type: string
                    format: date-time
                    description: Date and time in ISO format
                  formatted:
                    type: string
                    description: Formatted date and time for localized display
  responses:
    Unauthorized:
      description: Authentication failed.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                description: >-
                  Standard error format (when using API Key or Client ID/Secret
                  authentication)
                required:
                  - success
                  - error
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for errors
                  error:
                    type: string
                    enum:
                      - RESTAURANT_NOT_FOUND
                      - INVALID_KEY
                      - INVALID_AUTH
                    description: Error code
                  message:
                    type: string
                    description: Human-readable error description
              - type: object
                description: OAuth error format (when using Bearer token authentication)
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - invalid_token
                      - invalid_request
                    description: OAuth error code (RFC 6749)
                  error_description:
                    type: string
                    description: Human-readable error description
          examples:
            standard:
              summary: Standard error format (API Key / Client ID+Secret)
              value:
                success: false
                error: INVALID_KEY
                message: The provided API key is not valid
            oauth:
              summary: OAuth error format (Bearer token)
              value:
                error: invalid_token
                error_description: Access token is invalid or expired
    Forbidden:
      description: Authorization failed - insufficient permissions or access denied.
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                description: >-
                  Standard error format (when using API Key or Client ID/Secret
                  authentication)
                required:
                  - success
                  - error
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for errors
                  error:
                    type: string
                    enum:
                      - API_DISABLED
                      - INSUFFICIENT_SCOPE
                      - UNAUTHORIZED
                    description: Error code
                  message:
                    type: string
                    description: Human-readable error description
              - type: object
                description: OAuth error format (when using Bearer token authentication)
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - insufficient_scope
                      - invalid_request
                    description: OAuth error code (RFC 6749)
                  error_description:
                    type: string
                    description: Human-readable error description
          examples:
            standard:
              summary: Standard error format (API Key / Client ID+Secret)
              value:
                success: false
                error: API_DISABLED
                message: API access is not enabled for the restaurant
            oauth:
              summary: OAuth error format (Bearer token)
              value:
                error: insufficient_scope
                error_description: 'Missing required permissions: write:orders'
  securitySchemes:
    clientId:
      type: apiKey
      in: header
      name: X-Client-Id
      description: >-
        Client ID for API Client authentication (must be used together with
        Client Secret)
    clientSecret:
      type: apiKey
      in: header
      name: X-Client-Secret
      description: >-
        Client Secret for API Client authentication (must be used together with
        Client ID)
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://app.xmenu.it/oauth/token
          scopes: {}
      description: >-
        OAuth 2.0 authentication using client credentials flow. The access token
        must be included in the Authorization header as a Bearer token.

````