> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve fulfillment options

> Returns available fulfillment options for a cart and delivery pincode. The `summary` object indicates `collect_available`, `deliver_available`, and `recommended_fulfillment_type`. Use the `collect` array for Click & Collect store locations and `deliver` for delivery details. Requires a signed-in POS staff session with permission for this operation.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-pos.json post /pos/carts/fulfillment-options
openapi: 3.2.0
info:
  title: CE POS APIs
  description: >-
    The consolidated Point of Sale surface. Every operation is served under the
    storefront base URL; the POS backend proxies some of them to the admin
    service.
  version: '1.0'
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/storefront
    description: Staging Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: staging
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/storefront
    description: Prod Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: prod
security:
  - Authorization: []
tags:
  - name: section-identity
    summary: Identity
    kind: nav
  - name: Devices
    description: >-
      Set up the till: pair a device with the store using its pairing code, list
      the store's `PosLocation`s and `PosDevice`s, and claim a device for the
      signed-in user or release it.
    summary: Devices
    kind: nav
    parent: section-identity
  - name: Authentication
    description: >-
      Sign a staff member in on a paired device with a one-time password over
      SMS, WhatsApp or email, then refresh the access token or log out.
    summary: Authentication
    kind: nav
    parent: section-identity
  - name: Users
    description: >-
      The staff member signed in on the till, as a `PosUser` with their
      location, device and roles.
    summary: Users
    kind: nav
    parent: section-identity
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Look up the shopper at the till: list customers (`CustomerListItem`) and
      read one's full `CustomerDetail`.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Addresses
    description: >-
      A customer's saved addresses, as `Address` objects: list, add, update and
      remove them.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Browse and search the catalog at the till: list `Product`s and SKUs, read
      a product and its variants, and show similar, up-sell and cross-sell
      items.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read product reviews at the till.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Categories
    description: >-
      The store's categories, as `ProductCategory` objects with their child
      categories.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Stock at the store's locations: list it by item, read an item's
      `InventoryDetail`, and follow the `InventoryActivity` that moved it.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: >-
      The till's `Cart`: create it, add, update or remove items, link the
      customer, set the address, and apply loyalty points or credit balance.
      Each update returns the full, updated `Cart`.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: >-
      The coupons and promotions a cart can use: list what the store offers, see
      which apply to a cart and why the rest don't, and apply or remove a
      coupon.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: Fulfillment
    description: >-
      List the delivery and collect-in-store options for a cart, and save the
      cart's choice.
    summary: Fulfillment
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Place an order from the till's cart and follow it: list orders, read an
      `OrderDetail` and its activity, check stock before it ships, and get its
      invoice, receipt and shipments.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Order payments
    description: >-
      Collect payment for an order: add payments toward what is left to pay,
      across one or more methods, poll the payment status, and retry a failed or
      expired payment.
    summary: Order payments
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      The shipments that fulfill orders: list them, read a `ShipmentDetail` with
      its activity and invoice, approve, reject or update one, send a
      replacement, and refund a shortfall.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Payments
    description: >-
      The payment methods the till accepts and the checks around paying with
      them: card BIN details, VPA verification, and authenticating a payment
      with a direct OTP.
    summary: Payments
    kind: nav
    parent: section-payments
  - name: section-store
    summary: Store
    kind: nav
  - name: Locations
    description: States and pincodes for address forms.
    summary: Locations
    kind: nav
    parent: section-store
