openapi: 3.2.0
info:
  title: Adobe Suite Guest Carts/{cart Id}/shipping Methods API
  version: 2.4.6
  description: 'Operations tagged guest-carts/{cartId}/shipping-methods across 2 of this provider''s published API definitions: adobe-suite-commerce-rest-customer-openapi.yaml, adobe-suite-commerce-rest-guest-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://example.com/rest/default
tags:
- name: guest-carts/{cartId}/shipping-methods
paths:
  /V1/guest-carts/{cartId}/shipping-methods:
    get:
      tags:
      - guest-carts/{cartId}/shipping-methods
      description: List applicable shipping methods for a specified quote.
      operationId: GetV1GuestcartsCartIdShippingmethods
      parameters:
      - name: cartId
        in: path
        required: true
        description: The shopping cart ID.
        schema:
          type: string
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                type: array
                description: An array of shipping methods.
                items:
                  $ref: '#/components/schemas/quote-data-shipping-method-interface'
            application/xml:
              schema:
                type: array
                description: An array of shipping methods.
                items:
                  $ref: '#/components/schemas/quote-data-shipping-method-interface'
        '400':
          description: 400 Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
      summary: guest-carts/{cartId}/shipping-methods
    servers:
    - url: https://example.com/rest/default
components:
  schemas:
    error-errors:
      type: array
      description: Errors list
      items:
        $ref: '#/components/schemas/error-errors-item'
    error-errors-item:
      type: object
      description: Error details
      properties:
        message:
          type: string
          description: Error message
        parameters:
          $ref: '#/components/schemas/error-parameters'
    quote-data-shipping-method-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
    error-parameters-item:
      type: object
      description: Error parameters item
      properties:
        resources:
          type: string
          description: ACL resource
        fieldName:
          type: string
          description: Missing or invalid field name
        fieldValue:
          type: string
          description: Incorrect field value
    error-response:
      type: object
      properties:
        message:
          type: string
          description: Error message
        errors:
          $ref: '#/components/schemas/error-errors'
        code:
          type: integer
          description: Error code
        parameters:
          $ref: '#/components/schemas/error-parameters'
        trace:
          type: string
          description: Stack trace
      required:
      - message
    quote-data-shipping-method-interface:
      type: object
      description: Interface ShippingMethodInterface
      properties:
        carrier_code:
          type: string
          description: Shipping carrier code.
        method_code:
          type: string
          description: Shipping method code.
        carrier_title:
          type: string
          description: Shipping carrier title. Otherwise, null.
        method_title:
          type: string
          description: Shipping method title. Otherwise, null.
        amount:
          type: number
          description: Shipping amount in store currency.
        base_amount:
          type: number
          description: Shipping amount in base currency.
        available:
          type: boolean
          description: The value of the availability flag for the current shipping method.
        extension_attributes:
          $ref: '#/components/schemas/quote-data-shipping-method-extension-interface'
        error_message:
          type: string
          description: Shipping Error message.
        price_excl_tax:
          type: number
          description: Shipping price excl tax.
        price_incl_tax:
          type: number
          description: Shipping price incl tax.
      required:
      - carrier_code
      - method_code
      - amount
      - base_amount
      - available
      - error_message
      - price_excl_tax
      - price_incl_tax
    error-parameters:
      type: array
      description: Error parameters list
      items:
        $ref: '#/components/schemas/error-parameters-item'
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: header
x-refined-from:
- adobe-suite-commerce-rest-customer-openapi.yaml
- adobe-suite-commerce-rest-guest-openapi.yaml
x-original-swagger-version: '2.0'