openapi: 3.2.0
info:
  title: Online Store Custom Fields 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 Fields
paths:
  /custom_fields:
    get:
      summary: Get Custom Fields
      tags:
      - Custom Fields
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  custom_fields:
                    type: array
                    items:
                      $ref: '#/components/schemas/custom_fields'
      operationId: get-custom_fields
      description: 'Gets an array of custom fields.


        For more information on custom fields, please see our knowledge base: [Custom Fields Overview](https://support.americommerce.com/hc/en-us/articles/201903820-Custom-Fields-Overview).'
    post:
      summary: Create a Custom Field
      operationId: post-custom_fields
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_fields'
      tags:
      - Custom Fields
      description: 'Creates a custom field.


        For more information on custom fields, please see our knowledge base: [Custom Fields Overview](https://support.americommerce.com/hc/en-us/articles/201903820-Custom-Fields-Overview).'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: My Custom Field
                  resource_type: Products
                  input_type: TextBox
                  value_type: String
                  field_width: 25
                  sort_order: 1
                  format_string: ''
                  is_searchable: true
                  is_editable: false
                  is_multi_select: false
                  label: Google Adwords Grouping
                  is_private: true
                  is_required: false
                  show_on_order_page: false
                  display_location: ''
                  default_value: ''
                  read_only: AdminWritable
                  show_on_one_page_checkout: false
              properties:
                name:
                  type: string
                  minLength: 1
                resource_type:
                  type: string
                input_type:
                  type: string
                value_type:
                  type: string
                field_width:
                  type: integer
                sort_order:
                  type: integer
                format_string:
                  type: string
                is_searchable:
                  type: boolean
                is_editable:
                  type: boolean
                is_multi_select:
                  type: boolean
                label:
                  type: string
                is_private:
                  type: boolean
                is_required:
                  type: boolean
                show_on_order_page:
                  type: boolean
                display_location:
                  type: string
                default_value:
                  type: string
                read_only:
                  type: string
                show_on_one_page_checkout:
                  type: boolean
                is_visible_all_stores:
                  type: boolean
              required:
              - name
              - resource_type
            examples:
              Example:
                value:
                  name: My Custom Field
                  resource_type: Products
                  input_type: TextBox
                  value_type: String
                  field_width: 25
                  sort_order: 1
                  format_string: ''
                  is_searchable: true
                  is_editable: false
                  is_multi_select: false
                  label: Google Adwords Grouping
                  is_private: true
                  is_required: false
                  show_on_order_page: false
                  display_location: ''
                  default_value: ''
                  read_only: AdminWritable
                  show_on_one_page_checkout: false
                  is_visible_all_stores: true
  /custom_fields/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `custom_field`
    put:
      summary: Update a Custom Field
      operationId: put-custom_fields-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_fields'
      tags:
      - Custom Fields
      description: "Updates a custom field. \n\nFor more information on custom fields, please see our knowledge base: [Custom Fields Overview](https://support.americommerce.com/hc/en-us/articles/201903820-Custom-Fields-Overview)."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_fields'
    delete:
      summary: Delete a Custom Field
      operationId: delete-custom_fields-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: "Deletes a custom field. \n\nFor more information on custom fields, please see our knowledge base: [Custom Fields Overview](https://support.americommerce.com/hc/en-us/articles/201903820-Custom-Fields-Overview)."
      tags:
      - Custom Fields
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_fields:
      type: object
      properties:
        id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        name:
          type: string
        resource_type:
          type: string
        input_type:
          type: string
        value_type:
          type: string
        field_width:
          type: integer
        sort_order:
          type: integer
        format_string:
          type: string
        is_searchable:
          type: boolean
        is_editable:
          type: boolean
        is_multi_select:
          type: boolean
        label:
          type: string
        is_private:
          type: boolean
        is_required:
          type: boolean
        show_on_order_page:
          type: boolean
        display_location:
          type: string
        default_value:
          type: string
        read_only:
          type: string
        show_on_one_page_checkout:
          type: boolean
        is_visible_all_stores:
          type: boolean
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header