paths:
  /pos/carts/fulfillment-options:
    post:
      tags:
        - Fulfillment
      summary: Retrieve fulfillment options
      description: >-
        Returns available fulfillment options for a cart and delivery pincode.
        The `summary` object indicates `collect_available`, `deliver_available`,
        and `recommended_fulfillment_type`. Use the `collect` array for Click &
        Collect store locations and `deliver` for delivery details. Requires a
        signed-in POS staff session with permission for this operation.
      operationId: pos-get-fulfillment-options
      parameters: []
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CartBasedFulfillmentOption'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      summary:
                        type: object
                        properties:
                          collect_available:
                            type: boolean
                          deliver_available:
                            type: boolean
                          recommended_fulfillment_type:
                            enum:
                              - collect-in-store
                              - delivery
                              - partial-collect-and-delivery
                          recommended_store:
                            oneOf:
                              - $ref: '#/components/schemas/CollectInStore'
                              - type: 'null'
                        required:
                          - collect_available
                          - deliver_available
                          - recommended_fulfillment_type
                          - recommended_store
                      collect:
                        type: array
                        items:
                          $ref: '#/components/schemas/CollectInStore'
                      deliver:
                        $ref: '#/components/schemas/DeliveryOption'
                    required:
                      - summary
                      - collect
                      - deliver
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
          description: The cart is missing or inactive, or the request is invalid.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
        - Authorization: []
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/operations/pos-get-fulfillment-options
components:
  schemas:
    CartBasedFulfillmentOption:
      title: CartBasedFulfillmentOption
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/CartBasedFulfillmentOption
      required:
        - cart_id
      properties:
        cart_id:
          type: string
          minLength: 1
          pattern: \S
        fulfillment_type:
          description: Omit or send null to use the cart's fulfillment type.
          type:
            - string
            - 'null'
          enum:
            - delivery
            - collect-in-store
            - null
        warehouse_id:
          type: array
          items:
            type: string
            minLength: 1
            pattern: \S
        mode:
          description: Accepted for compatibility; does not change the available options.
          type: string
          enum:
            - SURFACE
            - AIR
            - ALL
        shipping_provider_id:
          description: Accepted for compatibility; does not filter the available options.
          type: string
          minLength: 1
          pattern: \S
    CollectInStore:
      title: CollectInStore
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/CollectInStore
      properties:
        id:
          type: string
        name:
          type: string
        distance_km:
          type: number
        collect_eta_minutes:
          type: integer
        is_recommended:
          type: boolean
        address:
          $ref: '#/components/schemas/CollectInStoreAddress'
    DeliveryOption:
      title: DeliveryOption
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/DeliveryOption
      required:
        - is_serviceable
        - free_shipping_threshold
        - shipments
      properties:
        is_serviceable:
          type: boolean
        free_shipping_threshold:
          description: free shipping threshold of delivery option
          type:
            - number
            - 'null'
        shipments:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              items:
                type: array
                items:
                  $ref: '#/components/schemas/ShipmentItem'
              shipping_methods:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    shipping_type:
                      enum:
                        - auto
                        - manual
                    shipping_amount:
                      description: >-
                        shipping amount of manual method or as per recommened
                        courier or range of min-max shipping amount.
                      type: string
                    estimated_delivery_days:
                      description: >-
                        estimated delivery days of manual method or as per
                        recommened courier or range of min-max estimated
                        delivery days.
                      type: string
                    courier_companies:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type:
                              - string
                              - number
                          name:
                            type: string
                          shipping_amount:
                            type: number
                          estimated_delivery_days:
                            type: string
                          is_recommended:
                            type: boolean
                          is_hyperlocal:
                            type: boolean
                          mode:
                            enum:
                              - air
                              - surface
                          rating:
                            type: number
                          is_surface:
                            type: boolean
                          delivery_leadtime_minimum:
                            type:
                              - integer
                              - 'null'
                          delivery_leadtime_maximum:
                            type:
                              - integer
                              - 'null'
                    delivery_leadtime_minimum:
                      type:
                        - string
                        - 'null'
                    delivery_leadtime_maximum:
                      type:
                        - string
                        - 'null'
                    courier_company_id:
                      type:
                        - string
                        - number
                        - 'null'
            required:
              - id
              - items
              - shipping_methods
    CollectInStoreAddress:
      title: CollectInStoreAddress
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/CollectInStoreAddress
      required:
        - name
        - address_line1
        - pincode
        - city
        - state
        - country
        - country_code
      properties:
        name:
          type: string
        address_line1:
          type: string
        address_line2:
          type:
            - string
            - 'null'
        landmark:
          type:
            - string
            - 'null'
        pincode:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        country_code:
          type: string
          default: '+91'
    ShipmentItem:
      title: ShipmentItem
      description: Shipment item model
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ShipmentItem
      properties:
        product_id:
          type: string
        product_name:
          type:
            - string
            - 'null'
        product_image_url:
          type:
            - string
            - 'null'
        variant_id:
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
        sku:
          description: Present on cart shipment items; omitted from order shipment items.
          type:
            - string
            - 'null'
        quantity:
          type: integer
        free_quantity:
          type: integer
        is_free_item:
          type: boolean
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              code:
                type: string
              errors:
                type: object
              details:
                type: string
    Unauthorized:
      description: >-
        Authentication failed. Codes include `token-required`, `token-expired`
        and `token_not_valid` for an invalid or expired token.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                examples:
                  - Not authorized for given operation on the Resource.
                x-speakeasy-error-message: true
              success:
                type: boolean
                default: false
              code:
                type: string
                examples:
                  - unauthorized
              details:
                type: string
    Forbidden:
      description: >-
        Access denied. `token-required` requires an authenticated session;
        `permission-denied` means the caller cannot access this resource. On
        POS, `session-expired` requires signing in again.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
    InternalServerError:
      description: The request failed because of an unexpected error.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
    GatewayTimeout:
      description: The request timed out.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
  securitySchemes:
    Authorization:
      type: http
      description: Access token
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.