openapi: 3.2.0
info:
  title: Online Store Custom Shipping Methods API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Custom Shipping Methods
paths:
  /custom_shipping_methods:
    get:
      summary: Get Custom Shipping Methods
      tags:
      - Custom Shipping Methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  custom_shipping_methods:
                    type: array
                    items:
                      $ref: '#/components/schemas/custom_shipping_methods'
      operationId: get-custom_shipping_methods
      description: 'Gets an array of custom shipping methods.


        For more information, please see our knowledge base: [Custom Shipping Methods](https://support.americommerce.com/hc/en-us/articles/201905690-Custom-Shipping-Methods).'
    post:
      summary: Create a Custom Shipping Method
      operationId: post-custom_shipping_methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_shipping_methods'
      tags:
      - Custom Shipping Methods
      description: 'Creates a custom shipping method.


        For more information, please see our knowledge base: [Custom Shipping Methods](https://support.americommerce.com/hc/en-us/articles/201905690-Custom-Shipping-Methods).'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Free Shipping
                  is_enabled: true
                  is_default: false
                  markup_type: ''
                  markup_amount: ''
                  description: ''
                  use_base_rate: false
                  is_calculated_method: false
                  admin_only: false
              properties:
                name:
                  type: string
                is_enabled:
                  type: boolean
                is_default:
                  type: boolean
                markup_type:
                  type: string
                markup_amount:
                  type: string
                description:
                  type: string
                use_base_rate:
                  type: boolean
                is_calculated_method:
                  type: boolean
                admin_only:
                  type: boolean
              required:
              - name
            examples:
              Example:
                value:
                  name: Free Shipping
                  is_enabled: true
                  is_default: false
                  markup_type: ''
                  markup_amount: ''
                  description: ''
                  use_base_rate: false
                  is_calculated_method: false
                  admin_only: false
        description: ''
  /custom_shipping_methods/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `custom_shipping_method`
    put:
      summary: Update a Custom Shipping Method
      operationId: put-custom_shipping_methods-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_shipping_methods'
      tags:
      - Custom Shipping Methods
      description: 'Updates a custom shipping method.


        For more information, please see our knowledge base: [Custom Shipping Methods](https://support.americommerce.com/hc/en-us/articles/201905690-Custom-Shipping-Methods).'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_shipping_methods'
    delete:
      summary: Delete a Custom Shipping Method
      operationId: delete-custom_shipping_methods-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Custom Shipping Methods
      description: 'Deletes a custom shipping method.


        For more information, please see our knowledge base: [Custom Shipping Methods](https://support.americommerce.com/hc/en-us/articles/201905690-Custom-Shipping-Methods).'
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    custom_shipping_methods:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        is_enabled:
          type: boolean
        is_default:
          type: boolean
        markup_type:
          type: string
        markup_amount:
          type: string
        description:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        use_base_rate:
          type: boolean
        is_calculated_method:
          type: boolean
        admin_only:
          type: boolean
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header