acapi.yaml

openapi: 3.1.0
tags:
  - name: Adcodes
  - name: Addresses
  - name: Attribute Groups
  - name: Attributes
  - name: Blog Categories
  - name: Blog Posts
  - name: Blogs
  - name: Cart Items
  - name: Carts
  - name: Categories
  - name: Coupon Codes
  - name: Credit Cards
  - name: Custom Field Values
  - name: Custom Fields
  - name: Custom Shipping Methods
  - name: Customer Association
  - name: Customer Payment Methods
  - name: Customer Types
  - name: Customers
  - name: Discount Actions
  - name: Discount Methods
  - name: Discount Rules
  - name: Drips
  - name: Email Templates
  - name: External Image Whitelist
  - name: Gift Certificate Transactions
  - name: Gift Certificates
  - name: Inventory
  - name: IP Blacklist
  - name: Links
  - name: Mailing Lists
  - name: Manufacturers
  - name: Marketing
  - name: Microstores
  - name: Notifications
  - name: Order Addresses
  - name: Order Items
  - name: Order Payments
  - name: Order Shipments
  - name: Order Statuses
  - name: Orders
  - name: Pages
  - name: Payment Methods
  - name: Price Calculator Rule Modifiers
  - name: Price Calculator Rules
  - name: Price Calculators
  - name: Product Inactive In Store
  - name: Product Lists
  - name: Product Pictures
  - name: Product Pricing
  - name: Product Reviews
  - name: Product Statuses
  - name: Product Variants
  - name: Products
  - name: Profiles
  - name: Quotes
  - name: Regions
  - name: Sessions
  - name: Shipping Providers
  - name: Shipping Provider Services
  - name: Shipping Rate Adjustments
  - name: Store Locations
  - name: Stores
  - name: Subscriptions
  - name: Tax Rates
  - name: Theme Import
  - name: URL Redirects
  - name: Users
  - name: Variant Groups
  - name: Variant Inventory
  - name: Warehouses
  - name: Wishlists
info:
  title: Online Store API
  version: '1.0'
  description: Online Store API
servers:
  - url: 'https://www.yoursite.com/api/v1'
    description: ''
paths:
  /adcodes:
    get:
      summary: Get All Adcodes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  adcodes:
                    type: array
                    items:
                      $ref: '#/components/schemas/adcodes'
      operationId: get-adcodes
      tags:
        - Adcodes
      description: Gets an array of adcodes
    post:
      summary: Create an Adcode
      operationId: post-adcodes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/adcodes'
        '500':
          description: Base POST failed
          content:
            application/json:
              schema:
                description: ''
                type: object
                properties:
                  status_code:
                    type: number
                  message:
                    type: string
                    minLength: 1
                  details:
                    type: string
                    minLength: 1
                required:
                  - status_code
                  - message
                  - details
                x-examples:
                  example-1:
                    status_code: 500
                    message: Internal Server Error
                    details: "AdCode Class - Base POST failed - CommandText: AdCode_Insert - Cannot insert the value NULL into column 'visits', table 'AC_AndrewTestStore.dbo.adCodes'; column does not allow nulls. INSERT fails.\r\nThe statement has been terminated."
              examples:
                Example:
                  value:
                    status_code: 500
                    message: Internal Server Error
                    details: "AdCode Class - Base POST failed - CommandText: AdCode_Insert - Cannot insert the value NULL into column 'visits', table 'AC_AndrewTestStore.dbo.adCodes'; column does not allow nulls. INSERT fails.\r\nThe statement has been terminated."
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: 5off
                  description: 5% off
                  visits: 0
                  affiliate_id: 0
                  commission: '0'
                  commission_type: ''
                  url: 'https://www.drunkenmoocow.com/Default.aspx?a=5off'
                  is_pay_per_click: false
              properties:
                name:
                  type: string
                description:
                  type: string
                visits:
                  type: integer
                commission:
                  type: string
                commission_type:
                  type: string
                url:
                  type: string
                is_pay_per_click:
                  type: boolean
                expires_at:
                  type: string
              required:
                - visits
            examples:
              Example:
                value:
                  name: 5off
                  description: 5% off
                  visits: 0
                  url: 'https://www.drunkenmoocow.com/Default.aspx?a=5off'
                  expires_at: '2024-03-05T00:00:00-06:00'
      tags:
        - Adcodes
      description: Creates an adcode
    parameters: []
  '/adcodes/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `adcode`
    delete:
      summary: Delete an Adcode
      operationId: delete-adcodes-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      parameters: []
      description: Delete an adcode by ID.
      tags:
        - Adcodes
    put:
      summary: Update an Adcode
      operationId: put-adcodes-adcode_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/adcodes'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 2
                  name: abanddonedcart
                  description: ''
                  visits: 2
                  affiliate_id: null
                  commission: ''
                  commission_type: ''
                  total_sales: null
                  total_orders: null
                  initial_sales: null
                  load_sales: null
                  new_customers: null
                  load_customers: null
                  total_commissions: null
                  conversion_rate: null
                  cost_per_customer: null
                  sales_per_ad_dollar: null
                  repeat_commission_amount: ''
                  repeat_commission_type: ''
                  pay_for_repeat_sales: ''
                  url: 'https://www.drunkenmoocow.com/Default.aspx?a=abandonedcart'
                  is_pay_per_click: false
                  source: ''
                  updated_at: '2021-10-05T19:03:41.0406559-05:00'
                  created_at: '2019-09-18T10:18:27.607-05:00'
                  expires_at: '2019-09-30T00:00:00-05:00'
                  creation_type: Manual
              properties:
                id:
                  type: integer
                  readOnly: true
                name:
                  type: string
                description:
                  type: string
                visits:
                  type: number
                affiliate_id:
                  type: integer
                commission:
                  type: string
                commission_type:
                  type: string
                total_sales:
                  type: number
                total_orders:
                  type: integer
                initial_sales:
                  type: integer
                load_sales:
                  type: integer
                new_customers:
                  type: integer
                load_customers:
                  type: integer
                total_commissions:
                  type: integer
                conversion_rate:
                  type: number
                cost_per_customer:
                  type: number
                sales_per_ad_dollar:
                  type: number
                repeat_commission_amount:
                  type: string
                repeat_commission_type:
                  type: string
                pay_for_repeat_sales:
                  type: string
                url:
                  type: string
                is_pay_per_click:
                  type: boolean
                source:
                  type: string
                updated_at:
                  type: string
                created_at:
                  type: string
                expires_at:
                  type: string
                creation_type:
                  type: string
              required:
                - id
      description: Update an adcode by ID.
      tags:
        - Adcodes
  /addresses:
    get:
      summary: Get Addresses
      tags:
        - Addresses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  addresses:
                    type: array
                    items:
                      $ref: '#/components/schemas/addresses'
      operationId: get-addresses
      description: Gets an array of addresses
    post:
      summary: Create an Address
      operationId: post-addresses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addresses'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 2
                  customer_id: 13
                  address_line_1: 323 forever
                  address_line_2: ''
                  city: lolapalooza
                  state: Texas
                  postal_code: '77701'
                  country: United States
                  is_default_shipping_address: false
                  phone: '1234567897'
                  company: ''
                  alternate_phone: ''
                  fax: ''
                  comments: ''
                  is_default_billing_address: false
                  updated_at: '2019-04-01T17:12:37.187-05:00'
                  created_at: '2019-04-01T17:12:37.107-05:00'
                  first_name: James
                  last_name: Madison
                  address_type: Default
              properties:
                customer_id:
                  type: integer
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                city:
                  type: string
                state:
                  type: string
                postal_code:
                  type: string
                country:
                  type: string
                is_default_shipping_address:
                  type: boolean
                phone:
                  type: string
                company:
                  type: string
                alternate_phone:
                  type: string
                fax:
                  type: string
                comments:
                  type: string
                is_default_billing_address:
                  type: boolean
                updated_at:
                  type: string
                created_at:
                  type: string
                first_name:
                  type: string
                last_name:
                  type: string
                address_type:
                  type: string
              required:
                - customer_id
                - country
            examples:
              Example:
                value:
                  customer_id: 13
                  address_line_1: 251 N Bristol Ave
                  address_line_2: ''
                  city: Los Angeles
                  state: California
                  postal_code: '90049'
                  country: United States
                  is_default_shipping_address: false
                  phone: '1234567897'
                  company: ''
                  alternate_phone: ''
                  fax: ''
                  comments: ''
                  is_default_billing_address: false
                  updated_at: '2019-04-01T17:12:37.187-05:00'
                  created_at: '2019-04-01T17:12:37.107-05:00'
                  first_name: Will
                  last_name: Smith
                  address_type: Default
      description: Creates an address
      tags:
        - Addresses
  '/addresses/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `address`
    put:
      summary: Update an Address
      operationId: put-addresses-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addresses'
      description: Update an address by ID.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addresses'
            examples:
              Example:
                value:
                  customer_id: 13
                  address_line_1: 251 N Bristol Ave
                  address_line_2: ''
                  city: Los Angeles
                  state: California
                  postal_code: '90049'
                  country: United States
                  is_default_shipping_address: false
                  phone: '1234567897'
                  company: ''
                  alternate_phone: ''
                  fax: ''
                  comments: ''
                  is_default_billing_address: false
                  updated_at: '2019-04-01T17:12:37.187-05:00'
                  created_at: '2019-04-01T17:12:37.107-05:00'
                  first_name: Will
                  last_name: Smith
                  address_type: Default
      tags:
        - Addresses
    delete:
      summary: Delete an Address
      operationId: delete-addresses-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Addresses
      description: Delete an address by ID.
  /attribute_groups:
    get:
      summary: Get Attribute Groups
      tags:
        - Attribute Groups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  attribute_groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/attribute_groups'
              examples:
                example-1:
                  value:
                    total_count: 0
                    '':
                      id: 0
                      name: string
                      sort_order: 0
                      is_hidden: true
                      allow_drill_down: true
                      allow_multiple: true
                      tie_variant_inventory: true
                      updated_at: string
                      created_at: string
      operationId: get-attribute_groups
      description: Gets an array of attribute groups.
    post:
      summary: Create an Attribute Group
      operationId: post-attribute_groups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attribute_groups'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Shoes
                  sort_order: 0
                  is_hidden: false
                  allow_drill_down: true
                  allow_multiple: true
                  tie_variant_inventory: false
              properties:
                name:
                  type: string
                sort_order:
                  type: number
                is_hidden:
                  type: boolean
                allow_drill_down:
                  type: boolean
                allow_multiple:
                  type: boolean
                tie_variant_inventory:
                  type: boolean
            examples:
              Example:
                value:
                  name: Tesla
                  sort_order: 0
                  is_hidden: false
                  allow_drill_down: true
                  allow_multiple: true
                  tie_variant_inventory: false
      description: Creates an attribte group.
      tags:
        - Attribute Groups
  '/attribute_groups/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `attribute_group`
    put:
      summary: Update an Attribute Group
      operationId: put-attribute_groups-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attribute_groups'
      description: Update an attribute group by ID.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 1
                  name: Shoes
                  sort_order: 0
                  is_hidden: false
                  allow_drill_down: true
                  allow_multiple: true
                  tie_variant_inventory: false
                  updated_at: null
                  created_at: null
              properties:
                id:
                  type: integer
                name:
                  type: string
                sort_order:
                  type: integer
                is_hidden:
                  type: boolean
                allow_drill_down:
                  type: boolean
                allow_multiple:
                  type: boolean
                tie_variant_inventory:
                  type: boolean
                updated_at:
                  type: string
                created_at:
                  type: string
              required:
                - id
            examples:
              Example:
                value:
                  id: 1
                  name: Tesla
                  sort_order: 0
                  is_hidden: false
                  allow_drill_down: true
                  allow_multiple: true
                  tie_variant_inventory: false
                  updated_at: ''
                  created_at: ''
      tags:
        - Attribute Groups
    delete:
      summary: Delete an Attribute Group
      operationId: delete-attribute_groups-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Delete an attribute group by ID.
      tags:
        - Attribute Groups
  /attributes:
    get:
      summary: Get Attributes
      tags:
        - Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  attribues:
                    type: array
                    items:
                      $ref: '#/components/schemas/attributes'
      operationId: get-attributes
      description: Gets an array of attribtues.
    post:
      summary: Create an Attribute
      operationId: post-attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attributes'
              examples: {}
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  attribute_group_id: 1
                  name: White
                  is_hidden: false
                  sort_order: 0
                  updated_at: null
                  created_at: null
                  page_title: ''
                  keywords: ''
                  meta_description: ''
                  url_rewrite: ''
              properties:
                attribute_group_id:
                  type: integer
                name:
                  type: string
                is_hidden:
                  type: boolean
                sort_order:
                  type: number
                page_title:
                  type: string
                keywords:
                  type: string
                meta_description:
                  type: string
                url_rewrite:
                  type: string
              required:
                - attribute_group_id
            examples:
              Example:
                value:
                  attribute_group_id: 1
                  name: small
                  is_hidden: false
                  sort_order: 0
                  page_title: ''
                  keywords: ''
                  meta_description: ''
                  url_rewrite: ''
      description: Creates an attribute.
      tags:
        - Attributes
  '/attributes/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `attribute`
    put:
      summary: Update an Attribute
      operationId: put-attributes-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attributes'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/attributes'
      description: Update an attribute by ID.
      tags:
        - Attributes
    delete:
      summary: Delete an Attribute
      operationId: delete-attributes-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Attributes
      description: Delete an attribute by ID.
  /blacklisted_ips:
    get:
      summary: Get IP Blacklist
      tags:
        - IP Blacklist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  blacklisted_ips:
                    type: array
                    items:
                      $ref: '#/components/schemas/blacklisted_ips'
      operationId: get-blacklisted_ips
      description: Gets an array of IP blacklist items.
    post:
      summary: Create an IP Blacklist Item
      operationId: post-blacklisted_ips
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blacklisted_ips'
      tags:
        - IP Blacklist
      description: Creates an IP blacklist item.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                ip_address:
                  type: string
                description:
                  type: string
            examples:
              Example:
                value:
                  ip_address: '12.34.56.78'
                  description: ''
  '/blacklisted_ips/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `blacklisted_ips`
    put:
      summary: Update an IP Blacklist Item
      operationId: put-blacklisted_ips-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blacklisted_ips'
      tags:
        - IP Blacklist
      description: Updates an IP blacklist item.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/blacklisted_ips'
    delete:
      summary: Delete an IP Blacklist Item
      operationId: delete-blacklisted_ips-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        -  IP Blacklist
      description: Deletes an IP blacklist item.
  /blog_categories:
    get:
      summary: Get Blog Categories
      tags:
        - Blog Categories
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  blog_categories:
                    type: array
                    items:
                      $ref: '#/components/schemas/blog_categories'
      operationId: get-blog_categories
      description: Gets an array of blog categories.
    post:
      summary: Create a Blog Category
      operationId: post-blog_categories
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blog_categories'
      description: Creates a blog category.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  blog_id: 1
                  parent_category_id: 0
                  type: Category
                  description: ''
                  updated_at: '2019-10-18T11:41:33.31-05:00'
                  created_at: '2019-10-18T11:41:33.31-05:00'
                  name: test
                  blog_category_path: test
              properties:
                blog_id:
                  type: integer
                parent_category_id:
                  type: integer
                type:
                  type: string
                  minLength: 1
                description:
                  type: string
                updated_at:
                  type: string
                  minLength: 1
                created_at:
                  type: string
                  minLength: 1
                name:
                  type: string
                  minLength: 1
                blog_category_path:
                  type: string
                  minLength: 1
              required:
                - blog_id
                - parent_category_id
                - blog_category_path
            examples:
              Example:
                value:
                  blog_id: 1
                  parent_category_id: 0
                  type: Category
                  description: ''
                  updated_at: '2019-10-18T11:41:33.31-05:00'
                  created_at: '2019-10-18T11:41:33.31-05:00'
                  name: test
                  blog_category_path: test
      tags:
        - Blog Categories
  '/blog_categories/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `blog_cateogry`
    put:
      summary: Update a Blog Category
      operationId: put-blog_categories-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blog_categories'
      description: Updates a blog category by ID.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/blog_categories'
            examples:
              Example:
                value:
                  id: 7
                  blog_id: 1
                  parent_category_id: 0
                  type: Tag
                  description: ''
                  updated_at: '2021-10-05T20:42:06.1923052-05:00'
                  created_at: '2021-10-05T20:42:06.1923052-05:00'
                  name: Blogging Molly
                  blog_category_path: /test
      tags:
        - Blog Categories
    delete:
      summary: Delete a Blog Category
      operationId: delete-blog_categories-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a blog category by ID.
      tags:
        - Blog Categories
  /blogs:
    get:
      summary: Get Blogs
      tags:
        - Blogs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  blogs:
                    type: array
                    items:
                      $ref: '#/components/schemas/blogs'
            application/xml:
              schema:
                type: object
                properties: {}
            multipart/form-data:
              schema:
                type: object
                properties:
                  '':
                    type: string
      operationId: get-blogs
      description: Gets an array of blogs.
    post:
      summary: Create a Blog
      operationId: post-blogs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blogs'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  store_id: 1
                  name: Our Blog
                  description: ''
                  tag_line: 'This is where ##STORENAME## talks about stuff related to our industry!'
                  url_slug: /blog2
                  meta_description: ''
                  meta_keywords: ''
                  copyright: ''
                  image_url: ''
                  language: ''
                  max_feed_elements: 25
                  syndication_type: Full
                  is_rss_feed_enabled: true
                  is_atom_feed_enabled: true
                  max_chars_short_feed: null
                  max_chars_summary: null
                  is_commenting_enabled: true
                  is_comment_moderation_enabled: true
                  default_post_image: ''
                  default_teaser_image: ''
                  new_post_notification_email_template_id: null
                  new_comment_notification_email_template_id: null
                  notify_commenters_on_new_comments: false
                  new_comment_admin_notification_email_template_id: null
                  new_post_admin_notification_email_template_id: null
                  new_comment_reply_notification_email_template_id: null
                  page_title: '##STORENAME## Blog'
              properties:
                store_id:
                  type: integer
                name:
                  type: string
                description:
                  type: string
                tag_line:
                  type: string
                meta_keywords:
                  type: string
                url_slug:
                  type: string
                  description: 'Isn''t required depending your SEO settings in Settings > Search Engine, under Blogs. With the default settings, a URL will be created using the value entered for `name`. However, it must be unique.'
                meta_description:
                  type: string
                copyright:
                  type: string
                image_url:
                  type: string
                language:
                  type: string
                max_feed_elements:
                  type: number
                syndication_type:
                  type: string
                  minLength: 1
                is_rss_feed_enabled:
                  type: boolean
                is_atom_feed_enabled:
                  type: boolean
                max_chars_short_feed:
                  type: integer
                max_chars_summary:
                  type: integer
                is_commenting_enabled:
                  type: boolean
                is_comment_moderation_enabled:
                  type: boolean
                default_post_image:
                  type: string
                default_teaser_image:
                  type: string
                new_post_notification_email_template_id:
                  type: integer
                new_comment_notification_email_template_id:
                  type: integer
                notify_commenters_on_new_comments:
                  type: boolean
                new_comment_admin_notification_email_template_id:
                  type: integer
                new_post_admin_notification_email_template_id:
                  type: integer
                new_comment_reply_notification_email_template_id:
                  type: integer
                page_title:
                  type: string
                  maxLength: 255
              required:
                - store_id
                - name
            examples:
              Example:
                value:
                  store_id: 1
                  name: Our Blog
                  description: ''
                  tag_line: 'This is where ##STORENAME## talks about stuff related to our industry!'
                  url_slug: /blog
                  meta_description: ''
                  meta_keywords: ''
                  copyright: ''
                  image_url: ''
                  language: ''
                  max_feed_elements: 25
                  syndication_type: Full
                  is_rss_feed_enabled: true
                  is_atom_feed_enabled: true
                  max_chars_short_feed: null
                  max_chars_summary: null
                  is_commenting_enabled: true
                  is_comment_moderation_enabled: true
                  default_post_image: ''
                  default_teaser_image: ''
                  new_post_notification_email_template_id: 4
                  new_comment_notification_email_template_id: 5
                  notify_commenters_on_new_comments: false
                  new_comment_admin_notification_email_template_id: 6
                  new_post_admin_notification_email_template_id: 7
                  new_comment_reply_notification_email_template_id: 8
                  page_title: '##STORENAME## Blog'
        description: ''
      description: 'Creates a Blog. '
      tags:
        - Blogs
  '/blogs/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `blog`
    put:
      summary: Update a Blog
      operationId: put-blogs-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blogs'
      description: Updates a blog.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 1
                  store_id: 1
                  name: Our Blog
                  description: ''
                  tag_line: 'This is where ##STORENAME## talks about stuff related to our industry!'
                  url_slug: /blog
                  meta_description: ''
                  meta_keywords: ''
                  copyright: ''
                  image_url: ''
                  language: ''
                  max_feed_elements: 25
                  syndication_type: Full
                  is_rss_feed_enabled: true
                  is_atom_feed_enabled: true
                  max_chars_short_feed: null
                  max_chars_summary: null
                  is_commenting_enabled: true
                  is_comment_moderation_enabled: true
                  default_post_image: ''
                  default_teaser_image: ''
                  new_post_notification_email_template_id: 4
                  new_comment_notification_email_template_id: 5
                  notify_commenters_on_new_comments: false
                  new_comment_admin_notification_email_template_id: 6
                  new_post_admin_notification_email_template_id: 7
                  new_comment_reply_notification_email_template_id: 8
                  page_title: '##STORENAME## Blog'
              properties:
                id:
                  type: integer
                store_id:
                  type: number
                name:
                  type: string
                description:
                  type: string
                tag_line:
                  type: string
                url_slug:
                  type: string
                meta_description:
                  type: string
                meta_keywords:
                  type: string
                copyright:
                  type: string
                image_url:
                  type: string
                language:
                  type: string
                max_feed_elements:
                  type: number
                syndication_type:
                  type: string
                is_rss_feed_enabled:
                  type: boolean
                is_atom_feed_enabled:
                  type: boolean
                max_chars_short_feed:
                  type: integer
                max_chars_summary:
                  type: integer
                is_commenting_enabled:
                  type: boolean
                is_comment_moderation_enabled:
                  type: boolean
                default_post_image:
                  type: string
                default_teaser_image:
                  type: string
                new_post_notification_email_template_id:
                  type: integer
                new_comment_notification_email_template_id:
                  type: integer
                notify_commenters_on_new_comments:
                  type: boolean
                new_comment_admin_notification_email_template_id:
                  type: integer
                new_post_admin_notification_email_template_id:
                  type: integer
                new_comment_reply_notification_email_template_id:
                  type: integer
                page_title:
                  type: string
                  maxLength: 255
              required:
                - id
            examples:
              Example:
                value:
                  id: 1
                  store_id: 1
                  name: Our Blog
                  description: ''
                  tag_line: 'This is where ##STORENAME## talks about stuff related to our industry!'
                  url_slug: /blog
                  meta_description: ''
                  meta_keywords: ''
                  copyright: ''
                  image_url: ''
                  language: ''
                  max_feed_elements: 25
                  syndication_type: Full
                  is_rss_feed_enabled: true
                  is_atom_feed_enabled: true
                  max_chars_short_feed: 25
                  max_chars_summary: 25
                  is_commenting_enabled: true
                  is_comment_moderation_enabled: true
                  default_post_image: ''
                  default_teaser_image: ''
                  new_post_notification_email_template_id: 4
                  new_comment_notification_email_template_id: 5
                  notify_commenters_on_new_comments: false
                  new_comment_admin_notification_email_template_id: 6
                  new_post_admin_notification_email_template_id: 7
                  new_comment_reply_notification_email_template_id: 8
                  page_title: '##STORENAME## Blog'
      tags:
        - Blogs
    delete:
      summary: Delete a Blog
      operationId: delete-blogs-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: 'Deletes a blog. '
      tags:
        - Blogs
  /blog_posts:
    get:
      summary: Get Blog Posts
      tags:
        - Blog Posts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  blog_posts:
                    type: array
                    items:
                      $ref: '#/components/schemas/blog_posts'
      operationId: get-blog_posts
      description: Gets an array of blog posts.
    post:
      summary: Create a Blog Post
      operationId: post-blog_posts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blog_posts'
      description: 'Creates a blog posts. '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 15
                  blog_id: 1
                  title: Hello There
                  keywords: ''
                  description: ''
                  content: My Content
                  published_at: '2019-11-06T11:27:00-06:00'
                  updated_at: '2019-11-06T11:27:46.87-06:00'
                  created_at: '2019-11-06T11:27:46.87-06:00'
                  teaser_title: ''
                  teaser_description: ''
                  post_image_url: ''
                  teaser_image_url: ''
                  author_profile_id: 2
                  are_comments_enabled: true
                  is_featured: false
                  is_stickied: false
                  are_comments_locked: false
                  view_count: 140
                  store_id: 1
                  head_tags: ''
                  url_rewrite: /blog/Hello-There
                  page_content_type: BlogPost
              properties:
                blog_id:
                  type: integer
                title:
                  type: string
                keywords:
                  type: string
                description:
                  type: string
                content:
                  type: string
                published_at:
                  type: string
                teaser_title:
                  type: string
                teaser_description:
                  type: string
                post_image_url:
                  type: string
                teaser_image_url:
                  type: string
                author_profile_id:
                  type: integer
                are_comments_enabled:
                  type: boolean
                is_featured:
                  type: boolean
                is_stickied:
                  type: boolean
                are_comments_locked:
                  type: boolean
                view_count:
                  type: integer
                store_id:
                  type: integer
                head_tags:
                  type: string
                url_rewrite:
                  type: string
                page_title:
                  type: string
                page_content_type:
                  type: string
              required:
                - blog_id
                - store_id
            examples:
              Example:
                value:
                  blog_id: 1
                  title: Hello There
                  keywords: ''
                  description: ''
                  content: ''
                  published_at: '2023-05-17T12:08:00-05:00'
                  teaser_title: ''
                  teaser_description: ''
                  post_image_url: ''
                  teaser_image_url: ''
                  author_profile_id: 0
                  are_comments_enabled: false
                  is_featured: false
                  is_stickied: false
                  are_comments_locked: false
                  view_count: 0
                  store_id: 4
                  head_tags: ''
                  url_rewrite: /blog/Hello-There
                  page_title: ''
                  page_content_type: BlogPost
      tags:
        - Blog Posts
  '/blog_posts/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `blog_post`
    put:
      summary: Update a Blog Post
      operationId: put-blog_post-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blog_posts'
      description: 'Updates a Blog Post. '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 43
                  blog_id: 1
                  title: Hello There
                  keywords: ''
                  description: ''
                  content: ''
                  published_at: null
                  updated_at: '2021-10-06T12:27:36.8249258-05:00'
                  created_at: '2021-10-06T12:27:36.8249258-05:00'
                  teaser_title: ''
                  teaser_description: ''
                  post_image_url: ''
                  teaser_image_url: ''
                  author_profile_id: 0
                  are_comments_enabled: false
                  is_featured: false
                  is_stickied: false
                  are_comments_locked: false
                  view_count: 0
                  store_id: 4
                  head_tags: ''
                  url_rewrite: /blog/Hello-There3
                  page_content_type: BlogPost
              properties:
                id:
                  type: integer
                  readOnly: true
                blog_id:
                  type: integer
                title:
                  type: string
                keywords:
                  type: string
                description:
                  type: string
                content:
                  type: string
                published_at:
                  type: string
                updated_at:
                  type: string
                created_at:
                  type: string
                teaser_title:
                  type: string
                teaser_description:
                  type: string
                post_image_url:
                  type: string
                teaser_image_url:
                  type: string
                author_profile_id:
                  type: integer
                are_comments_enabled:
                  type: boolean
                is_featured:
                  type: boolean
                is_stickied:
                  type: boolean
                are_comments_locked:
                  type: boolean
                view_count:
                  type: integer
                store_id:
                  type: integer
                head_tags:
                  type: string
                url_rewrite:
                  type: string
                page_title:
                  type: string
                page_content_type:
                  type: string
            examples:
              Example:
                value:
                  id: 43
                  blog_id: 1
                  title: Hello There
                  keywords: ''
                  description: ''
                  content: ''
                  published_at: null
                  updated_at: '2021-10-06T12:27:36.8249258-05:00'
                  created_at: '2021-10-06T12:27:36.8249258-05:00'
                  teaser_title: ''
                  teaser_description: ''
                  post_image_url: ''
                  teaser_image_url: ''
                  author_profile_id: 0
                  are_comments_enabled: false
                  is_featured: false
                  is_stickied: false
                  are_comments_locked: false
                  view_count: 0
                  store_id: 4
                  head_tags: ''
                  url_rewrite: /blog/Hello-There
                  page_title: ''
                  page_content_type: BlogPost
          application/xml:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 43
                  blog_id: 1
                  title: Hello There
                  keywords: ''
                  description: ''
                  content: ''
                  published_at: null
                  updated_at: '2021-10-06T12:27:36.8249258-05:00'
                  created_at: '2021-10-06T12:27:36.8249258-05:00'
                  teaser_title: ''
                  teaser_description: ''
                  post_image_url: ''
                  teaser_image_url: ''
                  author_profile_id: 0
                  are_comments_enabled: false
                  is_featured: false
                  is_stickied: false
                  are_comments_locked: false
                  view_count: 0
                  store_id: 4
                  head_tags: ''
                  url_rewrite: /blog/Hello-There3
                  page_content_type: BlogPost
              properties:
                id:
                  type: integer
                  readOnly: true
                blog_id:
                  type: integer
                title:
                  type: string
                keywords:
                  type: string
                description:
                  type: string
                content:
                  type: string
                published_at: {}
                updated_at:
                  type: string
                created_at:
                  type: string
                teaser_title:
                  type: string
                teaser_description:
                  type: string
                post_image_url:
                  type: string
                teaser_image_url:
                  type: string
                author_profile_id:
                  type: integer
                are_comments_enabled:
                  type: boolean
                is_featured:
                  type: boolean
                is_stickied:
                  type: boolean
                are_comments_locked:
                  type: boolean
                view_count:
                  type: integer
                store_id:
                  type: integer
                head_tags:
                  type: string
                url_rewrite:
                  type: string
                page_content_type:
                  type: string
              required:
                - id
        description: ''
      tags:
        - Blog Posts
    delete:
      summary: Delete a Blog Post
      operationId: delete-blog_post-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a blog post.
      tags:
        - Blog Posts
  /cart_items:
    get:
      summary: Get Cart Items
      tags:
        - Cart Items
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type:
                      - string
                      - integer
                  cart_items:
                    type:
                      - array
                    items:
                      $ref: '#/components/schemas/cart_items'
            application/xml:
              schema:
                type: object
                properties:
                  total_count:
                    type:
                      - string
                      - integer
                  '':
                    $ref: '#/components/schemas/cart_items'
      operationId: get-cart_items
      description: Gets an array of cart items.
    post:
      summary: Create a Cart Item
      operationId: post-cart_items
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cart_items'
      description: 'Adds an Item to specified cart. '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 6110
                  product_id: 8
                  item_number: 3367799-2
                  quantity: 1
                  price: 330
                  cost: 125
                  shipping_address_id: 0
                  item_thumbnail: /Shared/images/sample/products/Shirts/3367799.jpg
                  item_url: ''
                  item_name: Clayton Solid Cotton French
                  warehouse_id: 0
                  parent_product_id: null
                  parent_cart_item_id: null
                  updated_at: '2021-10-05T12:09:13.62-05:00'
                  created_at: '2021-10-05T12:08:41.37-05:00'
                  cart_id: 3946
                  is_subscription_product: false
                  vendor_store_id: null
                  variants:
                    - id: 5
                      description: 'COLOR: White'
                      variant_group_id: 4
                    - id: 7
                      description: 'SIZE: Large'
                      variant_group_id: 1
                  personalizations:
                    - id: 27
                      answer: Hello There
              properties:
                product_id:
                  type: integer
                item_number:
                  type: string
                quantity:
                  type: integer
                price:
                  type: number
                cost:
                  type: number
                shipping_address_id:
                  type: integer
                item_thumbnail:
                  type: string
                item_url:
                  type: string
                item_name:
                  type: string
                warehouse_id:
                  type: integer
                parent_product_id:
                  type: integer
                parent_cart_item_id:
                  type: integer
                cart_id:
                  type: integer
                is_subscription_product:
                  type: boolean
                configuration:
                  type: string
                subscription_paused:
                  type: boolean
                variants:
                  type: array
                  uniqueItems: false
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                      description:
                        type: string
                      variant_group_id:
                        type: integer
                personalizations:
                  type: array
                  uniqueItems: false
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                      answer:
                        type: string
              required:
                - product_id
                - cart_id
            examples:
              Example:
                value:
                  id: 6110
                  product_id: 8
                  item_number: 3367799-2
                  quantity: 1
                  price: 330
                  cost: 125
                  shipping_address_id: 0
                  item_thumbnail: /Shared/images/shirt.jpg
                  item_url: ''
                  item_name: T Shirt
                  warehouse_id: 0
                  parent_product_id: null
                  parent_cart_item_id: null
                  updated_at: '2021-10-05T12:09:13.62-05:00'
                  created_at: '2021-10-05T12:08:41.37-05:00'
                  cart_id: 3946
                  is_subscription_product: false
                  configuration: ''
                  subscription_paused: false
                  variants:
                    - id: 5
                      description: 'COLOR: White'
                      variant_group_id: 4
                    - id: 7
                      description: 'SIZE: Large'
                      variant_group_id: 1
                  personalizations:
                    - id: 27
                      answer: Hello There
      tags:
        - Cart Items
  '/cart_items/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `cart_item`
    put:
      summary: Update a Cart Item
      operationId: put-cart_items-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cart_items'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cart_items'
            examples:
              Example:
                value:
                  id: 6110
                  product_id: 8
                  item_number: 3367799-2
                  quantity: 1
                  price: 330
                  cost: 125
                  shipping_address_id: 0
                  item_thumbnail: /Shared/images/sample/products/Shirts/3367799.jpg
                  item_url: ''
                  item_name: Clayton Solid Cotton French
                  warehouse_id: 0
                  parent_product_id: 4
                  parent_cart_item_id: 45
                  updated_at: '2021-10-05T12:09:13.62-05:00'
                  created_at: '2021-10-05T12:08:41.37-05:00'
                  cart_id: 3946
                  is_subscription_product: false
                  configuration: ''
                  subscription_paused: false
                  variants:
                    - id: 5
                      description: 'COLOR: White'
                      variant_group_id: 4
                    - id: 7
                      description: 'SIZE: Large'
                      variant_group_id: 1
                  personalizations:
                    - id: 27
                      answer: Hello There
      description: 'Updates a cart item. '
      tags:
        - Cart Items
    delete:
      summary: Delete a Cart Item
      operationId: delete-cart_items-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a cart item.
      tags:
        - Cart Items
  /carts:
    get:
      summary: Get Carts
      tags:
        - Carts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  carts:
                    type: array
                    items:
                      $ref: '#/components/schemas/carts'
      operationId: get-carts
      description: Gets an array of carts.
  /categories:
    get:
      summary: Get Categories
      tags:
        - Categories
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  categories:
                    type: array
                    items:
                      $ref: '#/components/schemas/categories'
      operationId: get-categories
      description: Gets an array of categories.
    post:
      summary: Create a Category
      operationId: post-categories
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/categories'
      tags:
        - Categories
      description: Creates a category.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Shoes
                  short_description: ''
                  sort_order: 0
                  is_hidden: false
                  parent_category_id: 14
                  max_quantity: 0
                  category_thumbnail: ''
                  page_title: ''
                  lookup_path: ''
                  keywords: ''
                  meta_description: ''
                  category_image: ''
                  external_content_url: ''
                  is_category_content_displayed: true
                  are_subcategory_products_displayed: false
                  url_rewrite: ''
                  default_product_picture: ''
                  alternate_thumbnail: ''
                  head_tags: ''
                  cat_image_alt_text: ''
                  thumb_image_alt_text: ''
                  is_hide_from_site_maps: false
              properties:
                name:
                  type: string
                  minLength: 1
                short_description:
                  type: string
                sort_order:
                  type: integer
                is_hidden:
                  type: boolean
                parent_category_id:
                  type: integer
                max_quantity:
                  type: integer
                category_thumbnail:
                  type: string
                page_title:
                  type: string
                lookup_path:
                  type: string
                keywords:
                  type: string
                meta_description:
                  type: string
                category_image:
                  type: string
                external_content_url:
                  type: string
                is_category_content_displayed:
                  type: boolean
                are_subcategory_products_displayed:
                  type: boolean
                url_rewrite:
                  type: string
                default_product_picture:
                  type: string
                alternate_thumbnail:
                  type: string
                head_tags:
                  type: string
                cat_image_alt_text:
                  type: string
                thumb_image_alt_text:
                  type: string
                is_hide_from_site_maps:
                  type: boolean
              required:
                - name
              examples:
                Example:
                  value:
                    name: Shoes
                    short_description: ''
                    sort_order: 0
                    is_hidden: false
                    parent_category_id: 14
                    max_quantity: 0
                    category_thumbnail: ''
                    page_title: ''
                    lookup_path: ''
                    keywords: ''
                    meta_description: ''
                    category_image: ''
                    external_content_url: ''
                    is_category_content_displayed: true
                    are_subcategory_products_displayed: false
                    url_rewrite: ''
                    default_product_picture: ''
                    alternate_thumbnail: ''
                    head_tags: ''
                    cat_image_alt_text: ''
                    thumb_image_alt_text: ''
                    is_hide_from_site_maps: false
  '/categories/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `category`
    put:
      summary: Update a Category
      operationId: put-categories-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/categories'
      description: Updates a category.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/categories'
      tags:
        - Categories
    delete:
      summary: Delete a Category
      operationId: delete-categories-id
      tags:
        - Categories
      description: Deletes a category.
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
  /coupon_codes:
    get:
      summary: Get Coupon Codes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  coupon_codes:
                    type: array
                    items:
                      $ref: '#/components/schemas/coupon_codes'
      operationId: get-coupon_codes
      tags:
        - Coupon Codes
      description: Gets an array of coupon codes.
    post:
      summary: Create a Coupon Code
      operationId: post-coupon_codes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/coupon_codes'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  campaign_code: '123'
                  coupon_code: CC-3SCEUZGYA3
                  is_active: false
                  is_expired: false
                  expires_at: null
                  max_uses: 0
                  usage_count: 0
                  notes: ''
                  is_hidden: false
              properties:
                campaign_code:
                  type: string
                coupon_code:
                  type: string
                is_active:
                  type: boolean
                is_expired:
                  type: boolean
                expires_at: {}
                max_uses:
                  type: number
                usage_count:
                  type: number
                notes:
                  type: string
                is_hidden:
                  type: boolean
              required:
                - campaign_code
                - coupon_code
            examples:
              Example:
                value:
                  campaign_code: '123'
                  coupon_code: CC-3SCEUZGYA3
                  is_active: false
                  is_expired: false
                  expires_at: null
                  max_uses: 0
                  usage_count: 0
                  notes: ''
                  is_hidden: false
      tags:
        - Coupon Codes
      description: Creats a coupon code.
  '/coupon_codes/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `coupon_code` you wish to update.
    put:
      summary: Update a Coupon Code
      operationId: put-coupon_codes-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/coupon_codes'
        '404':
          $ref: '#/components/responses/404'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 1023
                  campaign_code: '123'
                  coupon_code: CC-3SCEUZGYA3
                  is_active: false
                  is_expired: false
                  expires_at: null
                  max_uses: 0
                  usage_count: 0
                  notes: ''
                  is_hidden: false
              properties:
                id:
                  type: integer
                campaign_code:
                  type: string
                coupon_code:
                  type: string
                is_active:
                  type: boolean
                is_expired:
                  type: boolean
                expires_at:
                  type: string
                max_uses:
                  type: number
                usage_count:
                  type: number
                notes:
                  type: string
                is_hidden:
                  type: boolean
            examples:
              Example:
                value:
                  id: 1023
                  campaign_code: '123'
                  coupon_code: CC-3SCEUZGYA3
                  is_active: false
                  is_expired: false
                  expires_at: null
                  max_uses: 0
                  usage_count: 0
                  notes: ''
                  is_hidden: false
      tags:
        - Coupon Codes
      description: Update a coupon code by ID.
    delete:
      summary: Delete a Coupon Code
      operationId: delete-coupon_codes-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: 'Delete a coupon code by ID. '
      tags:
        - Coupon Codes
  /credit_cards:
    get:
      summary: Credit Cards
      tags:
        - Credit Cards
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  credit_cards:
                    type: array
                    items:
                      $ref: '#/components/schemas/credit_cards'
      operationId: get-credit_cards
      description: Gets an array of credit cards.
    post:
      summary: Add a Credit Cart
      operationId: post-credit_cards
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/credit_cards'
      description: Adds a credit card.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  customer_id: 18
                  card_type: Visa
                  expiration_month: 1
                  expiration_year: 2022
                  cardholder_name: First Last
                  phone: ''
                  address_line_1: 123 Test st.
                  address_line_2: ''
                  city: Lumberton
                  state: Texas
                  postal_code: '77657'
                  country: United States
                  is_default: false
                  last_four: '1111'
              properties:
                customer_id:
                  type: integer
                card_type:
                  type: string
                expiration_month:
                  type: integer
                expiration_year:
                  type: integer
                cardholder_name:
                  type: string
                phone:
                  type: string
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                city:
                  type: string
                state:
                  type: string
                postal_code:
                  type: string
                country:
                  type: string
                is_default:
                  type: boolean
                last_four:
                  type: string
              required:
                - customer_id
                - card_type
            examples:
              Example:
                value:
                  customer_id: 18
                  card_type: Visa
                  expiration_month: 1
                  expiration_year: 2022
                  cardholder_name: First Last
                  phone: ''
                  address_line_1: 123 Test st.
                  address_line_2: ''
                  city: Lumberton
                  state: Texas
                  postal_code: '77657'
                  country: United States
                  is_default: false
                  last_four: '1111'
          application/xml:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  customer_id: 18
                  card_type: Visa
                  expiration_month: 1
                  expiration_year: 2022
                  cardholder_name: First Last
                  phone: ''
                  address_line_1: 123 Test st.
                  address_line_2: ''
                  city: Lumberton
                  state: Texas
                  postal_code: '77701'
                  country: United States
                  is_default: false
                  last_four: '1111'
              properties:
                customer_id:
                  type: integer
                card_type:
                  type: string
                expiration_month:
                  type: number
                expiration_year:
                  type: number
                cardholder_name:
                  type: string
                  minLength: 1
                phone:
                  type: string
                address_line_1:
                  type: string
                  minLength: 1
                address_line_2:
                  type: string
                city:
                  type: string
                  minLength: 1
                state:
                  type: string
                  minLength: 1
                postal_code:
                  type: string
                  minLength: 1
                country:
                  type: string
                  minLength: 1
                is_default:
                  type: boolean
                last_four:
                  type: string
                  minLength: 1
              required:
                - customer_id
                - card_type
                - expiration_year
                - cardholder_name
                - phone
                - address_line_1
                - address_line_2
                - city
                - state
                - postal_code
                - country
                - is_default
                - last_four
            examples: {}
        description: ''
      tags:
        - Credit Cards
  '/credit_cards/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `credit_card`
    put:
      summary: Update a Credit Card
      operationId: put-credit_cards-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/credit_cards'
      description: Updates a Credit Card.
      tags:
        - Credit Cards
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/credit_cards'
            examples:
              Example:
                value:
                  id: 42
                  customer_id: 18
                  card_type: Visa
                  expiration_month: 1
                  expiration_year: 2022
                  cardholder_name: First Last
                  phone: ''
                  address_line_1: 123 Test st.
                  address_line_2: ''
                  city: Lumberton
                  state: Texas
                  postal_code: '77701'
                  country: United States
                  is_default: false
                  updated_at: '2021-10-06T15:07:15.8334217-05:00'
                  created_at: '2021-10-06T15:07:15.8334217-05:00'
                  last_four: '1111'
    delete:
      summary: Delete a Credit Card
      operationId: delete-credit_cards-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Credit Cards
      description: Deletes a credit card.
  /custom_field_values:
    get:
      summary: Get Custom Field Values
      tags:
        - Custom Field Values
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  custom_field_values:
                    type: array
                    items:
                      $ref: '#/components/schemas/custom_field_values'
      operationId: get-custom_field_values
      description: Gets an array of custom field values.
    post:
      summary: Create a Custom Field Value
      operationId: post-custom_field_values
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_field_values'
      description: Creates a custom field value.
      tags:
        - Custom Field Values
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 133
                  custom_field_id: 46
                  resource_id: 74
                  value: IONIZED PARTICLES
              properties:
                custom_field_id:
                  type: integer
                resource_id:
                  type: integer
                value:
                  type: string
                  minLength: 1
              required:
                - custom_field_id
                - resource_id
                - value
            examples:
              Example:
                value:
                  custom_field_id: 46
                  resource_id: 88
                  value: value
  '/custom_field_values/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `custom_field`
    put:
      summary: Update a Custom Field Value
      operationId: put-custom_field_value-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_field_values'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  resource_id: 74
                  value: IONIZED PARTICLES
              properties:
                resource_id:
                  type: integer
                value:
                  type: string
              required:
                - resource_id
                - value
            examples:
              Example:
                value:
                  resource_id: 74
                  value: value
      description: Updates a custom field value.
      tags:
        - Custom Field Values
    delete:
      summary: Delete a Custom Field Value
      operationId: delete-custom_field_value-id
      description: Deletes an custom field value.
      tags:
        - Custom Field Values
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
  /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. 

        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:
              $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. 

        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).
      tags:
        - Custom Fields
  /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).
  /customer_association:
    get:
      summary: Get Customer Associations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  customer_association:
                    type: array
                    items:
                      $ref: '#/components/schemas/customer_association'
      operationId: get-customer_association
      description: Gets an array of customer associations.
      tags:
        - Customer Association
    post:
      summary: Create a Customer Association
      operationId: post-customer_association
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_association'
      tags:
        - Customer Association
      description: Creates a customer association.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  association_type_id: 2
                  parent_customer_id: 1
                  child_customer_id: 13
              properties:
                association_type_id:
                  type: integer
                  minLength: 1
                parent_customer_id:
                  type: integer
                child_customer_id:
                  type: integer
              required:
                - association_type_id
                - parent_customer_id
                - child_customer_id
            examples:
              Example:
                value:
                  association_type_id: 2
                  parent_customer_id: 1
                  child_customer_id: 13
  '/customer_association/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
    put:
      summary: Update a Customer Association
      operationId: put-customer_association-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_association'
      tags:
        - Customer Association
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customer_association'
      description: Updates a customer association.
    delete:
      summary: Delete a Customer Association
      operationId: delete-customer_association-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Customer Association
      description: Deletes a customer association.
  /customer_payment_methods:
    get:
      summary: Customer Payment Methods
      tags:
        - Customer Payment Methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  customer_payment_methods:
                    type: array
                    items:
                      $ref: '#/components/schemas/customer_payment_methods'
      operationId: get-customer_payment_methods
      description: Gets an array of customer payment methods.
    post:
      summary: Create a Customer Payment Method
      operationId: post-customer_payment_methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_payment_methods'
      tags:
        - Customer Payment Methods
      description: Create a customer payment method.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  payment_method_id: 111
                  customer_id: 18
                  payment_type: CreditCard
                  is_default: false
                  card_id: 6
                  address_id: 4
              properties:
                payment_method_id:
                  type: integer
                customer_id:
                  type: integer
                payment_type:
                  type: string
                is_default:
                  type: boolean
                card_id:
                  type: integer
                address_id:
                  type: integer
            examples:
              Example:
                value:
                  payment_method_id: 111
                  customer_id: 18
                  payment_type: CreditCard
                  is_default: false
                  card_id: 6
                  address_id: 4
  '/customer_payment_methods/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `customer_payment_method`
    put:
      summary: Update a Customer Payment Method
      operationId: put-customer_payment_methods-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_payment_methods'
      description: Updates a customer payment method.
      tags:
        - Customer Payment Methods
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customer_payment_methods'
    delete:
      summary: Delete a Customer Payment Method
      operationId: delete-customer_payment_methods-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Customer Payment Methods
      description: Deletes a customer payment method.
  /customer_types:
    get:
      summary: Get Customer Types
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  customer_types:
                    type: array
                    items:
                      $ref: '#/components/schemas/customer_types'
      operationId: get-customer_types
      description: Gets an array of customer types.
      tags:
        - Customer Types
    post:
      summary: Create a Customer Type
      operationId: post-customer_types
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_types'
      tags:
        - Customer Types
      description: Creates a customer type.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 1
                  name: Wholesale
                  customer_level: 1
                  description: ''
              properties:
                name:
                  type: string
                  minLength: 1
                customer_level:
                  type: number
                description:
                  type: string
              required:
                - name
            examples:
              Example:
                value:
                  name: wholesale
                  customer_level: 1
                  description: ''
  '/customer_types/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
    put:
      summary: Update a Customer Type
      operationId: put-customer_types-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_types'
      tags:
        - Customer Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customer_types'
      description: Updates a customer type.
    delete:
      summary: Delete a Customer Type
      operationId: delete-customer_types-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Customer Types
      description: Deletes a customer type.
  /customers:
    get:
      summary: Get Customers
      tags:
        - Customers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  customers:
                    type: array
                    items:
                      $ref: '#/components/schemas/customers'
      operationId: get-customers
      description: Gets an array of customers.
    post:
      summary: Create a Customer
      operationId: post-customers
      responses:
        '200':
          description: OK
      tags:
        - Customers
      description: Creates a customer.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  customer_number: ''
                  last_name: Aurelius
                  first_name: Marcus
                  email: maurelius@test.com
                  phone_number: 555-123-4596
                  adcode: ''
                  adcode_id: 0
                  affiliate_id: null
                  customer_type_id: 4
                  is_no_tax_customer: true
                  comments: ''
                  store_id: 19
                  source: ''
                  search_string: ''
                  no_account: false
                  sales_person: ''
                  alternate_phone_number: 455-258-8585
                  is_affiliate_customer: false
                  username: ''
                  is_contact_information_only: false
                  tax_exemption_number: ''
                  company: Romanatech
                  source_group: ''
                  sales_person_user_id: null
                  store_payment_methods_enabled: []
                  tax_rate: null
                  reward_tier_id: null
                  sub: ''
                  customer_payment_methods_availability: []
              properties:
                customer_number:
                  type: string
                last_name:
                  type: string
                first_name:
                  type: string
                email:
                  type: string
                phone_number:
                  type: string
                adcode:
                  type: string
                adcode_id:
                  type: number
                affiliate_id:
                  type: integer
                customer_type_id:
                  type: integer
                is_no_tax_customer:
                  type: boolean
                comments:
                  type: string
                store_id:
                  type: number
                source:
                  type: string
                search_string:
                  type: string
                no_account:
                  type: boolean
                sales_person:
                  type: string
                alternate_phone_number:
                  type: string
                is_affiliate_customer:
                  type: boolean
                username:
                  type: string
                is_contact_information_only:
                  type: boolean
                tax_exemption_number:
                  type: string
                company:
                  type: string
                source_group:
                  type: string
                sales_person_user_id:
                  type: integer
                store_payment_methods_enabled:
                  type: array
                  items:
                    type: object
                tax_rate:
                  type: number
                lock_default_address:
                  type: boolean
                reward_tier_id:
                  type: integer
                payment_net_term:
                  type: integer
                credit_limit:
                  type: number
                is_inactive:
                  type: boolean
                use_shared_credit_limit:
                  type: boolean
                override_shared_credit_limit:
                  type: boolean
                customer_payment_methods_availability:
                  type: array
                  items:
                    type: object
                default_payment_type_name:
                  type: string
              required:
                - email
                - store_id
            examples:
              Example:
                value:
                  customer_number: ''
                  last_name: Aurelius
                  first_name: Marcus
                  email: maurelius@test.com
                  phone_number: 555-123-4596
                  adcode: ''
                  adcode_id: 0
                  affiliate_id: 1
                  customer_type_id: 4
                  is_no_tax_customer: true
                  comments: ''
                  store_id: 19
                  source: ''
                  search_string: ''
                  no_account: false
                  sales_person: ''
                  alternate_phone_number: 455-258-8585
                  is_affiliate_customer: false
                  username: ''
                  is_contact_information_only: false
                  tax_exemption_number: ''
                  company: Romanatech
                  source_group: ''
                  sales_person_user_id: 2
                  store_payment_methods_enabled: []
                  tax_rate: 2
                  lock_default_address: false
                  reward_tier_id: 1
                  payment_net_term: 0
                  credit_limit: 10.00
                  is_inactive: false
                  use_shared_credit_limit: false
                  override_shared_credit_limit: false
                  customer_payment_methods_availability: []
                  default_payment_type_name: Credit Card
  '/customers/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `customer`
    put:
      summary: Update a Customer
      operationId: put-customers-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customers'
      tags:
        - Customers
      description: Updates a customer.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_number:
                  type: string
                last_name:
                  type: string
                first_name:
                  type: string
                email:
                  type: string
                phone_number:
                  type: string
                registered_at:
                  type: string
                last_visit_at:
                  type: 'null'
                adcode:
                  type: string
                adcode_id:
                  type: integer
                affiliate_id:
                  type: 'null'
                customer_type_id:
                  type: integer
                is_no_tax_customer:
                  type: boolean
                comments:
                  type: string
                store_id:
                  type: integer
                source:
                  type: string
                search_string:
                  type: string
                no_account:
                  type: boolean
                sales_person:
                  type: string
                alternate_phone_number:
                  type: string
                is_affiliate_customer:
                  type: boolean
                username:
                  type: string
                is_contact_information_only:
                  type: boolean
                tax_exemption_number:
                  type: string
                company:
                  type: string
                source_group:
                  type: string
                sales_person_user_id:
                  type: integer
                tax_rate:
                  type: number
                lock_default_address:
                  type: boolean
                reward_tier_id:
                  type: integer
                payment_net_term:
                  type: integer
                credit_limit:
                  type: number
                is_inactive:
                  type: boolean
                use_shared_credit_limit:
                  type: boolean
                override_shared_credit_limit:
                  type: boolean
                customer_payment_methods_availability:
                  type: array
                  items:
                    type: object
                default_payment_type_name:
                  type: string
              x-examples:
                Example 1:
                  customer_number: ''
                  last_name: Johnson
                  first_name: John
                  email: johnjohnson@mail.com
                  phone_number: '654654454'
                  registered_at: '2019-04-01T15:16:00-05:00'
                  last_visit_at: null
                  adcode: ''
                  adcode_id: 0
                  affiliate_id: null
                  customer_type_id: 1
                  is_no_tax_customer: false
                  comments: ''
                  store_id: 1
                  source: ''
                  search_string: ''
                  no_account: false
                  sales_person: ''
                  alternate_phone_number: ''
                  is_affiliate_customer: false
                  username: ''
                  is_contact_information_only: false
                  tax_exemption_number: ''
                  company: ''
                  source_group: ''
                  sales_person_user_id: null
                  tax_rate: null
                  reward_tier_id: null
            examples:
              Example:
                value:
                  id: 13
                  customer_number: ''
                  last_name: Aurelius
                  first_name: Marcus
                  email: maurelius@test.com
                  phone_number: 555-123-4596
                  adcode: ''
                  adcode_id: 0
                  affiliate_id: 1
                  customer_type_id: 4
                  is_no_tax_customer: true
                  comments: ''
                  store_id: 19
                  source: ''
                  search_string: ''
                  no_account: false
                  sales_person: ''
                  alternate_phone_number: 455-258-8585
                  is_affiliate_customer: false
                  username: ''
                  is_contact_information_only: false
                  tax_exemption_number: ''
                  company: Romanatech
                  source_group: ''
                  sales_person_user_id: 2
                  store_payment_methods_enabled: []
                  tax_rate: 2
                  lock_default_address: false
                  reward_tier_id: 1
                  payment_net_term: 0
                  credit_limit: 10.00
                  is_inactive: false
                  use_shared_credit_limit: false
                  override_shared_credit_limit: false
                  customer_payment_methods_availability: []
                  default_payment_type_name: Credit Card
        description: ''
    delete:
      summary: Delete a Customer
      operationId: delete-customers-id
      tags:
        - Customers
      description: Deletes a customer.
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
  /discount_actions:
    get:
      summary: Discount Actions
      tags:
        - Marketing
        - Discount Actions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  discount_actions:
                    type:
                      - array
                    items:
                      $ref: '#/components/schemas/discount_actions'
      operationId: get-discount_actions
      description: Gets an array of discount actions.
    post:
      summary: Create a Discount Actions
      operationId: post-discount_actions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/discount_actions'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                discount_method_id:
                  type: integer
                is_exclusive:
                  type: boolean
                is_strict:
                  type: boolean
                is_active:
                  type: boolean
                modifier_operation:
                  type: string
                modifier_amount:
                  type: string
                modifier_type:
                  type: string
                modifier_target:
                  type: string
                sort_order:
                  type: integer
            examples:
              Example:
                value:
                  discount_method_id: 4
                  is_exclusive: true
                  is_strict: false
                  is_active: false
                  modifier_operation: 'subtract'
                  modifier_amount: '1'
                  modifier_type: 'dollars'
                  modifier_target: 'total'
                  sort_order: 0
      tags:
        - Discount Actions
        - Marketing
      description: Creates a discount action.
  '/discount_actions/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `discount_action`
    put:
      summary: Update a Discount Action
      operationId: put-discount_actions-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/discount_actions'
      tags:
        - Discount Actions
        - Marketing
      description: Updates a discount action.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/discount_actions'
    delete:
      summary: Delete a Discount Action
      operationId: delete-discount_actions-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Discount Actions
        - Marketing
      description: Deletes a discount action.
  /discount_methods:
    get:
      summary: Discount Methods
      tags:
        - Marketing
        - Discount Methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  discount_methods:
                    type:
                      - array
                    items:
                      $ref: '#/components/schemas/discount_methods'
      operationId: get-discount_methods
      description: Gets an array of discount methods.
    post:
      summary: Create a Discount Method
      operationId: post-discount_methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/discount_methods'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: 15 off
                  is_enabled: true
                  is_strict: false
                  use_once: false
                  expires: false
                  expires_at: ''
                  starts_at: '7/7/2021 3:23:11 PM'
                  remaining_uses: null
                  notes: ''
                  is_free_shipping_discount: false
              properties:
                name:
                  type: string
                is_enabled:
                  type: boolean
                is_strict:
                  type: boolean
                use_once:
                  type: boolean
                expires:
                  type: boolean
                expires_at:
                  type: string
                starts_at:
                  type: string
                remaining_uses:
                  type: integer
                notes:
                  type: string
                is_free_shipping_discount:
                  type: boolean
                is_exclusive:
                  type: boolean
                uses:
                  type: integer
                exclude_child_items:
                  type: boolean
                exclude_subscription_renew:
                  type: boolean
            examples:
              Example:
                value:
                  name: 15 off
                  is_enabled: true
                  is_strict: false
                  use_once: false
                  expires: false
                  expires_at: ''
                  starts_at: '7/7/2021 3:23:11 PM'
                  remaining_uses: 5
                  notes: ''
                  is_free_shipping_discount: false
                  is_exclusive: false
                  uses: 10
                  exclude_child_items: false
                  exclude_subscription_renew: true
      tags:
        - Discount Methods
        - Marketing
      description: Creates a discount method.
  '/discount_methods/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `discount_method`
    put:
      summary: Update a Discount Method
      operationId: put-discount_methods-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/discount_methods'
      tags:
        - Discount Methods
        - Marketing
      description: Updates a discount method.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/discount_methods'
    delete:
      summary: Delete a Discount Method
      operationId: delete-discount_methods-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Discount Methods
        - Marketing
      description: Deletes a discount method.
  /discount_rules:
    get:
      summary: Get Discount Rules
      tags:
        - Marketing
        - Discount Rules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  discount_rules:
                    type: array
                    items:
                      $ref: '#/components/schemas/discount_rules'
      operationId: get-discount_rules
      description: 'Gets an array of discount rules. '
    post:
      summary: Create a Discount Rule
      operationId: post-discount_rules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/discount_rules'
      description: 'Creates a discount rule. '
      tags:
        - Discount Rules
        - Marketing
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  discount_method_id: 41
                  type: coupon code
                  target: Hello There
                  operator_type: equal to
                  target_quantity: 1
                  target_quantity_type: MinimumOf
                  discount_action_id: null
                  is_action_rule: false
                  bogo_discount_buy_quantity: null
                  bogo_discount_quantity: null
                  bogo_max_use_per_order: null
                  discount_from_high_to_low: false
              properties:
                discount_method_id:
                  type: integer
                type:
                  type: string
                target:
                  type: string
                operator_type:
                  type: string
                target_quantity:
                  type: integer
                target_quantity_type:
                  type: string
                discount_action_id:
                  type: integer
                is_action_rule:
                  type: boolean
                bogo_discount_buy_quantity:
                  type: integer
                bogo_discount_quantity:
                  type: integer
                bogo_max_use_per_order:
                  type: integer
                discount_from_high_to_low:
                  type: boolean
              required:
                - discount_method_id
                - type
                - target
            examples:
              Example:
                value:
                  discount_method_id: 41
                  type: coupon code
                  target: Hello There
                  operator_type: equal to
                  target_quantity: 1
                  target_quantity_type: MinimumOf
                  discount_action_id: null
                  is_action_rule: false
                  bogo_discount_buy_quantity: null
                  bogo_discount_quantity: null
                  bogo_max_use_per_order: null
                  discount_from_high_to_low: false
  '/discount_rules/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `discount_rule`
    delete:
      summary: Deletes a Discount Rule
      operationId: delete-discount_rules-id
      description: 'Deletes a discount rule. '
      tags:
        - Discount Rules
        - Marketing
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
    put:
      summary: Update a Discount Rule
      operationId: put-discount_rules-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/discount_rules'
      description: Updates a discount rule.
      tags:
        - Discount Rules
        - Marketing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/discount_rules'
  /drips:
    get:
      summary: Get Drips
      tags:
        - Marketing
        - Drips
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  drips:
                    type: array
                    items:
                      $ref: '#/components/schemas/drips'
      operationId: get-drips
      description: |-
        Gets an array of drips. 

        For more information on drips, please see our Knowedge Base: [Drip Series Emailing](https://support.americommerce.com/hc/en-us/articles/201903290-Drip-Series-Email-Setup)
    post:
      summary: Creates a Drip
      operationId: post-drips
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/drips'
      description: |-
        Creates a drip. 

        For more information on drips, please see our Knowedge Base: [Drip Series Emailing](https://support.americommerce.com/hc/en-us/articles/201903290-Drip-Series-Email-Setup)
      tags:
        - Drips
        - Marketing
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: abandoned cart 2
                  is_enabled: true
              properties:
                name:
                  type: string
                is_enabled:
                  type: boolean
            examples:
              example-1:
                value:
                  name: abandoned cart
                  is_enabled: true
  '/drips/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The id of the `drip`
    put:
      summary: Update a Drip
      operationId: put-drips-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/drips'
      tags:
        - Drips
        - Marketing
      description: |-
        Updates a drip. 

        For more information on drips, please see our Knowedge Base: [Drip Series Emailing](https://support.americommerce.com/hc/en-us/articles/201903290-Drip-Series-Email-Setup)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/drips'
    delete:
      summary: Delete a Drip
      operationId: delete-drips-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Drips
        - Marketing
      description: |-
        Deletes a drip.

        For more information on drips, please see our Knowedge Base: [Drip Series Emailing](https://support.americommerce.com/hc/en-us/articles/201903290-Drip-Series-Email-Setup)
  /email_templates:
    get:
      summary: Get Email Templates
      tags:
        - Marketing
        - Email Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  email_templates:
                    type: array
                    items:
                      $ref: '#/components/schemas/email_templates'
      operationId: get-email_templates
      description: Gets an array of email templates.
    post:
      summary: Create an Email Template
      operationId: post-email_templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_templates'
      tags:
        - Email Templates
        - Marketing
      description: Creates an email template.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  type: Order Confirmation
                  body: "Thank you for your order!  Please print this for your records.\r\n\r\n--------------------------------\r\nOrder #\t\t: ##ORDERID##\r\nEmail\t\t\t: ##CUSTOMEREMAIL##\r\nOrder Date\t\t: ##ORDERDATE##\r\nOrder Status\t: ##ORDERSTATUS##\r\nPayment Status\t: ##PAYMENTSTATUS##\r\nPayment Method\t: ##PAYMENTMETHOD##\r\n\r\n--------------------------------\r\nShipping Address\r\n--------------------------------\r\n##SHIPADDRESS##\r\n\r\n--------------------------------\r\nOrder Details\r\n##ORDERITEMS##\r\n--------------------------------\r\nSub-Total\t\t: ##SUBTOTAL##\r\nShipping Method\t: ##SHIPPINGMETHOD##\r\nShipping Amount\t: ##SHIPPING##\r\nEstimated Tax\t: ##TAX##\r\n##DISCOUNTSTRING## ##DISCOUNTTOTAL##\r\n--------------------------------\r\nTotal\t\t\t: ##TOTAL##\r\n--------------------------------"
                  subject: 'Confirmation Order ###ORDERID##'
                  from_name: '##STORENAME##'
                  from_email: '##STOREEMAIL##'
                  is_enabled: true
                  admin_alert_header: "\r\nCustomer Test: ##IF[CustomerType= ]## Worked ##ELSE## didnt ##ENDIF##\r\n\r\n##IF[CustomerType=retail]## retail \r\n##IF[CustomerType=approval needed]## aprlvnad \r\n##IF[CustomerType=wholesale]## wholesale\r\n##IF[CustomerType=Drop Shipper]## drop shipper\r\n##ELSE##\r\nNew Customer\r\n###ENDIF##\r\n\r\n\r\n\r\n\r\nView this order: \r\n##ADMINORDERLINK##\r\n \r\n\r\n\r\nAVS Code: ##AVSCODE## \r\nSource: ##SOURCE## \r\nPPC Keyword: ##PPCKEYWORD## \r\nSearch Phrase: ##SEARCHPHRASE## \r\nCampaign Code: ##CAMPAIGNCODE##\r\n\r\n$$GIFTCERTIFICATEAMOUNT$$ \r\n##GIFTCERTIFICATEDELIVERYAREA##\r\n##GIFTCERTIFICATEDELIVERYAREAHTML##\r\n##GIFTCERTIFICATECODESCSV##\r\n\r\n\r\n##ADMINORDERWARNINGS##"
                  admin_alert_subject: 'Order ID###ORDERID## - ##TOTAL##'
                  is_admin_alert_enabled: true
                  email_format: TEXT
                  attach_invoice_pdf: false
              properties:
                type:
                  type: string
                body:
                  type: string
                subject:
                  type: string
                from_name:
                  type: string
                from_email:
                  type: string
                is_enabled:
                  type: boolean
                admin_alert_header:
                  type: string
                admin_alert_subject:
                  type: string
                is_admin_alert_enabled:
                  type: boolean
                email_format:
                  type: string
                attach_invoice_pdf:
                  type: boolean
                email_category_id:
                  type: integer
                admin_alert_email_override:
                  type: string
            examples:
              Example:
                value:
                  type: Order Confirmation
                  body: "Thank you for your order!  Please print this for your records.\r\n\r\n--------------------------------\r\nOrder #\t\t: ##ORDERID##\r\nEmail\t\t\t: ##CUSTOMEREMAIL##\r\nOrder Date\t\t: ##ORDERDATE##\r\nOrder Status\t: ##ORDERSTATUS##\r\nPayment Status\t: ##PAYMENTSTATUS##\r\nPayment Method\t: ##PAYMENTMETHOD##\r\n\r\n--------------------------------\r\nShipping Address\r\n--------------------------------\r\n##SHIPADDRESS##\r\n\r\n--------------------------------\r\nOrder Details\r\n##ORDERITEMS##\r\n--------------------------------\r\nSub-Total\t\t: ##SUBTOTAL##\r\nShipping Method\t: ##SHIPPINGMETHOD##\r\nShipping Amount\t: ##SHIPPING##\r\nEstimated Tax\t: ##TAX##\r\n##DISCOUNTSTRING## ##DISCOUNTTOTAL##\r\n--------------------------------\r\nTotal\t\t\t: ##TOTAL##\r\n--------------------------------"
                  subject: 'Confirmation Order ###ORDERID##'
                  from_name: '##STORENAME##'
                  from_email: '##STOREEMAIL##'
                  is_enabled: true
                  admin_alert_header: "\r\nCustomer Test: ##IF[CustomerType= ]## Worked ##ELSE## didnt ##ENDIF##\r\n\r\n##IF[CustomerType=retail]## retail \r\n##IF[CustomerType=approval needed]## aprlvnad \r\n##IF[CustomerType=wholesale]## wholesale\r\n##IF[CustomerType=Drop Shipper]## drop shipper\r\n##ELSE##\r\nNew Customer\r\n###ENDIF##\r\n\r\n\r\n\r\n\r\nView this order: \r\n##ADMINORDERLINK##\r\n \r\n\r\n\r\nAVS Code: ##AVSCODE## \r\nSource: ##SOURCE## \r\nPPC Keyword: ##PPCKEYWORD## \r\nSearch Phrase: ##SEARCHPHRASE## \r\nCampaign Code: ##CAMPAIGNCODE##\r\n\r\n$$GIFTCERTIFICATEAMOUNT$$ \r\n##GIFTCERTIFICATEDELIVERYAREA##\r\n##GIFTCERTIFICATEDELIVERYAREAHTML##\r\n##GIFTCERTIFICATECODESCSV##\r\n\r\n\r\n##ADMINORDERWARNINGS##"
                  admin_alert_subject: 'Order ID###ORDERID## - ##TOTAL##'
                  is_admin_alert_enabled: true
                  email_format: TEXT
                  attach_invoice_pdf: false
                  email_category_id: 1
                  admin_alert_email_override: 'coolGuy89@americommerce.com'
  '/email_templates/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `email_template`
    put:
      summary: Update an Email Template
      operationId: put-email_templates-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_templates'
      tags:
        - Email Templates
        - Marketing
      description: Updates an email template.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_templates'
    delete:
      summary: Delete an Email Template
      operationId: delete-email_templates-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Email Templates
        - Marketing
      description: Deletes an email template.
  /external_image_whitelist:
    get:
      summary: Get External Image Whitelist
      tags:
        - External Image Whitelist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  external_image_whitelist:
                    type: array
                    items:
                      $ref: '#/components/schemas/external_image_whitelist'
      operationId: get-external_image_whitelist
      description: Gets an array of external image whitelist items.
    post:
      summary: Create an External Image Whitelist Item
      operationId: post-external_image_whitelist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external_image_whitelist'
      tags:
        - External Image Whitelist
      description: Creates an external image whitelist item.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                url:
                  type: string
            examples:
              Example:
                value:
                  url: ''
  '/external_image_whitelist/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `external_image_whitelist`
    put:
      summary: Update an External Image Whitelist Item
      operationId: put-external_image_whitelist-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external_image_whitelist'
      tags:
        - External Image Whitelist
      description: Updates an external image whitelist item.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/external_image_whitelist'
    delete:
      summary: Delete an External Image Whitelist Item
      operationId: delete-external_image_whitelist-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        -  External Image Whitelist
      description: Deletes an external image whitelist item.
  /gift_certificate_transactions:
    get:
      summary: Get Gift Certificate Transactions
      tags:
        - Marketing
        - Gift Certificate Transactions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  gift_certificate_transactions:
                    type: array
                    items:
                      $ref: '#/components/schemas/gift_certificate_transactions'
      operationId: get-gift_certificate_transactions
      description: Gets an array of gift certificate transactions.
    post:
      summary: Create a Gift Certificate Transaction
      operationId: post-gift_certificate_transactions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gift_certificate_transactions'
      tags:
        - Gift Certificate Transactions
        - Marketing
      description: Creates a gift certificate transactions
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  gift_certificate_id: 28
                  action: SetActive
                  amount: 0
                  is_pre_tax_discount: false
                  order_id: 0
                  order_payment_id: null
                  status: Approved
              properties:
                gift_certificate_id:
                  type: integer
                action:
                  type: string
                amount:
                  type: number
                is_pre_tax_discount:
                  type: boolean
                order_id:
                  type: number
                order_payment_id:
                  type: integer
                status:
                  type: string
            examples:
              Example:
                value:
                  gift_certificate_id: 28
                  action: SetActive
                  amount: 0
                  is_pre_tax_discount: false
                  order_id: 0
                  order_payment_id: null
                  status: Approved
  '/gift_certificate_transactions/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `gift_certificate_transactions`
    put:
      summary: Update a Gift Certificate Transaction
      operationId: put-gift_certificate_transactions-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gift_certificate_transactions'
      description: 'Updates a gift certificate transaction. '
      tags:
        - Gift Certificate Transactions
        - Marketing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/gift_certificate_transactions'
    delete:
      summary: Delete a Gift Certificate Transaction
      operationId: delete-gift_certificate_transactions-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a gift certificate transaction.
      tags:
        - Gift Certificate Transactions
        - Marketing
  /gift_certificates:
    get:
      summary: Get Gift Certificates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  gift_certificates:
                    type: array
                    items:
                      $ref: '#/components/schemas/gift_certificates'
      operationId: get-gift_certificates
      tags:
        - Gift Certificates
        - Marketing
      description: Gets an array of gift certificates.
    post:
      summary: Creates a Gift Certificate
      operationId: post-gift_certificates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gift_certificates'
      tags:
        - Gift Certificates
        - Marketing
      description: Creates a gift certificate.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 4
                  code: GC-NCC-67-M1VGS7
                  original_order_id: null
                  from_customer_id: null
                  recipient_email: ''
                  recipient_name: ''
                  recipient_shipping_address: ''
                  gift_message: ''
                  status: Active
                  is_pre_tax_discount: false
                  gift_certificate_type: free gc
                  comments: ''
                  expires_at: '1900-01-01T00:00:00-06:00'
                  store_id: 1
                  current_amount: 10
                  original_amount: 10
                  customer_id: 16
                  expires: false
                  order_item_id: null
              properties:
                code:
                  type: string
                original_order_id:
                  type: integer
                from_customer_id:
                  type: integer
                recipient_email:
                  type: string
                recipient_name:
                  type: string
                recipient_shipping_address:
                  type: string
                gift_message:
                  type: string
                status:
                  type: string
                is_pre_tax_discount:
                  type: boolean
                gift_certificate_type:
                  type: string
                comments:
                  type: string
                expires_at:
                  type: string
                store_id:
                  type: integer
                current_amount:
                  type: number
                original_amount:
                  type: number
                customer_id:
                  type: integer
                expires:
                  type: boolean
                order_item_id:
                  type: integer
            examples:
              Example:
                value:
                  id: 4
                  code: GC-NCC-67-M1VGS7
                  original_order_id: null
                  from_customer_id: null
                  recipient_email: ''
                  recipient_name: ''
                  recipient_shipping_address: ''
                  gift_message: ''
                  status: Active
                  is_pre_tax_discount: false
                  gift_certificate_type: free gc
                  comments: ''
                  expires_at: '1900-01-01T00:00:00-06:00'
                  store_id: 1
                  current_amount: 10.00
                  original_amount: 10.00
                  customer_id: 16
                  expires: false
                  order_item_id: null
  '/gift_certificates/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `gift_certificate`
    put:
      summary: Update a Gift Certificate
      operationId: put-gift_certificates-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gift_certificates'
      tags:
        - Gift Certificates
        - Marketing
      description: Updates a gift certificate.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/gift_certificates'
    delete:
      summary: Deletes a Gift Certificate
      operationId: delete-gift_certificates-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Gift Certificates
        - Marketing
      description: 'Deletes a gift certificate. '
  /inventory:
    get:
      summary: Get Inventory
      tags:
        - Products
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inventory'
      operationId: get-inventory
      parameters:
        - schema:
            type: integer
          in: query
          name: product_id
          required: true
        - schema:
            type: integer
          in: query
          name: variant_inventory_id
        - schema:
            type: string
          in: query
          name: item_number
        - schema:
            type: string
          in: query
          name: gtin
        - schema:
            type: string
          in: query
          name: item_name
      description: 'Gets current inventory of specified item in query. '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 62
                  variant_inventory_id: null
                  item_number: 60PY2DR
                  item_name: 60PY2DR
                  gtin: ''
                  quantity: 20
              properties:
                product_id:
                  type: integer
                variant_inventory_id:
                  type: integer
                item_number:
                  type: string
                  minLength: 1
                item_name:
                  type: string
                  minLength: 1
                gtin:
                  type: string
                quantity:
                  type: number
              required:
                - product_id
                - item_number
                - item_name
                - gtin
                - quantity
            examples:
              Example:
                value:
                  product_id: 62
                  variant_inventory_id: 145
                  item_number: 60PY2DR
                  item_name: 60PY2DR
                  gtin: ''
                  quantity: 20
    parameters: []
  /links:
    get:
      summary: Get Links
      tags:
        - Links
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  links:
                    type: array
                    items:
                      $ref: '#/components/schemas/links'
      operationId: get-links
      description: Gets an array of menu links.
    post:
      summary: Create a Link
      operationId: post-links
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/links'
      description: Creates a link.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  url: /store/shop-all.aspx
                  text: Shop
                  sort_order: 2
                  store_id: 14
                  is_hidden: false
                  named_link: null
                  page_id: 0
                  category_id: 0
                  is_dynamic_menu_root: false
                  dynamic_menu_levels: 0
                  link_type: Category
                  parent_link_id: 118
                  is_hidden_in_navigation_only: false
                  opens_in_new_window: false
                  is_home_page: false
                  product_id: 0
                  blog_id: 0
                  blog_category_id: 0
              properties:
                url:
                  type: string
                text:
                  type: string
                sort_order:
                  type: integer
                store_id:
                  type: integer
                is_hidden:
                  type: boolean
                named_link: {}
                page_id:
                  type: integer
                category_id:
                  type: integer
                is_dynamic_menu_root:
                  type: boolean
                dynamic_menu_levels:
                  type: number
                link_type:
                  type: string
                parent_link_id:
                  type: integer
                is_hidden_in_navigation_only:
                  type: boolean
                opens_in_new_window:
                  type: boolean
                is_home_page:
                  type: boolean
                product_id:
                  type: integer
                blog_id:
                  type: integer
                blog_category_id:
                  type: integer
            examples:
              Example:
                value:
                  url: /store/shop-all.aspx
                  text: Shop
                  sort_order: 2
                  store_id: 14
                  is_hidden: false
                  named_link: null
                  page_id: 0
                  category_id: 0
                  is_dynamic_menu_root: false
                  dynamic_menu_levels: 0
                  link_type: Category
                  parent_link_id: 118
                  is_hidden_in_navigation_only: false
                  opens_in_new_window: false
                  is_home_page: false
                  product_id: 0
                  blog_id: 0
                  blog_category_id: 0
      tags:
        - Links
  '/links/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `link`
    put:
      summary: Update a Link
      operationId: put-links-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/links'
      tags:
        - Links
      description: Updates a link.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/links'
    delete:
      summary: Delete a Link
      operationId: delete-links-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Links
      description: Deletes a link.
  /mailing_lists:
    get:
      summary: Get Mailing Lists
      tags:
        - Marketing
        - Mailing Lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  mailing_lists:
                    type: array
                    items:
                      $ref: '#/components/schemas/mailing_lists'
      operationId: get-mailing_lists
      description: Gets an array of mailing lists.
    post:
      summary: Create a Mailing List
      operationId: post-mailing_lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mailing_lists'
      tags:
        - Mailing Lists
        - Marketing
      description: Creates a mailing list.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  type: Internal
                  admin_list_name: InternalList
                  public_list_name: ''
                  store_id: 4
                  is_store_default: true
                  auto_opt_in: false
                  is_hidden: false
                  url_based_subscribe_url: ''
                  welcome_email_template_id: 0
              properties:
                type:
                  type: string
                admin_list_name:
                  type: string
                public_list_name:
                  type: string
                store_id:
                  type: integer
                is_store_default:
                  type: boolean
                auto_opt_in:
                  type: boolean
                is_hidden:
                  type: boolean
                url_based_subscribe_url:
                  type: string
                welcome_email_template_id:
                  type: integer
              required:
                - store_id
            examples:
              Example:
                value:
                  type: Internal
                  admin_list_name: InternalList
                  public_list_name: ''
                  store_id: 4
                  is_store_default: true
                  auto_opt_in: false
                  is_hidden: false
                  url_based_subscribe_url: ''
                  welcome_email_template_id: 0
  '/mailing_lists/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `mailing_list`
    put:
      summary: Update a Mailing List
      operationId: put-maling_lists-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mailing_lists'
      tags:
        - Mailing Lists
        - Marketing
      description: Updates a mailing list.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mailing_lists'
    delete:
      summary: Delete a Mailing List
      operationId: delete-maling_lists-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Mailing Lists
        - Marketing
      description: Deletes a mailing list.
  /manufacturers:
    get:
      summary: Get Manufacturers
      tags:
        - Manufacturers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  manufacturers:
                    type: array
                    items:
                      $ref: '#/components/schemas/manufacturers'
      operationId: get-manufacturers
      description: Gets an array of manufacturers.
    post:
      summary: Create a Manufacturer
      operationId: post-manufacturers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/manufacturers'
      tags:
        - Manufacturers
      description: 'Creates a manufacturer. '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Cart.com
                  description: ''
                  is_hidden: false
                  sort_order: null
                  manufacturer_logo_url: /Shared/images/cart.png
                  page_title: ''
                  keywords: ''
                  meta_description: ''
                  url_rewrite: /cartcom.aspx
                  head_tags: ''
                  brand_code: ''
              properties:
                name:
                  type: string
                description:
                  type: string
                is_hidden:
                  type: boolean
                sort_order:
                  type: integer
                manufacturer_logo_url:
                  type: string
                page_title:
                  type: string
                keywords:
                  type: string
                meta_description:
                  type: string
                url_rewrite:
                  type: string
                head_tags:
                  type: string
                brand_code:
                  type: string
            examples:
              Example:
                value:
                  name: Cart.com
                  description: ''
                  is_hidden: false
                  sort_order: 1
                  manufacturer_logo_url: /Shared/images/cart.png
                  page_title: ''
                  keywords: ''
                  meta_description: ''
                  url_rewrite: /cartcom.aspx
                  head_tags: ''
                  brand_code: ''
  '/manufacturers/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `manufacturer`
    put:
      summary: Update a Manufacturer
      operationId: put-manufacturers-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/manufacturers'
      tags:
        - Manufacturers
      description: Updates a manufacturer.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/manufacturers'
    delete:
      summary: Delete a Manufacturer
      operationId: delete-manufacturers-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Manufacturers
      description: Deletes a manufacturer.
  /microstores:
    get:
      summary: Get Microstores
      tags:
        - Microstores
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  microstores:
                    type: array
                    items:
                      $ref: '#/components/schemas/microstores'
      operationId: get-microstores
      description: Gets an array of microstores.
    post:
      summary: Create a Microstore
      operationId: post-microstores
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microstores'
      tags:
        - Microstores
      description: Creates a Microstore.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: TheMikeRoweStore
                  address_line_1: 135 El Pollo Loco
                  address_line_2: ''
                  city: Springfield
                  state: Texas
                  country: United States
                  postal_code: '77334'
                  phone: 431-543-1234
                  fax: ''
                  parent_store_id: 1
                  is_micro_store: true
                  set_cookie: true
                  cookie_expiration: 0
                  logo_image: ''
                  path: /TheMikeRoweStore
              properties:
                name:
                  type: string
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                city:
                  type: string
                state:
                  type: string
                country:
                  type: string
                postal_code:
                  type: string
                phone:
                  type: string
                fax:
                  type: string
                parent_store_id:
                  type: integer
                is_micro_store:
                  type: boolean
                set_cookie:
                  type: boolean
                cookie_expiration:
                  type: number
                activation_date:
                  type: string
                expiration_date:
                  type: string
                logo_image:
                  type: string
                path:
                  type: string
            examples:
              Example:
                value:
                  name: TheMikeRoweStore
                  address_line_1: 135 Test st
                  address_line_2: ''
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77701'
                  phone: 431-543-1234
                  fax: ''
                  parent_store_id: 1
                  is_micro_store: true
                  set_cookie: true
                  cookie_expiration: 0
                  activation_date: null
                  expiration_date: null
                  logo_image: ''
                  path: /TheMikeRoweStore
  '/microstores/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `microstore`
    put:
      summary: Update a Microstore
      operationId: put-microstores-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microstores'
      tags:
        - Microstores
      description: 'Updates a microstore. '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microstores'
    delete:
      summary: Delete a Microstore
      operationId: delete-microstores-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Microstores
      description: Deletes a microstore.
  /notifications:
    get:
      summary: Get Notifications
      tags:
        - Notifications
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  notifications:
                    type: array
                    items:
                      $ref: '#/components/schemas/notifications'
      operationId: get-notifications
      description: 'Returns an array of product notifications. '
    post:
      summary: Create a Notification
      operationId: post-notifications
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notifications'
      tags:
        - Notifications
      description: Creates a product notification.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 86
                  email_address: test@mail.com
                  customer_id: 22
                  notification_frequency_type: Once
                  store_id: 1
                  variant_inventory_id: null
              properties:
                product_id:
                  type: integer
                email_address:
                  type: string
                customer_id:
                  type: integer
                notification_frequency_type:
                  type: string
                store_id:
                  type: integer
                variant_inventory_id:
                  type: integer
            examples:
              Example:
                value:
                  product_id: 86
                  email_address: test@cart.com
                  customer_id: 22
                  notification_frequency_type: Once
                  store_id: 1
                  variant_inventory_id: 123
  '/notifications/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `notification`
    put:
      summary: Update a Notification
      operationId: put-notifications-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notifications'
      tags:
        - Notifications
      description: Updates a product notification.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notifications'
        description: ''
    delete:
      summary: Delete a Notification
      operationId: delete-notifications-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Notifications
      description: Deletes a notificaton.
  /order_addresses:
    get:
      summary: Get Order Addresses
      tags:
        - Order Addresses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  order_addresses:
                    type: array
                    items:
                      $ref: '#/components/schemas/order_addresses'
      operationId: get-order_addresses
      description: Gets an array of order addresses.
    post:
      summary: Create an Order Address
      operationId: post-order_addresses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_addresses'
      tags:
        - Order Addresses
      description: Creates an order address.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  customer_id: 107
                  company: ''
                  address_line_1: 123 Test St
                  address_line_2: ''
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77706'
                  phone: '3333333333'
                  alternate_phone: ''
                  fax: ''
                  comments: ''
                  first_name: Test
                  last_name: Person
                  address_type: Default
              properties:
                customer_id:
                  type: integer
                company:
                  type: string
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                city:
                  type: string
                state:
                  type: string
                country:
                  type: string
                postal_code:
                  type: string
                phone:
                  type: string
                alternate_phone:
                  type: string
                fax:
                  type: string
                comments:
                  type: string
                first_name:
                  type: string
                last_name:
                  type: string
                address_type:
                  type: string
                state_code:
                  type: string
                country_code:
                  type: string
              required:
                - customer_id
            examples:
              Example:
                value:
                  customer_id: 107
                  company: ''
                  address_line_1: 123 Test St
                  address_line_2: ''
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77706'
                  phone: '3333333333'
                  alternate_phone: ''
                  fax: ''
                  comments: ''
                  first_name: Test
                  last_name: Person
                  address_type: Default
                  state_code: TX
                  country_code: US
  '/order_addresses/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `order_address`
    put:
      summary: Update an Order Address
      operationId: put-order_addresses-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_addresses'
      description: 'Updates an order address. '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_addresses'
      tags:
        - Order Addresses
    delete:
      summary: Delete an Order Address
      operationId: delete-order_addresses-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Order Addresses
      description: Deletes an Order Address.
  /order_items:
    get:
      summary: Get Order Items
      tags:
        - Order Items
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  order_items:
                    type: array
                    items:
                      $ref: '#/components/schemas/order_items'
      operationId: get-order_items
      description: Gets an array of order items.
    post:
      summary: Create an Order Item
      operationId: post-order_items
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_items'
      tags:
        - Order Items
      description: Creates an order item.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  order_id: 100232
                  product_id: 80
                  item_number: '1234'
                  item_name: Project Screen
                  price: 1400
                  cost: 0
                  quantity: 1
                  is_discount_item: false
                  weight: 0
                  is_taxable: false
                  weight_unit: Lbs
                  warehouse_id: 0
                  variant_inventory_id: null
                  parent_order_item_id: null
                  is_quantity_bound_to_parent: false
                  height: 0
                  length: 0
                  width: 0
                  size_unit: In
                  tax_code: ''
                  item_number_full: '800'
                  admin_comments: ''
                  do_not_discount: false
                  line_item_note: ''
                  order_shipping_address_id: null
                  gift_message: ''
                  delivery_date: null
                  discount_amount: 0
                  discount_percentage: 0
                  is_subscription_product: false
                  is_non_shipping_item: false
                  description: ''
                  vendor_store_id: null
                  variants: null
                  personalizations: null
              properties:
                order_id:
                  type: integer
                product_id:
                  type: integer
                item_number:
                  type: string
                item_name:
                  type: string
                price:
                  type: number
                cost:
                  type: number
                quantity:
                  type: number
                is_discount_item:
                  type: boolean
                weight:
                  type: number
                is_taxable:
                  type: boolean
                weight_unit:
                  type: string
                warehouse_id:
                  type: integer
                variant_inventory_id:
                  type: integer
                parent_order_item_id:
                  type: integer
                is_quantity_bound_to_parent:
                  type: boolean
                height:
                  type: number
                length:
                  type: number
                width:
                  type: number
                size_unit:
                  type: string
                tax_code:
                  type: string
                item_number_full:
                  type: string
                admin_comments:
                  type: string
                do_not_discount:
                  type: boolean
                line_item_note:
                  type: string
                order_shipping_address_id:
                  type: integer
                gift_message:
                  type: string
                delivery_date:
                  type: string
                discount_amount:
                  type: number
                discount_percentage:
                  type: number
                is_subscription_product:
                  type: boolean
                is_non_shipping_item:
                  type: boolean
                description:
                  type: string
                tax:
                  type: number
                configuration:
                  type: string
                status:
                  type: string
                shipping_classification_code:
                  type: string
                variants:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                      description:
                        type: string
                      variant_group_id:
                        type: integer
                personalizations:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                      answer:
                        type: string
            examples:
              Example:
                value:
                  order_id: 100232
                  product_id: 80
                  item_number: '1234'
                  item_name: Projector Screen
                  price: 1400
                  cost: 0
                  quantity: 1
                  is_discount_item: false
                  weight: 0
                  is_taxable: false
                  weight_unit: Lbs
                  warehouse_id: 0
                  variant_inventory_id: 123
                  parent_order_item_id: 142
                  is_quantity_bound_to_parent: false
                  height: 0
                  length: 0
                  width: 0
                  size_unit: In
                  tax_code: ''
                  item_number_full: '800'
                  admin_comments: ''
                  do_not_discount: false
                  line_item_note: ''
                  order_shipping_address_id: 124
                  gift_message: ''
                  delivery_date: ''
                  discount_amount: 0
                  discount_percentage: 0
                  is_subscription_product: false
                  is_non_shipping_item: false
                  description: ''
                  tax: 18.20
                  configuration: ''
                  status: ''
                  shipping_classification_code: ''
                  variants: []
                  personalizations: []
  '/order_items/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `order_item`
    put:
      summary: Updates an Order Item
      operationId: put-order_items-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_items'
      description: Update an order item.
      tags:
        - Order Items
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_items'
    delete:
      summary: Delete an Order Item
      operationId: delete-order_items-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Order Items
      description: Deletes an order item.
  /order_payments:
    get:
      summary: Get Order Payments
      tags:
        - Order Payments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  order_payments:
                    type: array
                    items:
                      $ref: '#/components/schemas/order_payments'
      operationId: get-order_payments
      description: Gets an array of Order Payments.
    post:
      summary: Create an Order Payment
      operationId: post-order_payments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_payments'
      tags:
        - Order Payments
      description: Creates an order payment
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  customer_id: 107
                  order_id: 100242
                  customer_payment_method_id: 0
                  payment_method_id: 122
                  payment_type: Custom
                  is_approved: true
                  is_declined: false
                  card_type: null
                  card_expiration_month: 0
                  card_expiration_year: 0
                  cardholder_name: ''
                  approved_at: ''
                  authorization_code: ''
                  reject_reason: ''
                  avs_code: ''
                  payment_method_name: custom
                  transaction_type: None
                  amount: 5001
                  payment_note: ''
                  gift_certificate_id: null
                  is_captured: false
                  transaction_id: ''
                  last_four: ''
                  is_void: false
                  gateway_response_code: ''
                  cvv_response_code: ''
                  token: ''
                  payment_ref_num: ''
                  store_payment_method_id: null
              properties:
                customer_id:
                  type: integer
                order_id:
                  type: integer
                customer_payment_method_id:
                  type: integer
                payment_method_id:
                  type: integer
                payment_type:
                  type: string
                  minLength: 1
                is_approved:
                  type: boolean
                is_declined:
                  type: boolean
                card_type:
                  type: string
                card_expiration_month:
                  type: integer
                card_expiration_year:
                  type: integer
                cardholder_name:
                  type: string
                reject_reason:
                  type: string
                payment_method_name:
                  type: string
                transaction_type:
                  type: string
                amount:
                  type: number
                payment_note:
                  type: string
                gift_certificate_id:
                  type: integer
                is_captured:
                  type: boolean
                last_four:
                  type: string
                is_void:
                  type: boolean
                payment_ref_num:
                  type: string
                store_payment_method_id:
                  type: integer
              required:
                - customer_id
                - order_id
            examples:
              Example:
                value:
                  customer_id: 107
                  order_id: 100242
                  customer_payment_method_id: 0
                  payment_method_id: 122
                  payment_type: Custom
                  is_approved: true
                  is_declined: false
                  card_type: ''
                  card_expiration_month: 0
                  card_expiration_year: 0
                  cardholder_name: ''
                  reject_reason: ''
                  payment_method_name: custom
                  transaction_type: None
                  amount: 5001
                  payment_note: ''
                  gift_certificate_id: 12
                  is_captured: false
                  last_four: ''
                  is_void: false
                  payment_ref_num: ''
                  store_payment_method_id: 2
  '/order_payments/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `order_payment`
    put:
      summary: Update an Order Payment
      operationId: put-order_payments-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_payments'
      tags:
        - Order Payments
      description: Updates an order payment.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_payments'
    delete:
      summary: Delete an Order Payment
      operationId: delete-order_payments-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Order Payments
      description: 'Deletes an order payment. '
  /order_shipments:
    get:
      summary: Get Order Shipments
      tags:
        - Order Shipments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  order_shipments:
                    type: array
                    items:
                      $ref: '#/components/schemas/order_shipments'
      operationId: get-order_shipments
      description: Gets an array of order shipments.
    post:
      summary: Create an Order Shipment
      operationId: post-order_shipments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_shipments'
      tags:
        - Order Shipments
      description: |
        Creates an order shipment.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  order_id: 100297
                  shipped_at: '2021-09-06T00:00:00-05:00'
                  tracking_numbers: '123498776'
                  tracking_url: ''
                  shipping_method: UPS Ground
                  shipping_method_id: 1
                  number_of_packages: null
                  total_weight: null
                  provider_base_shipping_cost: ''
                  provider_insurance_cost: null
                  provider_handling_cost: null
                  provider_other_charges: null
                  provider_total_shipping_cost: null
                  email_sent: false
                  private_comment: ''
                  shipping_comment: ''
                  shipping_method_type: provider
                  shipment_name: '1'
                  shipping_provider_name: UPS
              properties:
                order_id:
                  type: integer
                shipped_at:
                  type: string
                tracking_numbers:
                  type: string
                tracking_url:
                  type: string
                shipping_method:
                  type: string
                shipping_method_id:
                  type: number
                  description: 'The id of the desired shipping method. This can be found by making a GET request to shipping_methods. This will be filled automatically if a valid shippping_method is provided. '
                number_of_packages:
                  type: integer
                total_weight:
                  type: number
                provider_base_shipping_cost:
                  type: string
                provider_insurance_cost:
                  type: number
                provider_handling_cost:
                  type: number
                provider_other_charges:
                  type: number
                provider_total_shipping_cost:
                  type: number
                email_sent:
                  type: boolean
                private_comment:
                  type: string
                shipping_comment:
                  type: string
                shipping_method_type:
                  type: string
                shipment_name:
                  type: string
                shipping_provider_name:
                  type: string
                items:
                  type: array
                  uniqueItems: false
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                      quantity_shipped:
                        type: integer
                      item_nr:
                        type: string
            examples:
              Example:
                value:
                  order_id: 100297
                  shipped_at: '2021-09-06T00:00:00-05:00'
                  tracking_numbers: '123498776'
                  tracking_url: ''
                  shipping_method: UPS Ground
                  shipping_method_id: 1
                  number_of_packages: 1
                  total_weight: 2
                  provider_base_shipping_cost: ''
                  provider_insurance_cost: 0
                  provider_handling_cost: 0
                  provider_other_charges: 0
                  provider_total_shipping_cost: 0
                  email_sent: false
                  private_comment: ''
                  shipping_comment: ''
                  shipping_method_type: provider
                  shipment_name: '1'
                  shipping_provider_name: UPS
                  items:
                    - id: 206
                      quantity_shipped: 1
                      item_ne: 'test1'
  '/order_shipments/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `order_shipment`
    put:
      summary: Update an Order Shipment
      operationId: put-order_shipments-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_shipments'
      tags:
        - Order Shipments
      description: Updates an order shipment.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_shipments'
    delete:
      summary: Delete an Order Shipment
      operationId: delete-order_shipments-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Order Shipments
      description: Deletes an order shipment.
  /order_statuses:
    get:
      summary: Get Order Statuses
      tags:
        - Order Statuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  order_statuses:
                    type: array
                    items:
                      $ref: '#/components/schemas/order_statuses'
      operationId: get-order_statuses
      description: 'Gets an array of order statuses. '
    post:
      summary: Create an Order Status
      operationId: post-order_statuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_statuses'
      tags:
        - Order Statuses
      description: Creates an order status.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Pending Processing
                  is_open: true
                  is_declined: false
                  is_cancelled: false
                  is_shipped: false
                  color: '#A4E065'
                  email_template_id: null
                  is_fully_refunded: false
                  is_partially_refunded: false
                  is_quote_status: false
              properties:
                name:
                  type: string
                is_open:
                  type: boolean
                is_declined:
                  type: boolean
                is_cancelled:
                  type: boolean
                is_shipped:
                  type: boolean
                color:
                  type: string
                email_template_id:
                  type: integer
                is_fully_refunded:
                  type: boolean
                is_partially_refunded:
                  type: boolean
                is_quote_status:
                  type: boolean
                is_partially_shipped:
                  type: boolean
            examples:
              Example:
                value:
                  name: Pending Processing
                  is_open: true
                  is_declined: false
                  is_cancelled: false
                  is_shipped: false
                  color: '#A4E065'
                  email_template_id: 4
                  is_fully_refunded: false
                  is_partially_refunded: false
                  is_quote_status: false
                  is_partially_shipped: false
  '/order_statuses/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `order_status`
    put:
      summary: Update an Order Status
      operationId: put-order_statuses-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_statuses'
      tags:
        - Order Statuses
      description: Updates an order status.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_statuses'
    delete:
      summary: Delete an Order Status
      operationId: delete-order_statuses-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Order Statuses
      description: Deletes an order status.
  /orders:
    get:
      summary: Get Orders
      tags:
        - Orders
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  orders:
                    type: array
                    items:
                      $ref: '#/components/schemas/orders'
      operationId: get-orders
      description: Gets an array of orders.
    post:
      summary: Create an Order
      operationId: post-orders
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orders'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 100232
                  customer_id: 88
                  customer_type_id: 0
                  adcode: ''
                  ordered_at: '2021-05-14T11:09:00-05:00'
                  order_status_id: 10
                  special_instructions: ''
                  subtotal: 4386
                  tax_total: 0
                  shipping_total: 1
                  discount_total: 943
                  grand_total: 3444
                  cost_total: 450
                  selected_shipping_method: Texas
                  ip_address: 71.78.191.26
                  exported_to_accounting_system: 0
                  referrer: ''
                  order_shipping_address_id: 1597
                  order_billing_address_id: 1597
                  admin_comments: 'Combined with order # 100231.'
                  source: '[none]'
                  search_phrase: ''
                  is_ppc: false
                  ppc_keyword: ''
                  store_id: 19
                  session_id: 135414
                  handling_total: 0
                  is_payment_order_only: false
                  selected_shipping_provider_service: '23'
                  additional_fees: 0
                  adcode_id: 0
                  updated_at: '2021-09-22T11:48:18.903-05:00'
                  created_at: '2021-05-14T11:09:20.16-05:00'
                  is_gift: false
                  gift_message: ''
                  public_comments: ''
                  instructions: ''
                  source_group: ''
                  from_subscription_id: null
                  previous_order_status_id: 6
                  order_status_last_changed_at: '2021-05-14T11:09:26.893-05:00'
                  discounted_shipping_total: 1
                  order_number: ''
                  coupon_code: ''
                  order_type: Order
                  expires_at: null
                  expires: false
                  from_quote_id: null
                  campaign_code: ''
                  reward_points_credited: false
                  channel: Online
                  device: None
                  manufacturer_invoice_number: ''
                  manufacturer_invoice_amount: 0
                  manufacturer_invoice_paid: false
                  entered_by: acsupport
                  due_date: null
              properties:
                customer_id:
                  type: integer
                customer_type_id:
                  type: integer
                adcode:
                  type: string
                order_status_id:
                  type: integer
                special_instructions:
                  type: string
                subtotal:
                  type: number
                tax_total:
                  type: number
                shipping_total:
                  type: number
                discount_total:
                  type: number
                grand_total:
                  type: number
                cost_total:
                  type: number
                selected_shipping_method:
                  type: string
                referrer:
                  type: string
                order_shipping_address_id:
                  type: integer
                order_billing_address_id:
                  type: integer
                admin_comments:
                  type: string
                source:
                  type: string
                search_phrase:
                  type: string
                is_ppc:
                  type: boolean
                ppc_keyword:
                  type: string
                store_id:
                  type: integer
                handling_total:
                  type: number
                is_payment_order_only:
                  type: boolean
                selected_shipping_provider_service:
                  type: string
                additional_fees:
                  type: number
                adcode_id:
                  type: integer
                is_gift:
                  type: boolean
                gift_message:
                  type: string
                public_comments:
                  type: string
                instructions:
                  type: string
                source_group:
                  type: string
                from_subscription_id:
                  type: integer
                discounted_shipping_total:
                  type: number
                order_number:
                  type: string
                coupon_code:
                  type: string
                order_type:
                  type: string
                expires_at:
                  type: string
                expires:
                  type: boolean
                from_quote_id:
                  type: integer
                campaign_code:
                  type: string
                reward_points_credited:
                  type: boolean
                channel:
                  type: string
                device:
                  type: string
                manufacturer_invoice_number:
                  type: string
                manufacturer_invoice_amount:
                  type: number
                manufacturer_invoice_paid:
                  type: boolean
                due_date:
                  type: string
                delivery_tax:
                  type: number
                location_id:
                  type: integer
              required:
                - customer_id
                - order_status_id
                - order_shipping_address_id
                - order_billing_address_id
            examples:
              Example:
                value:
                  customer_id: 88
                  customer_type_id: 0
                  adcode: ''
                  ordered_at: '2021-05-14T11:09:00-05:00'
                  order_status_id: 10
                  special_instructions: ''
                  subtotal: 4386
                  tax_total: 0
                  shipping_total: 1
                  discount_total: 943
                  grand_total: 3444
                  cost_total: 450
                  selected_shipping_method: Texas
                  referrer: ''
                  order_shipping_address_id: 1597
                  order_billing_address_id: 1597
                  admin_comments: 'Combined with order # 100231.'
                  source: '[none]'
                  search_phrase: ''
                  is_ppc: false
                  ppc_keyword: ''
                  store_id: 19
                  handling_total: 0
                  is_payment_order_only: false
                  selected_shipping_provider_service: '23'
                  additional_fees: 0
                  adcode_id: 0
                  is_gift: false
                  gift_message: ''
                  public_comments: ''
                  instructions: ''
                  source_group: ''
                  from_subscription_id: null
                  discounted_shipping_total: 1
                  order_number: ''
                  coupon_code: ''
                  order_type: Order
                  expires_at: null
                  expires: false
                  from_quote_id: null
                  campaign_code: ''
                  reward_points_credited: false
                  channel: Online
                  device: None
                  manufacturer_invoice_number: ''
                  manufacturer_invoice_amount: 0
                  manufacturer_invoice_paid: false
                  entered_by: acsupport
                  due_date: null
                  delivery_tax: 0.00
                  location_id: null
      tags:
        - Orders
      description: Creates an order.
  '/orders/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `order`
    put:
      summary: Update an Order
      operationId: put-orders-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orders'
      tags:
        - Orders
      description: Updates an order.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/orders'
    delete:
      summary: Delete an Order
      operationId: delete-orders-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Orders
      description: 'Deletes an order. '
  /pages:
    get:
      summary: Get Pages
      tags:
        - Pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  pages:
                    type: array
                    items:
                      $ref: '#/components/schemas/pages'
              examples: {}
      operationId: get-pages
      description: Gets an array of content pages.
    post:
      summary: Create a Page
      operationId: post-pages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages'
      tags:
        - Pages
      description: Creates a content page.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  title: My Content Page
                  keywords: ''
                  description: ''
                  content: ''
                  is_hidden: false
                  store_id: 19
                  external_url: ''
                  is_content_only: false
                  url_rewrite: /mycontentpage.aspx
                  is_secure: false
                  is_login_required: false
                  head_tags: ''
              properties:
                title:
                  type: string
                keywords:
                  type: string
                description:
                  type: string
                content:
                  type: string
                is_hidden:
                  type: boolean
                store_id:
                  type: integer
                external_url:
                  type: string
                is_content_only:
                  type: boolean
                url_rewrite:
                  type: string
                is_secure:
                  type: boolean
                is_login_required:
                  type: boolean
                head_tags:
                  type: string
              required:
                - store_id
            examples:
              Example:
                value:
                  title: My Content Page
                  keywords: ''
                  description: ''
                  content: ''
                  is_hidden: false
                  store_id: 19
                  external_url: ''
                  is_content_only: false
                  url_rewrite: /mycontentpage.aspx
                  is_secure: false
                  is_login_required: false
                  head_tags: ''
  '/pages/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `page`
    put:
      summary: Update a Page
      operationId: put-pages-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages'
      tags:
        - Pages
      description: Updates a content page.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages'
    delete:
      summary: Delete a Page
      operationId: delete-pages-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Pages
      description: Deletes a content page.
  /payment_methods:
    get:
      summary: Get Payment Methods
      tags:
        - Payment Methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  payment_methods:
                    type: array
                    items:
                      $ref: '#/components/schemas/payment_methods'
      operationId: get-payment_methods
      description: Gets an array of payment methods.
    post:
      summary: Create a Payment Method
      operationId: post-payment_methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_methods'
      tags:
        - Payment Methods
      description: Creates a payment method.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  payment_type: Custom
                  cost_modifier: 0
                  cost_modifier_type: Percent
                  sort_order: 0
                  is_hidden: false
                  description: ''
                  confirmation_message: ''
                  declined_message: ''
                  is_gateway: false
                  gateway_name: ''
                  name: IOU
              properties:
                payment_type:
                  type: string
                cost_modifier:
                  type: number
                cost_modifier_type:
                  type: string
                sort_order:
                  type: number
                is_hidden:
                  type: boolean
                description:
                  type: string
                confirmation_message:
                  type: string
                declined_message:
                  type: string
                is_gateway:
                  type: boolean
                gateway_name:
                  type: string
                name:
                  type: string
            examples:
              Example:
                value:
                  payment_type: Custom
                  cost_modifier: 0
                  cost_modifier_type: Percent
                  sort_order: 0
                  is_hidden: false
                  description: ''
                  confirmation_message: ''
                  declined_message: ''
                  is_gateway: false
                  gateway_name: ''
                  name: IOU
  '/payment_methods/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `payment_method`
    put:
      summary: Update a Payment Method
      operationId: put-payment_methods-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_methods'
              examples: {}
      description: Updates a payment method.
      tags:
        - Payment Methods
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  payment_type: Custom
                  cost_modifier: 0
                  cost_modifier_type: Percent
                  sort_order: 0
                  is_hidden: false
                  description: ''
                  confirmation_message: ''
                  declined_message: ''
                  is_gateway: false
                  gateway_name: ''
                  name: IOU
              properties:
                id: 
                  type: integer
                payment_type:
                  type: string
                cost_modifier:
                  type: number
                cost_modifier_type:
                  type: string
                sort_order:
                  type: integer
                is_hidden:
                  type: boolean
                description:
                  type: string
                confirmation_message:
                  type: string
                declined_message:
                  type: string
                is_gateway:
                  type: boolean
                gateway_name:
                  type: string
                name:
                  type: string
            examples:
              Example:
                value:
                  id: 1
                  payment_type: Custom
                  cost_modifier: 0
                  cost_modifier_type: Percent
                  sort_order: 0
                  is_hidden: false
                  description: ''
                  confirmation_message: ''
                  declined_message: ''
                  is_gateway: false
                  gateway_name: ''
                  name: IOU
        description: ''
    delete:
      summary: Delete a Payment Method
      operationId: delete-payment_methods-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Payment Methods
      description: Delete a payment method.
  /price_calculator_rule_modifiers:
    get:
      summary: Get Price Calculator Rule Modifiers
      tags:
        - Price Calculator Rule Modifiers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  price_calculator_rule_modifiers:
                    type: array
                    items:
                      $ref: '#/components/schemas/price_calculator_rule_modifiers'
      operationId: get-price_calculator_rule_modifiers
      description: Gets an array of price calculator rule modifiers.
    post:
      summary: Create a Price Calculator Rule Modifier
      operationId: post-price_calculator_rule_modifiers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price_calculator_rule_modifiers'
      tags:
        - Price Calculator Rule Modifiers
      description: Create a Price Calculator Rule Modifiers
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  price_calculator_rule_id: 5
                  action: Add
                  value: -2
                  modifier_type: Dollars
                  optional_value: null
                  optional_modifier_type: Dollars
                  sort_order: 0
                  description: ''
                  optional_action: None
              properties:
                price_calculator_rule_id:
                  type: integer
                action:
                  type: string
                value:
                  type: number
                modifier_type:
                  type: string
                optional_value:
                  type: number
                optional_modifier_type:
                  type: string
                sort_order:
                  type: integer
                description:
                  type: string
                optional_action:
                  type: string
              required:
                - price_calculator_rule_id
            examples:
              Example:
                value:
                  price_calculator_rule_id: 5
                  action: Add
                  value: -2
                  modifier_type: Dollars
                  optional_value: 0
                  optional_modifier_type: Dollars
                  sort_order: 0
                  description: ''
                  optional_action: None
  '/price_calculator_rule_modifiers/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `price_calculator_rule_modifier`
    put:
      summary: Update a Price Calculator Rule Modifier
      operationId: put-price_calculator_rule_modifier-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price_calculator_rule_modifiers'
      tags:
        - Price Calculator Rule Modifiers
      description: Updates a price calculator rule modifier.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/price_calculator_rule_modifiers'
    delete:
      summary: Delete a Price Calculator Rule Modifier
      operationId: delete-price_calculator_rule_modifier-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Price Calculator Rule Modifiers
      description: Delete a price calculator rule modifier.
  /price_calculators:
    get:
      summary: Get Price Calculators
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  price_calculators:
                    type: array
                    items:
                      $ref: '#/components/schemas/price_calculators'
      operationId: get-price_calculators
      tags:
        - Price Calculators
      description: Gets an array of price calculators.
    post:
      summary: Create a Price Calculator
      operationId: post-price_calculators
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price_calculators'
      tags:
        - Price Calculators
      description: Creates a price calculator.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  calculation_name: test
                  description: ''
                  item_numbers_regex: ''
              properties:
                calculation_name:
                  type: string
                description:
                  type: string
                item_numbers_regex:
                  type: string
              required:
                - calculation_name
            examples:
              Example:
                value:
                  calculation_name: 10% Off Calculator
                  description: ''
                  item_numbers_regex: .*
  '/price_calculators/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `price_calculator`
    put:
      summary: Update a Price Calculator
      operationId: put-price_calculators-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price_calculators'
      tags:
        - Price Calculators
      description: Updates a price calculator.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/price_calculators'
    delete:
      summary: Delete a Price Calculator
      operationId: delete-price_calculators-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Price Calculators
      description: Deletes a price calculator.
  /product_inactive_in_store:
    get:
      summary: Get Products Inactive in Store
      tags:
        - Product Inactive In Store
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_inactive_in_store:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_inactive_in_store'
      operationId: get-product_inactive_in_store
      description: Gets an array of products inactive in store.
    post:
      summary: Create a Product Inactive in Store
      operationId: post-product_inactive_in_store
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_inactive_in_store'
      tags:
        - Product Inactive In Store
      description: Marks a product inactive in store.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                item_id:
                  type: integer
                store_id:
                  type: integer
                customer_type_id:
                  type: integer
              required:
                - item_id
                - store_id
            examples:
              Example:
                value:
                  item_id: 12
                  store_id: 1
                  customer_type_id: 0
        description: ''
  '/product_inactive_in_store/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `product_inactive_in_store`
    put:
      summary: Update a Product Inactive in Store
      operationId: put-product_inactive_in_store-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_inactive_in_store'
      tags:
        - Product Inactive In Store
      description: Updates a product inactive in store.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_inactive_in_store'
    delete:
      summary: Delete a Product Inactive in Store
      operationId: delete-product_inactive_in_store-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Product Inactive In Store
      description: Delete a product inactive in store.
  /product_lists:
    get:
      summary: Get Product Lists
      tags:
        - Product Lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_lists:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_lists'
      operationId: get-product_lists
      description: Gets an array of product lists.
      parameters:
        - schema:
            type: string
          in: query
          name: '?expand=items'
    post:
      summary: Create a Product List
      operationId: post-product_lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_lists'
      tags:
        - Product Lists
      description: Creates a product list.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
              required:
                - name
              x-examples:
                example-1:
                  name: DiscountTest
            examples:
              Example:
                value:
                  name: My Product List
        description: ''
  '/product_lists/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `product_list`
    put:
      summary: Update a Product List
      operationId: put-product_lists-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_lists'
      tags:
        - Product Lists
      description: Updates a product list.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_lists'
    delete:
      summary: Delete a Product List
      operationId: delete-product_lists-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Product Lists
      description: Delete a product list.
  /price_calculator_rules:
    get:
      summary: Get Price Calculator Rules
      tags:
        - Price Calculator Rules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  price_calculator_rules:
                    type: array
                    items:
                      $ref: '#/components/schemas/price_calculator_rules'
      operationId: get-price_calculator_rules
      description: Gets an array of price calculator rules.
    post:
      summary: Create a Price Calculator Rule
      operationId: post-price_calculator_rules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price_calculator_rules'
      tags:
        - Price Calculator Rules
      description: Creates a price calculator rule.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  price_calculator_id: 3
                  customer_type_id: 1
                  store_id: 2
                  starting_quantity: 5
                  price_base_type: BasePricePassedIn
                  specific_base_price: 0
              properties:
                price_calculator_id:
                  type: integer
                customer_type_id:
                  type: integer
                store_id:
                  type: integer
                starting_quantity:
                  type: number
                price_base_type:
                  type: string
                specific_base_price:
                  type: number
            examples:
              Example:
                value:
                  price_calculator_id: 3
                  customer_type_id: 1
                  store_id: 2
                  starting_quantity: 5
                  price_base_type: BasePricePassedIn
                  specific_base_price: 0
  '/price_calculator_rules/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `price_calculator_rule`
    put:
      summary: Update a Price Calculator Rule
      operationId: put-price_calculator_rules-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price_calculator_rules'
      tags:
        - Price Calculator Rules
      description: Updates a price calculator rule.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/price_calculator_rules'
    delete:
      summary: Delete a Price Calculator Rule
      operationId: delete-price_calculator_rules-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Price Calculator Rules
      description: Deletes a price calculator rule.
  /product_pictures:
    get:
      summary: Get Product Pictures
      tags:
        - Product Pictures
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_pictures:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_pictures'
      operationId: get-product_pictures
      description: Gets an array of product pictures.
    post:
      summary: Add a Product Picture
      operationId: post-product_pictures
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_pictures'
      tags:
        - Product Pictures
      description: Adds a picture to a product.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 48
                  image_file: /shared/images/product.png
                  alt: product photo
                  description: ''
                  is_primary: true
                  is_hidden: false
                  thumbnail_file: ''
                  sort_order: 0
                  flash_path: ''
                  is_video_screen_shot: false
                  video_content: ''
                  download_external_image: false
              properties:
                product_id:
                  type: integer
                image_file:
                  type: string
                alt:
                  type: string
                description:
                  type: string
                is_primary:
                  type: boolean
                is_hidden:
                  type: boolean
                thumbnail_file:
                  type: string
                sort_order:
                  type: integer
                flash_path:
                  type: string
                is_video_screen_shot:
                  type: boolean
                video_content:
                  type: string
                download_external_image:
                  type: boolean
              required:
                - product_id
                - image_file
            examples:
              Example:
                value:
                  product_id: 48
                  image_file: /shared/images/product.png
                  alt: product photo
                  description: ''
                  is_primary: true
                  is_hidden: false
                  thumbnail_file: ''
                  sort_order: 0
                  flash_path: ''
                  is_video_screen_shot: false
                  video_content: ''
                  download_external_image: false
          application/xml:
            schema:
              type: object
              properties: {}
        description: ''
  '/product_pictures/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `product_picture`
    put:
      summary: Update a Product Picture
      operationId: put-product_pictures-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_pictures'
      tags:
        - Product Pictures
      description: Updates a product picture.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_pictures'
    delete:
      summary: Delete a Product Picture
      operationId: delete-product_pictures-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a product picture.
      tags:
        - Product Pictures
  /product_pricing:
    get:
      summary: Get Product Pricing
      tags:
        - Product Pricing
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: string
                  product_pricing:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_pricing'
              examples:
                example-1:
                  value:
                    total_count: string
                    product_pricing:
                      - id: 0
                        product_id: 0
                        store_id: 0
                        customer_type_id: 0
                        variant_inventory_id: 0
                        sale_type_id: 0
                        start_date: string
                        end_date: string
                        starting_quantity: 0
                        price: 0
                        cost: 0
                        updated_at: string
                        created_at: string
                        price_calculation_id: 0
                        variant_id: 0
                        variant_price_surcharge: string
      operationId: get-product_pricing
      description: Gets an array of product pricing.
    post:
      summary: Add Product Pricing
      operationId: post-product_pricing
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_pricing'
      tags:
        - Product Pricing
      description: Add a price to a product.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 24
                  store_id: 1
                  customer_type_id: 24
                  variant_inventory_id: 254
                  sale_type_id: null
                  start_date: ''
                  end_date: ''
                  starting_quantity: 72
                  price: 29.1666
                  cost: 16.6666
                  price_calculation_id: null
                  variant_id: null
                  variant_price_surcharge: ''
              properties:
                product_id:
                  type: integer
                store_id:
                  type: integer
                customer_type_id:
                  type: integer
                variant_inventory_id:
                  type: integer
                sale_type_id:
                  type: integer
                start_date:
                  type: string
                end_date:
                  type: string
                starting_quantity:
                  type: number
                price:
                  type: number
                cost:
                  type: number
                price_calculation_id:
                  type: integer
                variant_id:
                  type: integer
                variant_price_surcharge:
                  type: string
              required:
                - product_id
  '/product_pricing/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `product_pricing`
    put:
      summary: Update a Product Price
      operationId: put-product_pricing-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_pricing'
      tags:
        - Product Pricing
      description: Updates a product price.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_pricing'
    delete:
      summary: Delete a Product Price
      operationId: delete-product_pricing-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Product Pricing
      description: Deletes a product price.
  /product_reviews:
    get:
      summary: Get Product Reviews
      tags:
        - Product Reviews
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_revies:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_reviews'
      operationId: get-product_reviews
      description: Gets an array of product reviews.
    post:
      summary: Create a Product Review
      operationId: post-product_reviews
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_reviews'
      tags:
        - Product Reviews
      description: Creates a product review.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 31
                  title: Title Test
                  body: Noice
                  review_pros: ''
                  review_cons: ''
                  overall_rating: 5
                  customer_id: null
                  approved_by_user_id: null
                  approved_at: null
                  author_display_name: Display Name
                  author_email: asmith@americommerce.com
                  author_website: ''
                  author_location: ''
                  approval_status: Approved
                  origin_store_id: 1
                  profile_id: null
                  uploaded_image: ''
                  published_date: "2023-08-18T09:01:47.38-05:00"
              properties:
                product_id:
                  type: integer
                title:
                  type: string
                body:
                  type: string
                review_pros:
                  type: string
                review_cons:
                  type: string
                overall_rating:
                  type: number
                customer_id:
                  type: integer
                approved_by_user_id:
                  type: integer
                approved_at:
                  type: string
                author_display_name:
                  type: string
                author_email:
                  type: string
                author_website:
                  type: string
                author_location:
                  type: string
                approval_status:
                  type: string
                origin_store_id:
                  type: integer
                profile_id:
                  type: integer
                uploaded_image:
                  type: string
                published_date:
                  type: string
            examples:
              Example:
                value:
                  id: 13
                  product_id: 31
                  title: 5 Star Product
                  body: This is noice.
                  review_pros: ''
                  review_cons: ''
                  overall_rating: 5
                  customer_id: 2
                  approved_by_user_id: 1
                  approved_at: ''
                  author_display_name: Walter White
                  author_email: admin@email.com
                  author_website: ''
                  author_location: ''
                  approval_status: Approved
                  origin_store_id: 1
                  profile_id: 45
                  uploaded_image: ''
                  published_date: "2023-08-18T09:01:47.38-05:00"
  '/product_reviews/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `product_review`
    put:
      summary: Update a Product Review
      operationId: put-product_reviews-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_reviews'
      tags:
        - Product Reviews
      description: Updates a product review.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_reviews'
    delete:
      summary: Delete a Product Review
      operationId: delete-product_reviews-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Product Reviews
      description: Deletes a product review.
  /product_statuses:
    get:
      summary: Product Statuses
      tags:
        - Product Statuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_statuses:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_statuses'
      operationId: get-product_statuses
      description: Gets an arary of product statuses
    post:
      summary: Create a Product Status
      operationId: post-product_statuses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_statuses'
      description: Creates a product status.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: In Stock
                  time_frame: 1-2 Business Days
                  is_unavailable: false
                  is_hidden: false
                  is_back_ordered: true
                  show_quantity: false
              properties:
                name:
                  type: string
                time_frame:
                  type: string
                is_unavailable:
                  type: boolean
                is_hidden:
                  type: boolean
                is_back_ordered:
                  type: boolean
                show_quantity:
                  type: boolean
              required:
                - name
            examples:
              Example:
                value:
                  name: In Stock
                  time_frame: 1-2 Business Days
                  is_unavailable: false
                  is_hidden: false
                  is_back_ordered: true
                  show_quantity: false
      tags:
        - Product Statuses
  '/product_statuses/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `product_status`
    put:
      summary: Update a Product Status
      operationId: put-product_statuses-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_statuses'
      tags:
        - Product Statuses
      description: Updates a product status.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_statuses'
    delete:
      summary: Delete a Product Status
      operationId: delete-product_statuses-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Product Statuses
      description: Deletes a product status.
  /product_variants:
    get:
      summary: Get Product Variants
      tags:
        - Product Variants
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_variants:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_variants'
      operationId: get-product_variants
      description: Gets an array of product variants.
    post:
      summary: Create a Product Variant
      operationId: post-product_variants
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_variants'
      tags:
        - Product Variants
      description: Creates a product variant.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 32
                  variant_group_id: 4
                  description: Cart.com Blue
                  price_adjustment: 0
                  price_adjustment_type: total
                  sort_order: 0
                  item_number_extension: '101520'
                  is_hidden: false
                  weight: 1.000
                  weight_type: '+'
                  is_default_selection: true
                  swatch_file: ''
                  swatch_thumbnail: /images/blue.jpg
                  swatch_thumbnail_color: ''
              properties:
                product_id:
                  type: integer
                variant_group_id:
                  type: integer
                description:
                  type: string
                price_adjustment:
                  type: number
                price_adjustment_type:
                  type: string
                sort_order:
                  type: integer
                item_number_extension:
                  type: string
                item_number_sort_order:
                  type: integer
                  default: 0
                  minimum: 0
                weight:
                  type: number
                weight_type:
                  type: string
                is_hidden:
                  type: boolean
                is_default_selection:
                  type: boolean
                swatch_file:
                  type: string
                swatch_thumbnail:
                  type: string
                swatch_thumbnail_color:
                  type: string
              required:
                - product_id
                - variant_group_id
            examples:
              Example:
                value:
                  product_id: 32
                  variant_group_id: 4
                  description: Cart.com Blue
                  price_adjustment: 0
                  price_adjustment_type: total
                  sort_order: 0
                  item_number_extension: '101520'
                  is_hidden: false
                  weight: 1.000
                  weight_type: '+'
                  is_default_selection: true
                  swatch_file: ''
                  swatch_thumbnail: /images/blue.jpg
                  swatch_thumbnail_color: ''
  '/product_variants/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `product_variant`
    put:
      summary: Update a Product Variant
      operationId: put-product_variants-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_variants'
      tags:
        - Product Variants
      description: Updates a product variant.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_variants'
    delete:
      summary: Delete a Product Variant
      operationId: delete-product_variants-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Product Variants
      description: Deletes a product variant.
  /products:
    get:
      summary: Get Products
      tags:
        - Products
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  products:
                    type: array
                    items:
                      $ref: '#/components/schemas/products'
      operationId: get-products
      description: Gets an array of products.
    post:
      summary: Create a Product
      operationId: post-products
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/products'
      tags:
        - Products
      description: Creates a product.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  id: 112
                  item_number: NCC-1701-C
                  manufacturer_id: 0
                  manufacturer_part_number: ''
                  primary_category_id: 47
                  product_status_id: 1
                  item_name: Not a Flame Thrower
                  bullets: ''
                  short_description: ''
                  long_description_2: ''
                  long_description_3: ''
                  long_description_4: ''
                  long_description_5: ''
                  height: ''
                  length: ''
                  width: ''
                  size_unit: In
                  weight: 0
                  weight_unit: Lbs
                  cost: 0
                  price: 55
                  retail: 56
                  minimum_quantity: 0
                  maximum_quantity: 0
                  is_spotlight_item: 0
                  quantity_on_hand: 20000
                  keywords: ''
                  is_non_taxable: 0
                  is_shipped_individually: 0
                  is_hidden: 0
                  sort_order: 0
                  e_product_type: NotAnEProduct
                  e_product_url: ''
                  e_product_password: ''
                  e_product_verification_link_expiration: 0
                  e_product_email: ''
                  e_product_allow_multiple_deliveries: 0
                  warehouse_id: 5
                  call_for_shipping: 0
                  quickbooks_item_id: ''
                  call_for_pricing: 0
                  rate_adjustment_type: AutoCalculation
                  meta_description: ''
                  page_title: ''
                  use_tabs: false
                  related_name: ''
                  override_theme_use_tabs: false
                  long_description_tab_name_1: ''
                  long_description_tab_name_2: ''
                  long_description_tab_name_3: ''
                  long_description_tab_name_4: ''
                  long_description_tab_name_5: ''
                  long_description_1: <p>this is the description</p>
                  is_non_shipping_item: false
                  e_product_delivery_action: null
                  use_variant_inventory: false
                  is_featured_item: false
                  long_description_external_url_1: ''
                  long_description_external_url_2: ''
                  long_description_external_url_3: ''
                  long_description_external_url_4: ''
                  long_description_external_url_5: ''
                  bullets_external_url: ''
                  custom_flag_1: false
                  custom_flag_2: false
                  custom_flag_3: false
                  custom_flag_4: false
                  custom_flag_5: false
                  url_rewrite: /not-a-flame-thrower.aspx
                  is_kit: false
                  is_child_product: true
                  is_non_inventory: false
                  is_discontinued: false
                  eta_date: null
                  quantity_on_order: 0
                  available_region_id: null
                  call_for_shipping_on_whole_order: false
                  break_out_shipping: false
                  shipping_classification_code: ''
                  exclude_parent_from_display: true
                  drop_ship: true
                  no_price_mask: ''
                  starting_quantity: 1
                  tax_code: ''
                  use_map_pricing: false
                  last_item_number: ''
                  has_visible_variants: false
                  product_rating_dimension_group_override_id: null
                  average_review_rating: null
                  review_count: null
                  exclude_children_from_display: false
                  use_pricing_from_parent: false
                  low_stock_warning_threshold: null
                  enable_low_stock_warning: false
                  do_not_discount: false
                  head_tags: ''
                  handling_fee: 0
                  custom_upsell_url: ''
                  e_product_serial_number_file_path: ''
                  hide_variant_surcharges: false
                  quantity_increment: 1
                  gtin: ''
                  add_to_cart_message: ''
                  is_subscription_product: false
                  subscription_frequency: null
                  subscription_frequency_type: ''
                  e_product_generic_username: ''
                  e_product_generic_password: ''
                  shipping_override: null
                  insurance_cost: null
                  exclude_from_commissions: false
                  days_until_reorder_allowed: 0
                  force_separate_order: false
                  approval_required: false
                  in_stock_notification_email_template_id: 0
                  earns_points: false
                  additional_points_earned: 0
                  allowed_variable_subscription_types: ''
                  profile_id: null
                  is_linked_product: false
                  master_product_id: null
                  do_not_send_review_request: false
              properties:
                item_number:
                  type: string
                manufacturer_id:
                  type: integer
                manufacturer_part_number:
                  type: string
                primary_category_id:
                  type: integer
                product_status_id:
                  type: integer
                item_name:
                  type: string
                bullets:
                  type: string
                short_description:
                  type: string
                long_description_2:
                  type: string
                long_description_3:
                  type: string
                long_description_4:
                  type: string
                long_description_5:
                  type: string
                height:
                  type: string
                length:
                  type: string
                width:
                  type: string
                size_unit:
                  type: string
                weight:
                  type: number
                weight_unit:
                  type: string
                cost:
                  type: number
                price:
                  type: number
                retail:
                  type: number
                minimum_quantity:
                  type: integer
                maximum_quantity:
                  type: integer
                is_spotlight_item:
                  type: integer
                quantity_on_hand:
                  type: integer
                keywords:
                  type: string
                is_non_taxable:
                  type: integer
                is_shipped_individually:
                  type: integer
                is_hidden:
                  type: integer
                sort_order:
                  type: integer
                e_product_type:
                  type: string
                e_product_url:
                  type: string
                e_product_password:
                  type: string
                e_product_verification_link_expiration:
                  type: integer
                e_product_email:
                  type: string
                e_product_allow_multiple_deliveries:
                  type: integer
                warehouse_id:
                  type: integer
                call_for_shipping:
                  type: integer
                quickbooks_item_id:
                  type: string
                call_for_pricing:
                  type: integer
                rate_adjustment_type:
                  type: string
                meta_description:
                  type: string
                page_title:
                  type: string
                use_tabs:
                  type: boolean
                related_name:
                  type: string
                override_theme_use_tabs:
                  type: boolean
                long_description_tab_name_1:
                  type: string
                long_description_tab_name_2:
                  type: string
                long_description_tab_name_3:
                  type: string
                long_description_tab_name_4:
                  type: string
                long_description_tab_name_5:
                  type: string
                long_description_1:
                  type: string
                is_non_shipping_item:
                  type: boolean
                e_product_delivery_action:
                  type: string
                use_variant_inventory:
                  type: boolean
                is_featured_item:
                  type: boolean
                long_description_external_url_1:
                  type: string
                long_description_external_url_2:
                  type: string
                long_description_external_url_3:
                  type: string
                long_description_external_url_4:
                  type: string
                long_description_external_url_5:
                  type: string
                bullets_external_url:
                  type: string
                custom_flag_1:
                  type: boolean
                custom_flag_2:
                  type: boolean
                custom_flag_3:
                  type: boolean
                custom_flag_4:
                  type: boolean
                custom_flag_5:
                  type: boolean
                url_rewrite:
                  type: string
                is_kit:
                  type: boolean
                is_child_product:
                  type: boolean
                is_non_inventory:
                  type: boolean
                is_discontinued:
                  type: boolean
                eta_date:
                  type: string
                quantity_on_order:
                  type: integer
                available_region_id:
                  type: integer
                call_for_shipping_on_whole_order:
                  type: boolean
                break_out_shipping:
                  type: boolean
                shipping_classification_code:
                  type: string
                exclude_parent_from_display:
                  type: boolean
                drop_ship:
                  type: boolean
                no_price_mask:
                  type: string
                starting_quantity:
                  type: integer
                tax_code:
                  type: string
                use_map_pricing:
                  type: boolean
                last_item_number:
                  type: string
                has_visible_variants:
                  type: boolean
                product_rating_dimension_group_override_id:
                  type: integer
                average_review_rating:
                  type: number
                review_count:
                  type: integer
                exclude_children_from_display:
                  type: boolean
                use_pricing_from_parent:
                  type: boolean
                low_stock_warning_threshold:
                  type: integer
                enable_low_stock_warning:
                  type: boolean
                do_not_discount:
                  type: boolean
                head_tags:
                  type: string
                handling_fee:
                  type: number
                custom_upsell_url:
                  type: string
                e_product_serial_number_file_path:
                  type: string
                hide_variant_surcharges:
                  type: boolean
                quantity_increment:
                  type: integer
                gtin:
                  type: string
                add_to_cart_message:
                  type: string
                is_subscription_product:
                  type: boolean
                subscription_frequency:
                  type: integer
                subscription_frequency_type:
                  type: string
                e_product_generic_username:
                  type: string
                e_product_generic_password:
                  type: string
                shipping_override:
                  type: number
                insurance_cost:
                  type: number
                exclude_from_commissions:
                  type: boolean
                days_until_reorder_allowed:
                  type: integer
                force_separate_order:
                  type: boolean
                approval_required:
                  type: boolean
                in_stock_notification_email_template_id:
                  type: integer
                earns_points:
                  type: boolean
                additional_points_earned:
                  type: integer
                allowed_variable_subscription_types:
                  type: string
                profile_id:
                  type: integer
                is_linked_product:
                  type: boolean
                master_product_id:
                  type: integer
                do_not_send_review_request:
                  type: boolean
                pack_slip_sort_order:
                  type: integer
                is_enable_variants_on_parent:
                  type: boolean
                is_hide_children_on_parent:
                  type: boolean
                cart_product_id:
                  type: guid
                enabled_configurator:
                  type: string
                material_code:
                  type: string
                product_line_code:
                  type: string
                ext_update_date:
                  type: string
                additional_attributes:
                  type: string
                shipper_hq_shipping_groups:
                  type: string
                shipper_hq_dimensional_rule_groups:
                  type: string
                shipper_hq_packing_boxes:
                  type: string
                freight_class:
                  type: string
                hs_code:
                  type: string
                coo:
                  type: string
                hts:
                  type: string
                is_exempt_from_min_order_amount:
                  type: boolean
                category_list:
                  type: string
              required:
                - primary_category_id
                - product_status_id
                - item_name
                - price
                - long_description_tab_name_5
  '/products/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `product`
    put:
      summary: Update a Product
      operationId: put-products-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/products'
      tags:
        - Products
      description: Updates a product.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/products'
    delete:
      summary: Delete a Product
      operationId: delete-products-id
      description: Deletes a product.
      tags:
        - Products
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
  /profiles:
    get:
      summary: Get Profiles
      tags:
        - Profiles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  profiles:
                    type: array
                    items:
                      $ref: '#/components/schemas/profiles'
      operationId: get-profiles
      description: Gets an array of profiles.
    post:
      summary: Create a Profile
      operationId: post-profiles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/profiles'
      description: Creates a Profile
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  email: email@email.com
                  username: admin
                  type: User
                  real_name: ''
                  display_name: MyDisplayName
                  about: ''
                  image_url: ''
                  company: ''
              properties:
                email:
                  type: string
                username:
                  type: string
                type:
                  type: string
                real_name:
                  type: string
                display_name:
                  type: string
                about:
                  type: string
                image_url:
                  type: string
                company:
                  type: string
              required:
                - username
              examples:
                Example:
                  value:
                    email: email@email.com
                    username: admin
                    type: User
                    real_name: ''
                    display_name: MyDisplayName
                    about: ''
                    image_url: ''
                    company: ''
      tags:
        - Profiles
  '/profiles/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `profile`
    put:
      summary: Update a Profile
      operationId: put-profiles-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/profiles'
      tags:
        - Profiles
      description: Updates a profile.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/profiles'
            examples:
              Example:
                value:
                  email: email@email.com
                  username: admin
                  type: User
                  real_name: ''
                  display_name: MyDisplayName
                  about: ''
                  image_url: ''
                  company: ''
    delete:
      summary: Delete a Profile
      operationId: delete-profiles-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Profiles
      description: Deletes a profile.
  /quotes:
    get:
      summary: Get Quotes
      tags:
        - Quotes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  quotes:
                    type: array
                    items:
                      $ref: '#/components/schemas/quotes'
      operationId: get-quotes
      description: Gets an array of quotes.
    post:
      summary: Create a Quote
      operationId: post-quotes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/quotes'
      tags:
        - Quotes
      description: Creates a quote.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  customer_id: 12
                  customer_type_id: 0
                  adcode: ''
                  order_status_id: 7
                  special_instructions: ''
                  subtotal: 0
                  tax_total: 0
                  shipping_total: 0
                  discount_total: 0
                  grand_total: 0
                  cost_total: 0
                  selected_shipping_method: ''
                  order_shipping_address_id: 7
                  order_billing_address_id: 7
                  admin_comments: ''
                  store_id: 1
                  handling_total: 0
                  is_payment_order_only: false
                  selected_shipping_provider_service: ''
                  additional_fees: 0
                  adcode_id: 0
                  is_gift: false
                  gift_message: ''
                  public_comments: ''
                  instructions: ''
                  from_subscription_id: null
                  previous_order_status_id: 7
                  discounted_shipping_total: 0
                  order_number: null
                  coupon_code: ''
                  order_type: Quote
                  expires_at: null
                  expires: false
                  campaign_code: ''
                  reward_points_credited: false
                  manufacturer_invoice_number: null
                  manufacturer_invoice_amount: null
                  manufacturer_invoice_paid: false
                  due_date: null
              properties:
                customer_id:
                  type: integer
                customer_type_id:
                  type: integer
                adcode:
                  type: string
                order_status_id:
                  type: integer
                special_instructions:
                  type: string
                subtotal:
                  type: number
                tax_total:
                  type: number
                shipping_total:
                  type: number
                discount_total:
                  type: number
                grand_total:
                  type: number
                cost_total:
                  type: number
                selected_shipping_method:
                  type: integer
                order_shipping_address_id:
                  type: number
                order_billing_address_id:
                  type: integer
                admin_comments:
                  type: string
                store_id:
                  type: integer
                handling_total:
                  type: number
                is_payment_order_only:
                  type: boolean
                selected_shipping_provider_service:
                  type: string
                additional_fees:
                  type: number
                adcode_id:
                  type: integer
                is_gift:
                  type: boolean
                gift_message:
                  type: string
                public_comments:
                  type: string
                instructions:
                  type: string
                discounted_shipping_total:
                  type: number
                order_number:
                  type: string
                coupon_code:
                  type: string
                order_type:
                  type: string
                expires_at:
                  type: string
                expires:
                  type: boolean
                campaign_code:
                  type: string
                reward_points_credited:
                  type: boolean
                manufacturer_invoice_number:
                  type: string
                manufacturer_invoice_amount:
                  type: number
                manufacturer_invoice_paid:
                  type: boolean
                sales_agent_user_id:
                  type: integer
                due_date:
                  type: string
                delivery_tax:
                  type: number
                location_id:
                  type: integer
              required:
                - customer_id
                - order_status_id
                - tax_total
                - grand_total
                - order_billing_address_id
                - store_id
            examples:
              Example:
                value:
                  customer_id: 12
                  customer_type_id: 0
                  adcode: ''
                  order_status_id: 7
                  special_instructions: ''
                  subtotal: 0
                  tax_total: 0
                  shipping_total: 0
                  discount_total: 0
                  grand_total: 0
                  cost_total: 0
                  selected_shipping_method: 1
                  order_shipping_address_id: 7
                  order_billing_address_id: 7
                  admin_comments: ''
                  store_id: 1
                  handling_total: 0
                  is_payment_order_only: false
                  selected_shipping_provider_service: ''
                  additional_fees: 0
                  adcode_id: 0
                  is_gift: false
                  gift_message: ''
                  public_comments: ''
                  instructions: ''
                  discounted_shipping_total: 0
                  coupon_code: ''
                  order_type: Quote
                  expires_at: ''
                  expires: false
                  campaign_code: ''
                  reward_points_credited: false
                  manufacturer_invoice_number: ''
                  manufacturer_invoice_amount: 0
                  manufacturer_invoice_paid: false
                  sales_agent_user_id: 0
                  due_date: ''
                  delivery_tax: 0.00
                  location_id: null
  '/quotes/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `quote`
    put:
      summary: Update a Quote
      operationId: put-quotes-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/quotes'
      tags:
        - Quotes
      description: Updates a quote.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/quotes'
    delete:
      summary: Delete a Quote
      operationId: delete-quotes-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Quotes
      description: Deletes a quote.
  /regions:
    get:
      summary: Get Regions
      tags:
        - Regions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  regions:
                    type: array
                    items:
                      $ref: '#/components/schemas/regions'
      operationId: get-regions
      description: Gets an array of regions.
    post:
      summary: Create a Region
      operationId: post-regions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/regions'
      tags:
        - Regions
      description: Creates a region.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  postal_codes: []
                  name: OCONUS
                  states:
                    - Alaska
                    - Hawaii
                  countries: []
                  markup_type: Percent
                  markup_amount: 5
                  sort_order: 1
                  region_type: ZipcodeState
                  postal_code_country: null
                  is_shipping_region: true
                  is_tax_region: false
              properties:
                postal_codes:
                  type: array
                  items:
                    type: object
                name:
                  type: string
                states:
                  type: array
                  items:
                    type: object
                countries:
                  type: array
                  items:
                    type: object
                markup_type:
                  type: string
                  description: The default is `Percent`
                markup_amount:
                  type: number
                sort_order:
                  type: integer
                region_type:
                  type: string
                postal_code_country:
                  type: string
                is_shipping_region:
                  type: boolean
                is_tax_region:
                  type: boolean
              required:
                - markup_amount
                - sort_order
            examples:
              Example:
                value:
                  postal_codes: []
                  name: OCONUS
                  states:
                    - Alaska
                    - Hawaii
                  countries: []
                  markup_type: Percent
                  markup_amount: 5
                  sort_order: 1
                  updated_at: '2021-10-07T12:58:11.533-05:00'
                  created_at: '2021-10-07T12:58:11.533-05:00'
                  region_type: ZipcodeState
                  postal_code_country: ''
                  is_shipping_region: true
                  is_tax_region: false
        description: ''
  '/regions/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `region`
    put:
      summary: Update a Region
      operationId: put-regions-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/regions'
      tags:
        - Regions
      description: Updates a region.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/regions'
    delete:
      summary: Delete a Region
      operationId: delete-regions-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Regions
      description: Deletes a region.
  /sessions:
    get:
      summary: Get Sessions
      tags:
        - Sessions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  sessions:
                    type: array
                    items:
                      $ref: '#/components/schemas/sessions'
      operationId: get-sessions
      description: Gets an array of sessions.
  /shipping_providers:
    get:
      summary: Get Shipping Providers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shipping_providers'
      operationId: get-shipping_providers
      tags:
        - Shipping Providers
      description: Gets an array of shipping providers.
  '/shipping_providers/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `shipping_provider`
    put:
      summary: Update a Shipping Provider
      operationId: put-shipping_providers-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shipping_providers'
      tags:
        - Shipping Providers
      description: Updates a shipping provider.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shipping_providers'
  /shipping_provider_services:
    get:
      summary: Get Shipping Provider Services
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shipping_provider_services'
      operationId: get-shipping_provider_services
      tags:
        - Shipping Provider Services
      description: Gets an array of shipping provider services.
  '/shipping_provider_services/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `shipping_provider_services`
    put:
      summary: Update a Shipping Provider Service
      operationId: put-shipping_provider_services-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shipping_provider_services'
      tags:
        - Shipping Provider Services
      description: Updates a shipping provider service.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shipping_provider_services'
  /shipping_rate_adjustments:
    get:
      summary: Get Shipping Rate Adjustments
      tags:
        - Shipping Rate Adjustments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  shipping_rate_adjustments:
                    type: array
                    items:
                      $ref: '#/components/schemas/shipping_rate_adjustments'
      operationId: get-shipping_rate_adjustments
      description: Gets an array of shipping rate adjustments.
    post:
      summary: Create a Shipping Rate Adjustment
      operationId: post-shipping_rate_adjustments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shipping_rate_adjustments'
      description: Creates a shipping rate adjustment.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  type: Additional Handling
                  amount: 0.0
                  shipping_method_name: UPS Ground
                  shipping_provider: UPS
                  is_unavailable: false
                  product_id: 4
                  available_region_id: 2
                  use_calculated_rate: false
              properties:
                type:
                  type: string
                amount:
                  type: number
                shipping_method_name:
                  type: string
                shipping_provider:
                  type: string
                is_unavailable:
                  type: boolean
                product_id:
                  type: integer
                available_region_id:
                  type: integer
                use_calculated_rate:
                  type: boolean
              required:
                - username
              examples:
                Example:
                  value:
                    type: Additional Handling
                    amount: 0.0
                    shipping_method_name: UPS Ground
                    shipping_provider: UPS
                    is_unavailable: false
                    product_id: 4
                    available_region_id: 2
                    use_calculated_rate: false
      tags:
        - Shipping Rate Adjustments
  '/shipping_rate_adjustments/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `shipipng_rate_adjustment`
    put:
      summary: Update a Shipping Rate Adjustment
      operationId: put-shipping_rate_adjustments-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shipping_rate_adjustments'
      tags:
        - Shipping Rate Adjustments
      description: |-
        Updates a shipping rate adjustment.

        For more information on shipping rate adjustments, please see our knowledge base: [Shipping Rate Adjustments Overview](https://support.americommerce.com/hc/en-us/articles/223487968-Product-Shipping-Rate-Adjustments).
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shipping_rate_adjustments'
    delete:
      summary: Delete a Shipping Rate Adjustment
      operationId: delete-shipping_rate_adjustments-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Shipping Rate Adjustments
      description: Deletes a shipping rate adjustment.
  /store_locations:
    get:
      summary: Get Store Locations
      tags:
        - Store Locations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  store_locations:
                    type: array
                    items:
                      $ref: '#/components/schemas/store_locations'
      operationId: get-store_locations
      description: Gets an array of store locations.
    post:
      summary: Create a Store Location
      operationId: post-store_locations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/store_locations'
      tags:
        - Store Locations
      description: Creates a store location.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                store_id:
                  type: integer
                name:
                  type: string
                city:
                  type: string
                state_id:
                  type: integer
                non_us_state:
                  type: string
                country_id:
                  type: integer
                phone:
                  type: string
                address_1:
                  type: string
                address_2:
                  type: string
                zip_code:
                  type: string
                latitude: 
                  type: number
                longitude:
                  type: number
                notes:
                  type: string
                sort_order:
                  type: integer
            examples:
              Example:
                value:
                  store_id: 1
                  name: Another Store
                  city: Houston
                  state_id: 43
                  non_us_state: ''
                  country_id: 1
                  phone: 123-456-7890
                  address_1: 123 Test
                  address_2: ''
                  zip_code: '77068'
                  latitude: null
                  longitude: null
                  notes: 'Hours: 9 AM to 5 PM'
                  sort_order: 0
  '/store_locations/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `store_locations`
    put:
      summary: Update a Store Location
      operationId: put-store_locations-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/store_locations'
      tags:
        - Store Locations
      description: Updates a store location.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/store_locations'
    delete:
      summary: Delete a Store Location
      operationId: delete-store_locations-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        -  Store Locations
      description: Deletes a store location.
  /stores:
    get:
      summary: Stores
      tags:
        - Stores
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  stores:
                    type: array
                    items:
                      $ref: '#/components/schemas/stores'
              examples:
                example-1:
                  value:
                    total_count: 0
                    stores:
                      - id: 0
                        name: string
                        domain_name: string
                        email: string
                        fax: string
                        phone: string
                        keywords: string
                        description: string
                        all_catalog: boolean
                        is_micro_store: true
                        parent_store_id: 0
                        profile_id: 0
                        company_name: string
                        address_line_1: string
                        address_line_2: string
                        city: string
                        state: string
                        postal_code: string
                        country: string
                        billing_first_name: string
                        billing_last_name: string
                        tech_email: string
                        tech_first_name: string
                        tech_last_name: string
                        tech_same_as_billing: false
                        store_logo: string
                        store_image: string
                        testimonial_count: 0
                        average_testimonial_rating: 0
      operationId: get-stores
      description: Gets an array of stores.
  /subscriptions:
    get:
      summary: Get Subscriptions
      tags:
        - Subscriptions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  subscriptions:
                    type: array
                    items:
                      $ref: '#/components/schemas/subscriptions'
      operationId: get-subscriptions
      description: Gets an aray of subscriptions.
    post:
      summary: Create a Subscription
      operationId: post-subscriptions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscriptions'
      description: Creates a subscription.
      tags:
        - Subscriptions
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  saved_cart_id: 139
                  customer_id: 18
                  next_due_at: '2022-08-01T00:00:00-05:00'
                  frequency_type: Months
                  frequency: 1
                  drip_series_id: 0
                  original_order_id: 100039
                  shipping_method_name: USPS;USPS Media Mail;USPS Media Mail
                  customer_payment_method_id: 27
                  shipping_address_id: 170
                  billing_address_id: 169
                  is_enabled: false
                  latest_renewal_order_id: null
                  is_renewal_payment_declined: false
                  renewal_count: 0
                  one_time_customer_notice: ''
                  customer_notice: ''
              properties:
                saved_cart_id:
                  type: integer
                customer_id:
                  type: integer
                next_due_at:
                  type: string
                frequency_type:
                  type: string
                frequency:
                  type: number
                drip_series_id:
                  type: integer
                original_order_id:
                  type: integer
                shipping_method_name:
                  type: string
                customer_payment_method_id:
                  type: integer
                shipping_address_id:
                  type: integer
                billing_address_id:
                  type: integer
                is_enabled:
                  type: boolean
                latest_renewal_order_id:
                  type: integer
                is_renewal_payment_declined:
                  type: boolean
                renewal_count:
                  type: number
                one_time_customer_notice:
                  type: string
                customer_notice:
                  type: string
              required:
                - customer_id
                - frequency_type
                - frequency
                - original_order_id
                - shipping_method_name
                - customer_payment_method_id
                - shipping_address_id
                - billing_address_id
            examples:
              Example:
                value:
                  saved_cart_id: 139
                  customer_id: 18
                  next_due_at: '2022-08-01T00:00:00-05:00'
                  frequency_type: Months
                  frequency: 1
                  drip_series_id: 0
                  original_order_id: 100039
                  shipping_method_name: USPS;USPS Media Mail;USPS Media Mail
                  customer_payment_method_id: 27
                  shipping_address_id: 170
                  billing_address_id: 169
                  is_enabled: false
                  latest_renewal_order_id: 245
                  is_renewal_payment_declined: false
                  renewal_count: 0
                  one_time_customer_notice: ''
                  customer_notice: ''
  '/subscriptions/{id}':
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: The ID of the `subscription`
    put:
      summary: Update a Subscription
      operationId: put-subscriptions-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscriptions'
      tags:
        - Subscriptions
      description: Updates a subscription.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscriptions'
    delete:
      summary: Delete a Subscription
      operationId: delete-subscriptions-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a subscription
      tags:
        - Subscriptions
  /tax_rates:
    get:
      summary: Tax Rates
      tags:
        - Tax Rates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  tax_rates:
                    type: array
                    items:
                      $ref: '#/components/schemas/tax_rates'
      operationId: get-tax_rates
      description: Gets an array of tax rates.
    post:
      summary: Create a Tax Rate
      operationId: post-tax_rates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tax_rates'
      description: Creates a tax rate.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Texas
                  rate: 0.0825
                  region_id: 1
                  is_shipping_included: true
                  is_handling_included: true
                  store_id: 0
              properties:
                name:
                  type: string
                rate:
                  type: number
                region_id:
                  type: integer
                is_shipping_included:
                  type: boolean
                is_handling_included:
                  type: boolean
                store_id:
                  type: integer
              required:
                - rate
                - region_id
                - store_id
            examples:
              Example:
                value:
                  name: Texas
                  rate: 0.0825
                  region_id: 1
                  is_shipping_included: true
                  is_handling_included: true
                  store_id: 0
      tags:
        - Tax Rates
  '/tax_rates/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `tax_rates`
    put:
      summary: Update a Tax Rate
      operationId: put-tax_rates-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tax_rates'
      tags:
        - Tax Rates
      description: Updates a tax rate.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tax_rates'
    delete:
      summary: Delete a Tax Rate
      operationId: delete-tax_rates-id
      description: Deletes a tax rate.
      tags:
        - Tax Rates
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
  /themes/import:
    post:
      summary: Import Theme
      operationId: post-themes-import
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/theme_import'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                theme_name:
                  type: string
                  minLength: 1
                file_path:
                  type: string
                  minLength: 1
              required:
                - theme_name
                - file_path
              x-examples:
                example-1:
                  theme_name: ThemeName
                  file_path: path-to-theme-import-file.zip
            examples:
              Example:
                value:
                  theme_name: ThemeName
                  file_path: path-to-theme-import-file.zip
      tags:
        - Theme Import
      description: 'Imports a theme. '
  /url_redirects:
    get:
      summary: Get URL Redirects
      tags:
        - URL Redirects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  url_redirects:
                    type: array
                    items:
                      $ref: '#/components/schemas/url_redirects'
      operationId: get-url_redirects
      description: Gets an array of URL redirects.
    post:
      summary: Create a URL Redirect
      operationId: post-url_redirects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/url_redirects'
      tags:
        - URL Redirects
      description: Creates a URL redirect.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  from: /sitemap.html
                  to: /store/sitemapgenerator.aspx
                  is_active: true
                  redirect_type: UrlRewrite
              properties:
                from:
                  type: string
                to:
                  type: string
                is_active:
                  type: boolean
                redirect_type:
                  type: string
              required:
                - from
                - to
            examples:
              Example:
                value:
                  from: /infinity.aspx
                  to: /beyond.aspx
                  is_active: true
                  redirect_type: UrlRewrite
          application/xml:
            schema:
              type: object
              properties: {}
          multipart/form-data:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  from: /sitemap.html
                  to: /store/sitemapgenerator.aspx
                  is_active: true
                  redirect_type: UrlRewrite
              properties:
                from:
                  type: string
                to:
                  type: string
                is_active:
                  type: boolean
                redirect_type:
                  type: string
              required:
                - from
                - to
            examples:
              Example:
                value:
                  from: string
                  to: string
                  is_active: true
                  redirect_type: string
  '/url_redirects/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `url_redirect`
    put:
      summary: Update a URL Redirect
      operationId: put-url_redirects-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/url_redirects'
      tags:
        - URL Redirects
      description: Updates a URL redirect.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/url_redirects'
    delete:
      summary: Delete a URL Redirect
      operationId: delete-url_redirects-id
      description: Deletes a URL redirect.
      tags:
        - URL Redirects
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
  /users:
    get:
      summary: Get Users
      tags:
        - Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/users'
      operationId: get-users
      description: Gets an array of users.
  /variant_groups:
    get:
      summary: Get Variant Groups
      tags:
        - Variant Groups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  variant_groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/variant_groups'
      operationId: get-variant_groups
      description: |-
        Gets an array of variant groups.

        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).
    post:
      summary: Create a Variant Group
      operationId: post-variant_groups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_groups'
      tags:
        - Variant Groups
      description: |-
        Creates a variant group.

        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Shirt Size
                  sort_order: 1
                  is_hidden: false
                  display_type: DropDown
                  group_header_html: ''
                  public_description_html: ''
                  group_footer_html: ''
                  is_non_inventory: false
              properties:
                name:
                  type: string
                sort_order:
                  type: integer
                is_hidden:
                  type: boolean
                display_type:
                  type: string
                group_header_html:
                  type: string
                public_description_html:
                  type: string
                group_footer_html:
                  type: string
                is_non_inventory:
                  type: boolean
            examples:
              Example:
                value:
                  name: Shirt Size
                  sort_order: 1
                  is_hidden: false
                  display_type: DropDown
                  group_header_html: ''
                  public_description_html: ''
                  group_footer_html: ''
                  is_non_inventory: false
  '/variant_groups/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `variant_group`
    put:
      summary: Update a Variant Group
      operationId: put-variant_groups-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_groups'
      description: |-
        Updates a varaint group.

        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).
      tags:
        - Variant Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/variant_groups'
    delete:
      summary: Delete a Variant Group
      operationId: delete-variant_groups-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: |-
        Deletes a variant group.

        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).
      tags:
        - Variant Groups
  /variant_inventory:
    get:
      summary: Get Variant Inventory
      tags:
        - Variant Inventory
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  variant_inventory:
                    type: array
                    items:
                      $ref: '#/components/schemas/variant_inventory'
      operationId: get-variant_inventory
      description: Gets an array of all Variant Inventory.
    post:
      summary: Create a Variant Inventory Item
      operationId: post-variant_inventory
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: ''
                type: object
                x-examples:
                  example-1:
                    id: 77
                    product_id: 8
                    inventory: 0
                    item_number: 3367799-4
                    manufacturer_item_number: ''
                    weight: 0
                    product_status_id: 3
                    quickbooks_item_id: ''
                    updated_at: '2021-10-06T14:28:52.9715109-05:00'
                    created_at: '2021-10-06T14:28:52.9715109-05:00'
                    low_stock_warning_at: 3
                    low_stock_warning_enabled: false
                    gtin: ''
                    variant_inventory_image: ''
                    height: null
                    length: null
                    width: null
                    retail: 0
                    shipper_hq_shipping_groups: ''
                    shipper_hq_dimensional_rule_groups: ''
                    shipper_hq_packing_boxes: ''
                    description: 'Color: VariantTest-Red'
                    variants:
                      - id: 9
                        product_id: 8
                        variant_group_id: 1
                        description: X-Large
                        price_adjustment: 0
                        price_adjustment_type: ''
                        sort_order: 0
                        item_number_extension: ''
                        is_hidden: false
                        weight: 1.000
                        weight_type: '+'
                        updated_at: null
                        created_at: null
                        is_default_selection: false
                        swatch_file: null
                        swatch_thumbnail: null
                        swatch_thumbnail_color: null
                        variant_inventory_id: 77
                      - id: 5
                        product_id: 8
                        variant_group_id: 4
                        description: White
                        price_adjustment: 0
                        price_adjustment_type: ''
                        sort_order: 0
                        item_number_extension: ''
                        is_hidden: false
                        weight: 1.000
                        weight_type: '+'
                        updated_at: null
                        created_at: null
                        is_default_selection: false
                        swatch_file: null
                        swatch_thumbnail: null
                        swatch_thumbnail_color: null
                        variant_inventory_id: 77
                properties:
                  id:
                    type: integer
                  product_id:
                    type: integer
                  inventory:
                    type: integer
                  item_number:
                    type: string
                    minLength: 1
                  manufacturer_item_number:
                    type: string
                  weight:
                    type: number
                  product_status_id:
                    type: number
                  quickbooks_item_id:
                    type: string
                  updated_at:
                    type: string
                  created_at:
                    type: string
                  low_stock_warning_at:
                    type: number
                  low_stock_warning_enabled:
                    type: boolean
                  gtin:
                    type: string
                  variant_inventory_image: 
                    type: string
                  height: 
                    type: number
                  length: 
                    type: number
                  width: 
                    type: number
                  retail: 
                    type: number
                  shipper_hq_shipping_groups: 
                    type: string
                  shipper_hq_dimensional_rule_groups: 
                    type: string
                  shipper_hq_packing_boxes: 
                    type: string
                  description: 
                    type: string
                  variants:
                    type: array
                    uniqueItems: true
                    minItems: -4
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        product_id:
                          type: integer
                        variant_group_id:
                          type: integer
                        description:
                          type: string
                        price_adjustment:
                          type: number
                        price_adjustment_type:
                          type: string
                        sort_order:
                          type: number
                        item_number_extension:
                          type: string
                        item_number_sort_order:
                          type: integer
                        is_hidden:
                          type: boolean
                        weight:
                          type: number
                        weight_type:
                          type: string
                        updated_at:
                          type: string
                        created_at:
                          type: string
                        is_default_selection:
                          type: boolean
                        swatch_file:
                          type: string
                        swatch_thumbnail:
                          type: string
                        swatch_thumbnail_color:
                          type: string
                        variant_inventory_id:
                          type: number
                      required:
                        - id
                        - product_id
                        - variant_group_id
                required:
                  - id
      tags:
        - Variant Inventory
      description: |-
        Creates a variant inventory item.

        Variant Inventory items are created from all possible variant combinations. It is required to specify applicable variants that make up the variant inventory item you wish to create. For information, please see our knowledge base: [Adding Variant Level Inventory](https://support.americommerce.com/hc/en-us/articles/201907140-Adding-Variant-Level-Inventory)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              x-examples:
                example-1:
                  product_id: 8
                  inventory: 0
                  item_number: 3367799-4
                  manufacturer_item_number: ''
                  weight: 0
                  product_status_id: 3
                  quickbooks_item_id: ''
                  low_stock_warning_at: 3
                  low_stock_warning_enabled: false
                  gtin: ''
                  variant_inventory_image: ''
                  height: null
                  length: null
                  width: null
                  retail: 0
                  shipper_hq_shipping_groups: ''
                  shipper_hq_dimensional_rule_groups: ''
                  shipper_hq_packing_boxes: ''
                  variants:
                    - id: 9
                      product_id: 8
                      variant_group_id: 1
                      description: X-Large
                      price_adjustment: 0
                      price_adjustment_type: ''
                      sort_order: 0
                      item_number_extension: ''
                      item_number_sort_order: 0
                      is_hidden: false
                      weight: 0
                      weight_type: ''
                      is_default_selection: false
                      swatch_file: ''
                      swatch_thumbnail: ''
                      swatch_thumbnail_color: ''
                      variant_inventory_id: 7
                    - id: 5
                      product_id: 8
                      variant_group_id: 4
                      description: White
                      price_adjustment: 0
                      price_adjustment_type: ''
                      sort_order: 0
                      item_number_extension: ''
                      item_number_sort_order: 0
                      is_hidden: false
                      weight: 0
                      weight_type: ''
                      is_default_selection: false
                      swatch_file: ''
                      swatch_thumbnail: ''
                      swatch_thumbnail_color: ''
                      variant_inventory_id: 7
              properties:
                product_id:
                  type: integer
                inventory:
                  type: number
                item_number:
                  type: string
                manufacturer_item_number:
                  type: string
                weight:
                  type: number
                product_status_id:
                  type: integer
                quickbooks_item_id:
                  type: string
                low_stock_warning_at:
                  type: number
                low_stock_warning_enabled:
                  type: boolean
                gtin:
                  type: string
                variant_inventory_image: 
                  type: string
                height: 
                  type: number
                length: 
                  type: number
                width: 
                  type: number
                retail: 
                  type: number
                shipper_hq_shipping_groups: 
                  type: string
                shipper_hq_dimensional_rule_groups: 
                  type: string
                shipper_hq_packing_boxes: 
                  type: string
                description:
                  type: string
                variants:
                  type: array
                  uniqueItems: true
                  items:
                    type: object
                    properties:
                      id:
                        type: number
                      product_id:
                        type: number
                      variant_group_id:
                        type: number
                      description:
                        type: string
                      price_adjustment:
                        type: number
                      price_adjustment_type:
                        type: string
                      sort_order:
                        type: number
                      item_number_extension:
                        type: string
                      item_number_sort_order:
                        type: integer
                      is_hidden:
                        type: boolean
                      weight:
                        type: number
                      weight_type:
                        type: number
                      is_default_selection:
                        type: boolean
                      swatch_file:
                        type: string
                      swatch_thumbnail:
                        type: string
                      swatch_thumbnail_color:
                        type: string
                      variant_inventory_id:
                        type: number
                    required:
                      - id
                      - product_id
                      - variant_group_id
              required:
                - product_id
                - variants
            examples:
              Example:
                value:
                  product_id: 8
                  inventory: 0
                  item_number: 3367799-4
                  manufacturer_item_number: ''
                  weight: 0
                  product_status_id: 3
                  quickbooks_item_id: ''
                  low_stock_warning_at: 3
                  low_stock_warning_enabled: false
                  gtin: ''
                  variant_inventory_image: ''
                  height: null
                  length: null
                  width: null
                  retail: 0
                  shipper_hq_shipping_groups: ''
                  shipper_hq_dimensional_rule_groups: ''
                  shipper_hq_packing_boxes: ''
                  description: ''
                  variants:
                    - id: 9
                      product_id: 8
                      variant_group_id: 1
                      description: X-Large
                      price_adjustment: 0
                      price_adjustment_type: ''
                      sort_order: 0
                      item_number_extension: ''
                      is_hidden: false
                      is_default_selection: false
                      swatch_file: ''
                      swatch_thumbnail: ''
                      swatch_thumbnail_color: ''
                      variant_inventory_id: 7
                    - id: 5
                      product_id: 8
                      variant_group_id: 4
                      description: White
                      price_adjustment: 0
                      price_adjustment_type: ''
                      sort_order: 0
                      item_number_extension: ''
                      is_hidden: false
                      is_default_selection: false
                      swatch_file: ''
                      swatch_thumbnail: ''
                      swatch_thumbnail_color: ''
                      variant_inventory_id: 7
        description: ''
  '/variant_inventory/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `variant_inventory` item.
    put:
      summary: Update Variant Inventory
      operationId: put-variant_inventory-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_inventory'
      description: Updates a variant inventory item.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/variant_inventory'
      tags:
        - Variant Inventory
    delete:
      summary: Delete Variant Inventory
      operationId: delete-variant_inventory-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a variant inventory item by ID.
      tags:
        - Variant Inventory
  /wishlists:
    get:
      summary: Get Wishlists
      tags:
        - Wishlists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  wishlists:
                    type: array
                    items:
                      $ref: '#/components/schemas/wishlists'
      operationId: get-wishlists
      description: Gets an array of wishlists.
    post:
      summary: Create a Wishlist
      operationId: post-wishlists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wishlists'
      description: Creates a wishlist.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: My Wishlist
                  cart_type: WishList
                  customer_id: 42
                  is_public: false
                  store_id: 1
                  discount_total: 100
                  subtotal: 1099.99
                  shipping_total: 0
                  handling_total: 0
                  tax_total: 0
                  grand_total: 999.99
                  tax_rate: 8
                  additional_fees: 0
                  discounted_shipping_total: 0
                  region_markup_amount: 0
                  non_shipping_discount: 100
                  gift_certificate_discount: 5
                  coupon_code: ''
                  associated_order_id: null
                  shipping_estimate_city: null
                  shipping_estimate_state_code: null
                  shipping_estimate_postal_code: null
                  shipping_estimate_country_code: null
                  is_shipping_billed_to_account: false
                  customer_payment_method_id: null
                  payment_method_id: null
                  is_payment_cart_only: false
              properties:
                name:
                  type: string
                cart_type:
                  type: string
                customer_id:
                  type: integer
                is_public:
                  type: boolean
                store_id:
                  type: integer
                discount_total:
                  type: number
                subtotal:
                  type: number
                shipping_total:
                  type: number
                handling_total:
                  type: number
                tax_total:
                  type: number
                grand_total:
                  type: number
                tax_rate:
                  type: number
                additional_fees:
                  type: number
                discounted_shipping_total:
                  type: number
                region_markup_amount:
                  type: number
                non_shipping_discount:
                  type: number
                gift_certificate_discount:
                  type: number
                coupon_code:
                  type: string
                associated_order_id:
                  type: integer
                shipping_estimate_city:
                  type: string
                shipping_estimate_state_code: {}
                shipping_estimate_postal_code:
                  type: string
                shipping_estimate_country_code:
                  type: string
                is_shipping_billed_to_account:
                  type: boolean
                customer_payment_method_id:
                  type: integer
                payment_method_id:
                  type: integer
                is_payment_cart_only:
                  type: boolean
            examples:
              Example:
                value:
                  name: My Wishlist
                  cart_type: WishList
                  customer_id: 42
                  is_public: false
                  store_id: 1
                  discount_total: 100
                  subtotal: 1099.99
                  shipping_total: 0
                  handling_total: 0
                  tax_total: 0
                  grand_total: 999.99
                  tax_rate: 8
                  additional_fees: 0
                  discounted_shipping_total: 0
                  region_markup_amount: 0
                  non_shipping_discount: 100
                  gift_certificate_discount: 5
                  coupon_code: ''
                  associated_order_id: 3
                  shipping_estimate_city: Beaumont
                  shipping_estimate_state_code: Tx
                  shipping_estimate_postal_code: '77702'
                  shipping_estimate_country_code: US
                  is_shipping_billed_to_account: false
                  customer_payment_method_id: 333
                  payment_method_id: 3
                  is_payment_cart_only: false
      tags:
        - Wishlists
  '/wishlists/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `wishlist`
    put:
      summary: Update a Wishlist
      operationId: put-wishlists-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wishlists'
      description: Updates a wishlist.
      tags:
        - Wishlists
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/wishlists'
    delete:
      summary: Delete a Wishlist
      operationId: delete-wishlists-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: Deletes a wishlist.
      tags:
        - Wishlists
  /warehouses:
    get:
      summary: Get Warehouses
      tags:
        - Warehouses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  warehouses:
                    type: array
                    items:
                      $ref: '#/components/schemas/warehouses'
      operationId: get-warehouses
      description: Gets an array of warehouses.
    post:
      summary: Create a Warehouse
      operationId: post-warehouses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/warehouses'
      description: 'Creates a warehouse. '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Default Warehouse
                  city: Your City
                  state: Texas
                  country: United States
                  postal_code: '77702'
                  is_default: true
                  email: ''
                  address_line_1: ''
                  address_line_2: ''
                  account_number: ''
                  updated_at: '2019-03-28T11:42:10.227-05:00'
                  created_at: '2019-03-28T11:42:10.227-05:00'
              properties:
                name:
                  type: string
                city:
                  type: string
                state:
                  type: string
                country:
                  type: string
                postal_code:
                  type: string
                is_default:
                  type: boolean
                email:
                  type: string
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                account_number:
                  type: string
              required:
                - name
            examples:
              Example:
                value:
                  name: The Warehouse
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77702'
                  is_default: true
                  email: ''
                  address_line_1: ''
                  address_line_2: ''
                  account_number: ''
      tags:
        - Warehouses
  '/warehouses/{id}':
    parameters:
      - schema:
          type: integer
        name: id
        in: path
        required: true
        description: The ID of the `warehouse`
    put:
      summary: Update a Warehouse
      operationId: put-warehouses-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/warehouses'
      tags:
        - Warehouses
      description: Updates a warehouse.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/warehouses'
            examples:
              Example:
                value:
                  name: The Warehouse
                  city: Beaumont
                  state: Texas
                  country: United States
                  postal_code: '77702'
                  is_default: true
                  email: ''
                  address_line_1: ''
                  address_line_2: ''
                  account_number: ''
    delete:
      summary: Delete a Warehouse
      operationId: delete-warehouses-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
        - Warehouses
      description: Deletes a warehouse.
components:
  schemas:
    adcodes:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        visits:
          type: integer
        affiliate_id:
          type: integer
        commission:
          type: string
        commission_type:
          type: string
        total_sales:
          type: number
        total_orders:
          type: integer
        initial_sales:
          type: number
        load_sales:
          type: number
        new_customers:
          type: integer
        load_customers:
          type: integer
        total_commissions:
          type: number
        conversion_rate:
          type: number
        cost_per_customer:
          type: number
        sales_per_ad_dollar:
          type: number
        repeat_commission_amount:
          type: string
        repeat_commission_type:
          type: string
        pay_for_repeat_sales:
          type: string
        url:
          type: string
        is_pay_per_click:
          type: boolean
        source:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        expires_at:
          type: string
        creation_type:
          type: string
    addresses:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        customer_id:
          type: integer
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country:
          type: string
        is_default_shipping_address:
          type: boolean
        phone:
          type: string
        company:
          type: string
        alternate_phone:
          type: string
        fax:
          type: string
        comments:
          type: string
        is_default_billing_address:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        address_type:
          type: string
    attributes:
      type: object
      properties:
        id:
          type: integer
        attribute_group_id:
          type: integer
        name:
          type: string
        is_hidden:
          type: boolean
        sort_order:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        page_title:
          type: string
        keywords:
          type: string
        meta_description:
          type: string
        url_rewrite:
          type: string
    attribute_groups:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        sort_order:
          type: integer
        is_hidden:
          type: boolean
        allow_drill_down:
          type: boolean
        allow_multiple:
          type: boolean
        tie_variant_inventory:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
    blacklisted_ips:
      type: object
      properties:
        id:
          type: integer
        ip_address:
          type: string
        hit_count:
          type: integer
        last_hit_at:
          type: string
        user_agent:
          type: string
        description:
          type: string
    blogs:
      type: object
      properties:
        id:
          type: integer
        store_id:
          type: integer
        name:
          type: string
        description:
          type: string
        tag_line:
          type: string
        url_slug:
          type: string
        meta_description:
          type: string
        meta_keywords:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        copyright:
          type: string
        image_url:
          type: string
        language:
          type: string
        max_feed_elements:
          type: integer
        syndication_type:
          type: string
        is_rss_feed_enabled:
          type: boolean
        is_atom_feed_enabled:
          type: boolean
        max_chars_short_feed:
          type: integer
        max_chars_summary:
          type: integer
        is_commenting_enabled:
          type: boolean
        is_comment_moderation_enabled:
          type: boolean
        default_post_image:
          type: string
        default_teaser_image:
          type: string
        new_post_notification_email_template_id:
          type: integer
        new_comment_notification_email_template_id:
          type: integer
        notify_commenters_on_new_comments:
          type: boolean
        new_comment_admin_notification_email_template_id:
          type: integer
        new_post_admin_notification_email_template_id:
          type: integer
        new_comment_reply_notification_email_template_id:
          type: integer
        page_title:
          type: string
    blog_categories:
      type: object
      properties:
        id:
          type: integer
        blog_id:
          type: integer
        parent_category_id:
          type: integer
        type:
          type: string
        description:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        name:
          type: string
        blog_category_path:
          type: string
    blog_posts:
      type: object
      properties:
        id:
          type: integer
        blog_id:
          type: integer
        title:
          type: string
        keywords:
          type: string
        description:
          type: string
        content:
          type: string
        published_at:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        teaser_title:
          type: string
        teaser_description:
          type: string
        post_image_url:
          type: string
        teaser_image_url:
          type: string
        author_profile_id:
          type: integer
        are_comments_enabled:
          type: boolean
        is_featured:
          type: boolean
        is_stickied:
          type: boolean
        are_comments_locked:
          type: boolean
        view_count:
          type: integer
        store_id:
          type: integer
        head_tags:
          type: string
        url_rewrite:
          type: string
        page_title:
          type: string
        page_content_type:
          type: string
    carts:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        cart_type:
          type: string
        customer_id:
          type: integer
        is_public:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
        store_id:
          type: integer
        session_id:
          type: integer
        discount_total:
          type: integer
        subtotal:
          type: number
        shipping_total:
          type: integer
        handling_total:
          type: integer
        tax_total:
          type: integer
        grand_total:
          type: number
        tax_rate:
          type: integer
        additional_fees:
          type: integer
        discounted_shipping_total:
          type: integer
        region_markup_amount:
          type: number
        non_shipping_discount:
          type: integer
        gift_certificate_discount:
          type: number
        coupon_code:
          type: string
        associated_order_id:
          type: integer
        shipping_estimate_city:
          type: string
        shipping_estimate_state_code:
          type: string
        shipping_estimate_postal_code:
          type: string
        shipping_estimate_country_code:
          type: string
        is_shipping_billed_to_account:
          type: boolean
        customer_payment_method_id:
          type: integer
        payment_method_id:
          type: integer
        is_payment_cart_only:
          type: boolean
        lookup_key:
          type: string
    categories:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        short_description:
          type: string
        sort_order:
          type: integer
        is_hidden:
          type: boolean
        parent_category_id:
          type: integer
        max_quantity:
          type: integer
        category_thumbnail:
          type: string
        page_title:
          type: string
        lookup_path:
          type: string
        keywords:
          type: string
        meta_description:
          type: string
        category_image:
          type: string
        external_content_url:
          type: string
        is_category_content_displayed:
          type: boolean
        are_subcategory_products_displayed:
          type: boolean
        url_rewrite:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        default_product_picture:
          type: string
        alternate_thumbnail:
          type: string
        head_tags:
          type: string
        cat_image_alt_text:
          type: string
        thumb_image_alt_text:
          type: string
        is_hide_from_site_maps:
          type: boolean
    cart_items:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        item_number:
          type: string
        quantity:
          type: integer
        price:
          type: number
        cost:
          type: number
        shipping_address_id:
          type: integer
        item_thumbnail:
          type: string
        item_url:
          type: string
        item_name:
          type: string
        warehouse_id:
          type: integer
        parent_product_id:
          type: integer
        parent_cart_item_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        cart_id:
          type: integer
        is_subscription_product:
          type: boolean
        configuration:
          type: string
        subscription_paused:
          type: boolean
        variants:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              description:
                type: string
              variant_group_id:
                type: integer
        personalizations:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              answer:
                type: string
    coupon_codes:
      type: object
      properties:
        id:
          type: integer
        campaign_code:
          type: string
        coupon_code:
          type: string
        is_active:
          type: boolean
        is_expired:
          type: boolean
        expires_at:
          type: string
        max_uses:
          type: integer
        usage_count:
          type: integer
        notes:
          type: string
        is_hidden:
          type: boolean
    credit_cards:
      type: object
      properties:
        id:
          type: integer
        customer_id:
          type: integer
        card_type:
          type: string
        expiration_month:
          type: integer
        expiration_year:
          type: integer
        cardholder_name:
          type: string
        phone:
          type: string
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country:
          type: string
        is_default:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
        last_four:
          type: string
    customers:
      type: object
      properties:
        id:
          type: integer
        customer_number:
          type: string
        last_name:
          type: string
        first_name:
          type: string
        email:
          type: string
        phone_number:
          type: string
        registered_at:
          type: string
        last_visit_at:
          type: string
        adcode:
          type: string
        adcode_id:
          type: integer
        affiliate_id:
          type: integer
        customer_type_id:
          type: integer
        is_no_tax_customer:
          type: boolean
        comments:
          type: string
        store_id:
          type: integer
        source:
          type: string
        search_string:
          type: string
        no_account:
          type: boolean
        sales_person:
          type: string
        alternate_phone_number:
          type: string
        is_affiliate_customer:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
        username:
          type: string
        is_contact_information_only:
          type: boolean
        tax_exemption_number:
          type: string
        company:
          type: string
        source_group:
          type: string
        sales_person_user_id:
          type: integer
        store_payment_methods_enabled:
          type: array
          items:
            type: string
        tax_rate:
          type: number
        lock_default_address:
          type: boolean
        reward_tier_id:
          type: integer
        payment_net_term:
          type: integer
        credit_limit:
          type: number
        is_inactive:
          type: boolean
        use_shared_credit_limit:
          type: boolean
        override_shared_credit_limit:
          type: boolean
        customer_payment_methods_availability:
          type: array
          items:
            type: object
        default_payment_type_name:
          type: string
    customer_association:
      type: object
      properties:
        customer_association_id:
          type: integer
        association_type_id:
          type: integer
        parent_customer_id:
          type: integer
        child_customer_id:
          type: integer
    customer_types:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        customer_level:
          type: integer
        description:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
    customer_payment_methods:
      type: object
      properties:
        id:
          type: integer
        payment_method_id:
          type: integer
        customer_id:
          type: integer
        payment_type:
          type: string
        is_default:
          type: boolean
        card_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        address_id:
          type: integer
    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
    custom_field_values:
      type: object
      properties:
        id:
          type: integer
        custom_field_id:
          type: integer
        resource_id:
          type: integer
        value:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
    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
    discount_actions:
      type: object
      properties:
        id:
          type: integer
        discount_method_id:
          type: integer
        is_exclusive:
          type: boolean
        is_strict:
          type: boolean
        is_active:
          type: boolean
        modifier_operation:
          type: string
        modifier_amount:
          type: string
        modifier_type:
          type: string
        modifier_target:
          type: string
        sort_order:
          type: integer
    discount_methods:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        is_enabled:
          type: boolean
        is_strict:
          type: boolean
        use_once:
          type: boolean
        expires:
          type: boolean
        expires_at:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        starts_at:
          type: string
        remaining_uses:
          type: integer
        notes:
          type: string
        is_free_shipping_discount:
          type: boolean
        is_exclusive:
          type: boolean
        uses:
          type: integer
        exclude_child_items:
          type: boolean
        exclude_subscription_renew:
          type: boolean
    discount_rules:
      type: object
      properties:
        id:
          type: integer
        discount_method_id:
          type: integer
        type:
          type: string
        target:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        operator_type:
          type: string
        target_quantity:
          type: integer
        target_quantity_type:
          type: string
        discount_action_id:
          type: integer
        is_action_rule:
          type: boolean
        bogo_discount_buy_quantity:
          type: integer
        bogo_discount_quantity:
          type: integer
        bogo_max_use_per_order:
          type: integer
        discount_from_high_to_low:
          type: boolean
    drips:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        is_enabled:
          type: boolean
    email_templates:
      type: object
      properties:
        id:
          type: integer
        type:
          type: string
        body:
          type: string
        subject:
          type: string
        from_name:
          type: string
        from_email:
          type: string
        is_enabled:
          type: boolean
        admin_alert_header:
          type: string
        admin_alert_subject:
          type: string
        is_admin_alert_enabled:
          type: boolean
        email_format:
          type: string
        attach_invoice_pdf:
          type: boolean
        email_category_id:
          type: integer
        admin_alert_email_override:
          type: string
    external_image_whitelist:
      type: object
      properties:
        external_image_whitelist_sites_id:
          type: integer
        url:
          type: string
        created_at:
          type: string
        entered_by:
          type: string
        updated_at:
          type: string
    gift_certificate_transactions:
      type: object
      properties:
        id:
          type: integer
        gift_certificate_id:
          type: integer
        action:
          type: string
        amount:
          type: integer
        is_pre_tax_discount:
          type: boolean
        order_id:
          type: integer
        order_payment_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        status:
          type: string
    gift_certificates:
      type: object
      properties:
        id:
          type: integer
        code:
          type: string
        original_order_id:
          type: integer
        from_customer_id:
          type: integer
        recipient_email:
          type: string
        recipient_name:
          type: string
        recipient_shipping_address:
          type: string
        gift_message:
          type: string
        status:
          type: string
        is_pre_tax_discount:
          type: boolean
        gift_certificate_type:
          type: string
        comments:
          type: string
        created_at:
          type: string
        expires_at:
          type: string
        store_id:
          type: integer
        current_amount:
          type: integer
        original_amount:
          type: integer
        updated_at:
          type: string
        customer_id:
          type: integer
        expires:
          type: boolean
        order_item_id:
          type: integer
    inventory:
      type: object
      properties:
        product_id:
          type: integer
        variant_inventory_id:
          type: integer
        item_number:
          type: string
        item_name:
          type: string
        gtin:
          type: string
        quantity:
          type: integer
    links:
      type: object
      properties:
        id:
          type: integer
        url:
          type: string
        text:
          type: string
        sort_order:
          type: integer
        store_id:
          type: integer
        is_hidden:
          type: boolean
        named_link:
          type: string
        page_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        category_id:
          type: integer
        is_dynamic_menu_root:
          type: boolean
        dynamic_menu_levels:
          type: integer
        link_type:
          type: string
        parent_link_id:
          type: integer
        is_hidden_in_navigation_only:
          type: boolean
        opens_in_new_window:
          type: boolean
        is_home_page:
          type: boolean
        product_id:
          type: integer
        blog_id:
          type: integer
        blog_category_id:
          type: integer
    mailing_lists:
      type: object
      properties:
        id:
          type: integer
        type:
          type: string
        admin_list_name:
          type: string
        public_list_name:
          type: string
        store_id:
          type: integer
        is_store_default:
          type: boolean
        auto_opt_in:
          type: boolean
        is_hidden:
          type: boolean
        url_based_subscribe_url:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        welcome_email_template_id:
          type: string
    manufacturers:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        is_hidden:
          type: boolean
        sort_order:
          type: integer
        manufacturer_logo_url:
          type: string
        page_title:
          type: string
        keywords:
          type: string
        meta_description:
          type: string
        url_rewrite:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        head_tags:
          type: string
        brand_code:
          type: string
    microstores:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postal_code:
          type: string
        phone:
          type: string
        fax:
          type: string
        parent_store_id:
          type: integer
        is_micro_store:
          type: boolean
        set_cookie:
          type: boolean
        cookie_expiration:
          type: integer
        activation_date:
          type: string
        expiration_date:
          type: string
        logo_image:
          type: string
        path:
          type: string
    notifications:
      type: object
      properties:
        notification_id:
          type: integer
        product_id:
          type: integer
        email_address:
          type: string
        customer_id:
          type: integer
        notification_frequency_type:
          type: string
        store_id:
          type: integer
        variant_inventory_id:
          type: integer
    orders:
      type: object
      properties:
        id:
          type: integer
        customer_id:
          type: integer
        customer_type_id:
          type: integer
        adcode:
          type: string
        ordered_at:
          type: string
        order_status_id:
          type: integer
        special_instructions:
          type: string
        subtotal:
          type: integer
        tax_total:
          type: number
        shipping_total:
          type: integer
        discount_total:
          type: integer
        grand_total:
          type: number
        cost_total:
          type: integer
        selected_shipping_method:
          type: string
        ip_address:
          type: string
        exported_to_accounting_system:
          type: integer
        referrer:
          type: string
        order_shipping_address_id:
          type: integer
        order_billing_address_id:
          type: integer
        admin_comments:
          type: string
        source:
          type: string
        search_phrase:
          type: string
        is_ppc:
          type: boolean
        ppc_keyword:
          type: string
        store_id:
          type: integer
        session_id:
          type: integer
        handling_total:
          type: integer
        is_payment_order_only:
          type: boolean
        selected_shipping_provider_service:
          type: string
        additional_fees:
          type: integer
        adcode_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        is_gift:
          type: boolean
        gift_message:
          type: string
        public_comments:
          type: string
        instructions:
          type: string
        source_group:
          type: string
        from_subscription_id:
          type: integer
        previous_order_status_id:
          type: integer
        order_status_last_changed_at:
          type: string
        discounted_shipping_total:
          type: integer
        order_number:
          type: string
        coupon_code:
          type: string
        order_type:
          type: string
        expires_at:
          type: string
        expires:
          type: boolean
        from_quote_id:
          type: integer
        campaign_code:
          type: string
        reward_points_credited:
          type: boolean
        sales_agent_user_id:
          type: integer
          x-stoplight:
            id: kaw0p5vde61h6
        channel:
          type: string
          description: 'Valid values: Online, InStore, Chat, Phone, Email'
        device:
          type: string
        manufacturer_invoice_number:
          type: string
        manufacturer_invoice_amount:
          type: number
        manufacturer_invoice_paid:
          type: boolean
        due_date:
          type: string
        delivery_tax:
          type: number
        location_id:
          type: integer
        entered_by:
          type: string
          description: Username/Email of the Admin or Customer who created this order
        entered_by_type:
          type: string
          description: 'Valid values: Admin, Customer'
    order_addresses:
      type: object
      properties:
        id:
          type: integer
        customer_id:
          type: integer
        company:
          type: string
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: integer
        country:
          type: string
        phone:
          type: string
        alternate_phone:
          type: string
        fax:
          type: string
        comments:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        address_type:
          type: string
        state_code:
          type: string
        country_code:
          type: string
    order_items:
      type: object
      properties:
        id:
          type: integer
        order_id:
          type: integer
        product_id:
          type: integer
        item_number:
          type: string
        item_name:
          type: string
        price:
          type: integer
        cost:
          type: integer
        quantity:
          type: integer
        is_discount_item:
          type: boolean
        weight:
          type: integer
        is_taxable:
          type: boolean
        weight_unit:
          type: string
        is_non_shipping_item:
          type: boolean
        variant_inventory_id:
          type: integer
        parent_order_item_id:
          type: integer
        is_quantity_bound_to_parent:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
        height:
          type: number
        length:
          type: number
        width:
          type: number
        size_unit:
          type: string
        tax_code:
          type: string
        item_number_full:
          type: string
        admin_comments:
          type: string
        do_not_discount:
          type: boolean
        line_item_note:
          type: string
        order_shipping_address_id:
          type: integer
        gift_message:
          type: string
        delivery_date:
          type: string
        discount_amount:
          type: number
        discount_percentage:
          type: number
        is_subscription_product:
          type: boolean
        warehouse_id:
          type: integer
        description:
          type: string
        tax:
          type: number
        configuration:
          type: string
        status:
          type: string
        shipping_classification_code:
          type: string
        variants:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              description:
                type: string
              variant_group_id:
                type: integer
        personalizations:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              answer:
                type: string
    order_payments:
      type: object
      properties:
        id:
          type: integer
        customer_id:
          type: integer
        order_id:
          type: integer
        customer_payment_method_id:
          type: integer
        payment_method_id:
          type: integer
        payment_type:
          type: string
        is_approved:
          type: boolean
        is_declined:
          type: boolean
        card_type:
          type: string
        card_expiration_month:
          type: integer
        card_expiration_year:
          type: integer
        cardholder_name:
          type: string
        paid_at:
          type: string
        approved_at:
          type: string
        authorization_code:
          type: string
        reject_reason:
          type: string
        avs_code:
          type: string
        payment_method_name:
          type: string
        transaction_type:
          type: string
        amount:
          type: number
        payment_note:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        gift_certificate_id:
          type: integer
        is_captured:
          type: boolean
        transaction_id:
          type: string
        last_four:
          type: string
        is_void:
          type: boolean
        gateway_response_code:
          type: string
        cvv_response_code:
          type: string
        payment_ref_num:
          type: string
        store_payment_method_id:
          type: integer
    order_shipments:
      type: object
      properties:
        id:
          type: integer
        order_id:
          type: integer
        shipped_at:
          type: string
        tracking_numbers:
          type: string
        tracking_url:
          type: string
        shipping_method:
          type: string
        shipping_method_id:
          type: integer
        number_of_packages:
          type: integer
        total_weight:
          type: number
        provider_base_shipping_cost:
          type: string
        provider_insurance_cost:
          type: number
        provider_handling_cost:
          type: number
        provider_other_charges:
          type: number
        provider_total_shipping_cost:
          type: number
        email_sent:
          type: boolean
        private_comment:
          type: string
        shipping_comment:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        shipping_method_type:
          type: string
        shipment_name:
          type: string
        shipping_provider_name:
          type: string
    order_statuses:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        is_open:
          type: boolean
        is_declined:
          type: boolean
        is_cancelled:
          type: boolean
        is_shipped:
          type: boolean
        color:
          type: string
        email_template_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        is_fully_refunded:
          type: boolean
        is_partially_refunded:
          type: boolean
        is_quote_status:
          type: boolean
        is_partially_shipped:
          type: boolean
    pages:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string
        keywords:
          type: string
        description:
          type: string
        content:
          type: string
        is_hidden:
          type: boolean
        store_id:
          type: integer
        external_url:
          type: string
        is_content_only:
          type: boolean
        url_rewrite:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        is_secure:
          type: boolean
        is_login_required:
          type: boolean
        head_tags:
          type: string
    payment_methods:
      type: object
      properties:
        id:
          type: integer
        payment_type:
          type: string
        cost_modifier:
          type: integer
        cost_modifier_type:
          type: string
        sort_order:
          type: integer
        is_hidden:
          type: boolean
        description:
          type: string
        confirmation_message:
          type: string
        declined_message:
          type: string
        is_gateway:
          type: boolean
        gateway_name:
          type: string
        name:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        fields:
          $ref: '#/components/schemas/payment_method_fields'
    price_calculators:
      type: object
      properties:
        id:
          type: integer
        calculation_name:
          type: string
        description:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        item_numbers_regex:
          type: string
    price_calculator_rules:
      type: object
      properties:
        id:
          type: integer
        price_calculator_id:
          type: integer
        customer_type_id:
          type: integer
        store_id:
          type: integer
        starting_quantity:
          type: integer
        price_base_type:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        specific_base_price:
          type: integer
    price_calculator_rule_modifiers:
      type: object
      properties:
        id:
          type: integer
        price_calculator_rule_id:
          type: integer
        action:
          type: string
        value:
          type: integer
        modifier_type:
          type: string
        optional_action:
          type: string
        optional_value:
          type: integer
        optional_modifier_type:
          type: string
        sort_order:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        description:
          type: string
    products:
      type: object
      properties:
        id:
          type: integer
        item_number:
          type: string
        manufacturer_id:
          type: integer
        manufacturer_part_number:
          type: string
        primary_category_id:
          type: integer
        product_status_id:
          type: integer
        item_name:
          type: string
        bullets:
          type: string
        short_description:
          type: string
        long_description_2:
          type: string
        long_description_3:
          type: string
        long_description_4:
          type: string
        long_description_5:
          type: string
        height:
          type: string
        length:
          type: string
        width:
          type: string
        size_unit:
          type: string
        weight:
          type: number
        weight_unit:
          type: string
        cost:
          type: number
        price:
          type: number
        retail:
          type: number
        minimum_quantity:
          type: integer
        maximum_quantity:
          type: integer
        is_spotlight_item:
          type: integer
        quantity_on_hand:
          type: integer
        keywords:
          type: string
        is_non_taxable:
          type: integer
        is_shipped_individually:
          type: integer
        is_hidden:
          type: integer
        sort_order:
          type: integer
        e_product_type:
          type: string
        e_product_url:
          type: string
        e_product_password:
          type: string
        e_product_verification_link_expiration:
          type: integer
        e_product_email:
          type: string
        e_product_allow_multiple_deliveries:
          type: integer
        warehouse_id:
          type: integer
        call_for_shipping:
          type: integer
        quickbooks_item_id:
          type: string
        call_for_pricing:
          type: integer
        rate_adjustment_type:
          type: string
        meta_description:
          type: string
        page_title:
          type: string
        use_tabs:
          type: boolean
        related_name:
          type: string
        override_theme_use_tabs:
          type: boolean
        long_description_tab_name_1:
          type: string
        long_description_tab_name_2:
          type: string
        long_description_tab_name_3:
          type: string
        long_description_tab_name_4:
          type: string
        long_description_tab_name_5:
          type: string
        long_description_1:
          type: string
        is_non_shipping_item:
          type: boolean
        e_product_delivery_action:
          type: string
        use_variant_inventory:
          type: boolean
        is_featured_item:
          type: boolean
        long_description_external_url_1:
          type: string
        long_description_external_url_2:
          type: string
        long_description_external_url_3:
          type: string
        long_description_external_url_4:
          type: string
        long_description_external_url_5:
          type: string
        bullets_external_url:
          type: string
        custom_flag_1:
          type: boolean
        custom_flag_2:
          type: boolean
        custom_flag_3:
          type: boolean
        custom_flag_4:
          type: boolean
        custom_flag_5:
          type: boolean
        created_at:
          type: string
        updated_at:
          type: string
        url_rewrite:
          type: string
        is_kit:
          type: boolean
        is_child_product:
          type: boolean
        is_non_inventory:
          type: boolean
        is_discontinued:
          type: boolean
        eta_date:
          type: string
        quantity_on_order:
          type: integer
        available_region_id:
          type: integer
        call_for_shipping_on_whole_order:
          type: boolean
        break_out_shipping:
          type: boolean
        shipping_classification_code:
          type: string
        exclude_parent_from_display:
          type: boolean
        drop_ship:
          type: boolean
        no_price_mask:
          type: string
        starting_quantity:
          type: integer
        tax_code:
          type: string
        use_map_pricing:
          type: boolean
        last_item_number:
          type: string
        has_visible_variants:
          type: boolean
        product_rating_dimension_group_override_id:
          type: integer
        average_review_rating:
          type: number
        review_count:
          type: integer
        exclude_children_from_display:
          type: boolean
        use_pricing_from_parent:
          type: boolean
        low_stock_warning_threshold:
          type: integer
        enable_low_stock_warning:
          type: boolean
        do_not_discount:
          type: boolean
        head_tags:
          type: string
        handling_fee:
          type: number
        custom_upsell_url:
          type: string
        e_product_serial_number_file_path:
          type: string
        hide_variant_surcharges:
          type: boolean
        quantity_increment:
          type: integer
        gtin:
          type: string
        add_to_cart_message:
          type: string
        is_subscription_product:
          type: boolean
        subscription_frequency:
          type: integer
        subscription_frequency_type:
          type: string
        e_product_generic_username:
          type: string
        e_product_generic_password:
          type: string
        shipping_override:
          type: number
        insurance_cost:
          type: number
        exclude_from_commissions:
          type: boolean
        days_until_reorder_allowed:
          type: integer
        force_separate_order:
          type: boolean
        approval_required:
          type: boolean
        in_stock_notification_email_template_id:
          type: integer
        inelligible_for_purchase_by_points:
          type: boolean
        earns_points:
          type: boolean
        additional_points_earned:
          type: integer
        allowed_variable_subscription_types:
          type: string
        profile_id:
          type: integer
        is_linked_product:
          type: boolean
        master_product_id:
          type: integer
        do_not_send_review_request:
          type: boolean
        pack_slip_sort_order:
          type: integer
        is_enable_variants_on_parent:
          type: boolean
        is_hide_children_on_parent:
          type: boolean
        cart_product_id:
          type: guid
        enabled_configurator:
          type: string
        material_code:
          type: string
        product_line_code:
          type: string
        ext_update_date:
          type: string
        additional_attributes:
          type: string
        shipper_hq_shipping_groups:
          type: string
        shipper_hq_dimensional_rule_groups:
          type: string
        shipper_hq_packing_boxes:
          type: string
        freight_class:
          type: string
        hs_code:
          type: string
        coo:
          type: string
        hts:
          type: string
        is_exempt_from_min_order_amount:
          type: boolean
        category_list:
          type: string
        variants:
          type: array
          items:
            $ref: '#/components/schemas/product_nested_variant'
    product_inactive_in_store:
      type: object
      properties:
        id:
          type: integer
        item_id:
          type: integer
        store_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        customer_type_id:
          type: integer
    product_lists:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
    payment_method_fields:
      type: object
      properties:
        id:
          type: integer
        payment_method_id: 
          type: integer
        name:
          type: string
        length:
          type: integer
        sort_order:
          type: integer
        type:
          type: string
        is_required:
          type: boolean
        is_hidden:
          type: boolean
        is_encrypted:
          type: boolean
        is_masked:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
    product_nested_variant:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        variant_group_id:
          type: integer
        description:
          type: string
        price_adjustment:
          type: integer
        price_adjustment_type:
          type: string
        sort_order:
          type: integer
        item_number_extension:
          type: string
        item_number_sort_order:
          type: integer
        is_hidden:
          type: boolean
        weight:
          type: number
        weight_type:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        is_default_selection:
          type: boolean
        swatch_file:
          type: string
        swatch_thumbnail:
          type: string
        swatch_thumbnail_color:
          type: string
      description: 'Accessible via the `?expand=` parameter or `/api/v1/products/{id}/{nested_resource}`.'
    product_pictures:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        image_file:
          type: string
        alt:
          type: string
        description:
          type: string
        is_primary:
          type: boolean
        is_hidden:
          type: boolean
        thumbnail_file:
          type: string
        sort_order:
          type: integer
        flash_path:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        is_video_screen_shot:
          type: boolean
        video_content:
          type: string
        download_external_image:
          type: boolean
    product_pricing:
      description: ''
      type: object
      x-examples:
        example-1:
          id: 353
          product_id: 53
          store_id: null
          customer_type_id: null
          variant_inventory_id: null
          sale_type_id: null
          start_date: '2020-03-09T00:00:00-05:00'
          end_date: '2022-08-31T00:00:00-05:00'
          starting_quantity: 1
          price: 25
          cost: 0
          updated_at: '2021-09-15T16:27:13.46-05:00'
          created_at: '2021-08-05T10:35:29.82-05:00'
          price_calculation_id: null
          variant_id: null
          variant_price_surcharge: ''
      properties:
        id:
          type: integer
          readOnly: true
        product_id:
          type: integer
        store_id:
          type: integer
        customer_type_id:
          type: integer
        variant_inventory_id:
          type: integer
        sale_type_id:
          type: integer
        start_date:
          type: string
          minLength: 1
        end_date:
          type: string
          minLength: 1
        starting_quantity:
          type:
            - number
            - integer
        price:
          type: number
        cost:
          type: number
        updated_at:
          type: string
          minLength: 1
        created_at:
          type: string
          minLength: 1
        price_calculation_id:
          type: integer
        variant_id:
          type: integer
        variant_price_surcharge:
          type: string
    product_reviews:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        title:
          type: string
        body:
          type: string
        review_pros:
          type: string
        review_cons:
          type: string
        overall_rating:
          type: integer
        customer_id:
          type: integer
        approved_by_user_id:
          type: integer
        approved_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        author_display_name:
          type: string
        author_email:
          type: string
        author_website:
          type: string
        author_location:
          type: string
        approval_status:
          type: string
        origin_store_id:
          type: integer
        profile_id:
          type: integer
        uploaded_image:
          type: string
        published_date:
          type: string
    product_statuses:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        time_frame:
          type: string
        is_unavailable:
          type: boolean
        is_hidden:
          type: boolean
        is_back_ordered:
          type: boolean
        show_quantity:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
    product_variants:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        variant_group_id:
          type: integer
        description:
          type: string
        price_adjustment:
          type: integer
        price_adjustment_type:
          type: string
        sort_order:
          type: integer
        item_number_extension:
          type: string
        item_number_sort_order:
          type: integer
          default: 0
        is_hidden:
          type: boolean
        weight:
          type: number
        weight_type:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        is_default_selection:
          type: boolean
        swatch_file:
          type: string
        swatch_thumbnail:
          type: string
        swatch_thumbnail_color:
          type: string
    profiles:
      type: object
      properties:
        id:
          type: integer
        email:
          type: string
        username:
          type: string
        type:
          type: string
        real_name:
          type: string
        display_name:
          type: string
        about:
          type: string
        image_url:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        company:
          type: string
    quotes:
      type: object
      properties:
        id:
          type: integer
        customer_id:
          type: integer
        customer_type_id:
          type: integer
        adcode:
          type: string
        ordered_at:
          type: string
        order_status_id:
          type: integer
        special_instructions:
          type: string
        subtotal:
          type: number
        tax_total:
          type: number
        shipping_total:
          type: number
        discount_total:
          type: number
        grand_total:
          type: number
        cost_total:
          type: number
        selected_shipping_method:
          type: string
        ip_address:
          type: string
        referrer:
          type: string
        order_shipping_address_id:
          type: integer
        order_billing_address_id:
          type: integer
        admin_comments:
          type: string
        source:
          type: string
        search_phrase:
          type: string
        is_ppc:
          type: boolean
        ppc_keyword:
          type: string
        store_id:
          type: integer
        session_id:
          type: integer
        handling_total:
          type: integer
        is_payment_order_only:
          type: boolean
        selected_shipping_provider_service:
          type: string
        additional_fees:
          type: integer
        adcode_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        entered_by:
          type: string
        is_gift:
          type: boolean
        gift_message:
          type: string
        public_comments:
          type: string
        instructions:
          type: string
        source_group:
          type: string
        from_subscription_id:
          type: integer
        previous_order_status_id:
          type: integer
        order_status_last_changed_at:
          type: string
        discounted_shipping_total:
          type: integer
        order_number:
          type: string
        coupon_code:
          type: string
        order_type:
          type: string
        expires_at:
          type: string
        expires:
          type: boolean
        from_quote_id:
          type: integer
        campaign_code:
          type: string
        reward_points_credited:
          type: boolean
        channel:
          type: string
        device:
          type: string
        manufacturer_invoice_number:
          type: string
        manufacturer_invoice_amount:
          type: number
        manufacturer_invoice_paid:
          type: boolean
        sales_agent_user_id:
          type: integer
        due_date:
          type: string
        delivery_tax:
          type: number
        location_id:
          type: integer
        converted_to_order_ids:
          type: string
    regions:
      description: ''
      type: object
      x-examples:
        example-1:
          id: 14
          postal_codes: []
          name: OCONUS
          states:
            - Alaska
            - Hawaii
          countries: []
          markup_type: Percent
          markup_amount: 5
          sort_order: 1
          updated_at: '2021-10-07T12:58:11.533-05:00'
          created_at: '2021-10-07T12:58:11.533-05:00'
          region_type: ZipcodeState
          postal_code_country: null
          is_shipping_region: true
          is_tax_region: false
      properties:
        id:
          type: integer
        postal_codes:
          type: array
          items:
            type: object
        name:
          type: string
        states:
          type: array
          items: {}
        countries:
          type: array
          items: {}
        markup_type:
          type: string
        markup_amount:
          type: number
        sort_order:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        region_type:
          type: string
        postal_code_country:
          type: string
        is_shipping_region:
          type: boolean
        is_tax_region:
          type: boolean
      required:
        - id
    sessions:
      type: object
      properties:
        id:
          type: integer
        customer_id:
          type: integer
        user_id:
          type: integer
        first_hit_at:
          type: string
        last_hit_at:
          type: string
        ip_address:
          type: string
        host_name:
          type: string
        adcode_id:
          type: integer
        hit_count:
          type: integer
        visit_count:
          type: integer
        page_last_visited:
          type: string
        referer:
          type: string
        is_abandoned:
          type: integer
        user_agent:
          type: string
        cart_id:
          type: integer
        wish_list_cart_id:
          type: integer
    shipping_providers:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        provider_code:
          type: string
        is_enabled:
          type: boolean
        markup_amount:
          type: string
        markup_type:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        additional_markup_percent:
          type: integer
        additional_weight_per_package:
          type: integer
    shipping_provider_services:
      type: object
      properties:
        id:
          type: integer
        is_enabled:
          type: boolean
        shipping_provider_id:
          type: integer
        identifier:
          type: string
        name:
          type: string
        shipping_provider_code:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        allow_apo:
          type: boolean
        allow_po_box:
          type: boolean
    shipping_rate_adjustments:
      type: object
      properties:
        id:
          type: integer
        type:
          type: string
        amount:
          type: integer
        shipping_method_name:
          type: string
        shipping_provider:
          type: string
        is_unavailable:
          type: boolean
        product_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        available_region_id:
          type: integer
        use_calculated_rate:
          type: boolean
    subscriptions:
      type: object
      x-examples:
        example-1:
          id: 5
          saved_cart_id: 128
          customer_id: 1
          next_due_at: '2022-04-07T20:38:27.58+05:00'
          frequency_type: Months
          frequency: 3
          drip_series_id: 1
          original_order_id: 100008
          shipping_method_name: Priority Shipping
          updated_at: '2022-01-07T20:38:27.59+05:00'
          created_at: '2022-01-07T20:38:27.59+05:00'
          customer_payment_method_id: 98
          shipping_address_id: 267
          billing_address_id: 267
          is_enabled: true
          latest_renewal_order_id: null
          is_renewal_payment_declined: false
          renewal_count: 0
          one_time_customer_notice: ''
          customer_notice: ''
          cart_info:
            id: 128
            name: 'Sub for: 100008 - 100008'
            cart_type: SavedCart
            customer_id: 6
            is_public: false
            updated_at: '2022-01-07T20:38:27.573+05:00'
            created_at: '2022-01-07T20:38:27.573+05:00'
            store_id: 1
            session_id: 343
            discount_total: 0
            subtotal: 5500
            shipping_total: 0
            handling_total: 0
            tax_total: 0
            grand_total: 5500
            tax_rate: 0
            additional_fees: 0
            discounted_shipping_total: 0
            region_markup_amount: null
            non_shipping_discount: 0
            gift_certificate_discount: null
            coupon_code: ''
            associated_order_id: null
            shipping_estimate_city: ''
            shipping_estimate_state_code: ''
            shipping_estimate_postal_code: ''
            shipping_estimate_country_code: ''
            is_shipping_billed_to_account: false
            customer_payment_method_id: null
            payment_method_id: null
            is_payment_cart_only: false
            items:
              - id: 439
                product_id: 62
                item_number: ''
                quantity: 1
                price: 5500
                cost: 0
                shipping_address_id: 39
                item_thumbnail: /images/LG/_thumb_60_50PY2DR_bic.jpg
                item_url: ''
                item_name: 60PY2DR
                warehouse_id: 0
                parent_product_id: null
                parent_cart_item_id: null
                updated_at: '2022-01-07T20:38:27.573+05:00'
                created_at: '2022-01-07T20:38:27.573+05:00'
                cart_id: 128
                is_subscription_product: true
                vendor_store_id: null
                fitment: ''
                configuration: ''
                variants: null
                personalizations: null
                subscription_paused: false
          customer:
            id: 1
            customer_number: ''
            last_name: 'lastname'
            first_name: 'firstname'
            email: 'test@test.com'
            phone_number: ''
            registered_at: '2004-10-08T00:00:00+05:00'
            last_visit_at: '2005-09-08T13:48:55+05:00'
            adcode: ''
            adcode_id: 0
            affiliate_id: 0
            customer_type_id: 1
            is_no_tax_customer: false
            comments: ''
            store_id: 1
            source: ''
            search_string: ''
            no_account: false
            sales_person: ''
            alternate_phone_number: ''
            is_affiliate_customer: false
            updated_at: '2022-03-04T18:21:45.413+05:00'
            created_at: null
            username: ''
            is_contact_information_only: false
            tax_exemption_number: ''
            company: ''
            source_group: ''
            sales_person_user_id: null
            store_payment_methods_enabled: []
            tax_rate: null
            reward_tier_id: null
            sub: ''
          shipping_address:
            id: 267
            customer_id: 1
            company: Cart
            address_line_1: mckldmcdm
            address_line_2: ''
            city: New York
            state: New York
            country: United States
            postal_code: '10001'
            phone: '111111111111111111111111111111'
            alternate_phone: ''
            fax: ''
            comments: ''
            updated_at: '2022-01-07T20:38:27.463+05:00'
            created_at: '2022-01-07T20:38:27.463+05:00'
            first_name: Salman
            last_name: L
            address_type: Default
          customer_payment_method:
            id: 98
            payment_method_id: 193
            customer_id: 8
            payment_type: CreditCard
            is_default: true
            card_id: 33
            updated_at: '2022-03-07T21:57:16.773+05:00'
            created_at: '2022-03-07T21:57:16.773+05:00'
            address_id: null
      examples:
        - id: 5
          saved_cart_id: 128
          customer_id: 1
          next_due_at: '2022-04-07T20:38:27.58+05:00'
          frequency_type: Months
          frequency: 3
          drip_series_id: 1
          original_order_id: 100008
          shipping_method_name: Priority Shipping
          updated_at: '2022-01-07T20:38:27.59+05:00'
          created_at: '2022-01-07T20:38:27.59+05:00'
          customer_payment_method_id: 98
          shipping_address_id: 267
          billing_address_id: 267
          is_enabled: true
          latest_renewal_order_id: null
          is_renewal_payment_declined: false
          renewal_count: 0
          one_time_customer_notice: ''
          customer_notice: ''
          cart_info:
            id: 128
            name: 'Sub for: 100008 - 100008'
            cart_type: SavedCart
            customer_id: 6
            is_public: false
            updated_at: '2022-01-07T20:38:27.573+05:00'
            created_at: '2022-01-07T20:38:27.573+05:00'
            store_id: 1
            session_id: 343
            discount_total: 0
            subtotal: 5500
            shipping_total: 0
            handling_total: 0
            tax_total: 0
            grand_total: 5500
            tax_rate: 0
            additional_fees: 0
            discounted_shipping_total: 0
            region_markup_amount: null
            non_shipping_discount: 0
            gift_certificate_discount: null
            coupon_code: ''
            associated_order_id: null
            shipping_estimate_city: ''
            shipping_estimate_state_code: ''
            shipping_estimate_postal_code: ''
            shipping_estimate_country_code: ''
            is_shipping_billed_to_account: false
            customer_payment_method_id: null
            payment_method_id: null
            is_payment_cart_only: false
            items:
              - id: 439
                product_id: 62
                item_number: ''
                quantity: 1
                price: 5500
                cost: 0
                shipping_address_id: 39
                item_thumbnail: /images/LG/_thumb_60_50PY2DR_bic.jpg
                item_url: ''
                item_name: 60PY2DR
                warehouse_id: 0
                parent_product_id: null
                parent_cart_item_id: null
                updated_at: '2022-01-07T20:38:27.573+05:00'
                created_at: '2022-01-07T20:38:27.573+05:00'
                cart_id: 128
                is_subscription_product: true
                vendor_store_id: null
                fitment: ''
                configuration: ''
                variants: null
                personalizations: null
                subscription_paused: false
          customer:
            id: 1
            customer_number: ''
            last_name: 'LastName'
            first_name: 'FirstName'
            email: 'test@test.com'
            phone_number: ''
            registered_at: '2004-10-08T00:00:00+05:00'
            last_visit_at: '2005-09-08T13:48:55+05:00'
            adcode: ''
            adcode_id: 0
            affiliate_id: 0
            customer_type_id: 1
            is_no_tax_customer: false
            comments: ''
            store_id: 1
            source: ''
            search_string: ''
            no_account: false
            sales_person: ''
            alternate_phone_number: ''
            is_affiliate_customer: false
            updated_at: '2022-03-04T18:21:45.413+05:00'
            created_at: null
            username: ''
            is_contact_information_only: false
            tax_exemption_number: ''
            company: ''
            source_group: ''
            sales_person_user_id: null
            store_payment_methods_enabled: []
            tax_rate: null
            lock_default_address: false
            reward_tier_id: null
            payment_net_term: 0
            credit_limit: 0.00
            is_inactive: false
            use_shared_credit_limit: false
            override_shared_credit_limit: false
            default_payment_type_name: Credit Card
          shipping_address:
            id: 267
            customer_id: 1
            company: Cart
            address_line_1: 123Test
            address_line_2: ''
            city: New York
            state: New York
            country: United States
            postal_code: '10001'
            phone: '111111111111111111111111111111'
            alternate_phone: ''
            fax: ''
            comments: ''
            updated_at: '2022-01-07T20:38:27.463+05:00'
            created_at: '2022-01-07T20:38:27.463+05:00'
            first_name: FirstName
            last_name: LastName
            address_type: Default
            state_code: NY
            country_code: US
          customer_payment_method:
            id: 98
            payment_method_id: 193
            customer_id: 8
            payment_type: CreditCard
            is_default: true
            card_id: 33
            updated_at: '2022-03-07T21:57:16.773+05:00'
            created_at: '2022-03-07T21:57:16.773+05:00'
            address_id: null
      description: If you want child resources included in response you must pass the query parameter 'includeLookups = true'
      title: Subscriptions
      properties:
        id:
          type: integer
        saved_cart_id:
          type: integer
        customer_id:
          type: integer
        next_due_at:
          type: string
        frequency_type:
          type: string
        frequency:
          type: integer
        drip_series_id:
          type: integer
        original_order_id:
          type: integer
        shipping_method_name:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        customer_payment_method_id:
          type: integer
        shipping_address_id:
          type: integer
        billing_address_id:
          type: integer
        is_enabled:
          type: boolean
        latest_renewal_order_id:
          type: integer
        is_renewal_payment_declined:
          type: boolean
        renewal_count:
          type: integer
        one_time_customer_notice:
          type: string
        customer_notice:
          type: string
        cart_info:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            cart_type:
              type: string
            customer_id:
              type: integer
            is_public:
              type: boolean
            updated_at:
              type: string
            created_at:
              type: string
            store_id:
              type: integer
            session_id:
              type: integer
            discount_total:
              type: integer
            subtotal:
              type: integer
            shipping_total:
              type: integer
            handling_total:
              type: integer
            tax_total:
              type: integer
            grand_total:
              type: integer
            tax_rate:
              type: integer
            additional_fees:
              type: integer
            discounted_shipping_total:
              type: integer
            region_markup_amount:
              type: integer
            non_shipping_discount:
              type: integer
            gift_certificate_discount:
              type: integer
            coupon_code:
              type: string
            associated_order_id:
              type: integer
            shipping_estimate_city:
              type: string
            shipping_estimate_state_code:
              type: string
            shipping_estimate_postal_code:
              type: string
            shipping_estimate_country_code:
              type: string
            is_shipping_billed_to_account:
              type: boolean
            customer_payment_method_id:
              type: integer
            payment_method_id: {}
            is_payment_cart_only:
              type: boolean
            items:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  product_id:
                    type: integer
                  item_number:
                    type: string
                  quantity:
                    type: integer
                  price:
                    type: integer
                  cost:
                    type: integer
                  shipping_address_id:
                    type: integer
                  item_thumbnail:
                    type: string
                  item_url:
                    type: string
                  item_name:
                    type: string
                  warehouse_id:
                    type: integer
                  parent_product_id:
                    type: integer
                  parent_cart_item_id:
                    type: integer
                  updated_at:
                    type: string
                  created_at:
                    type: string
                  cart_id:
                    type: integer
                  is_subscription_product:
                    type: boolean
                  configuration:
                    type: string
                  variants:
                    type: object
                  personalizations:
                    type: object
                  subscription_paused:
                    type: boolean 
        customer:
          type: object
          properties:
            id:
              type: integer
            customer_number:
              type: string
            last_name:
              type: string
            first_name:
              type: string
            email:
              type: string
            phone_number:
              type: string
            registered_at:
              type: string
            last_visit_at:
              type: string
            adcode:
              type: string
            adcode_id:
              type: integer
            customer_type_id:
              type: integer
            is_no_tax_customer:
              type: boolean
            comments:
              type: string
            store_id:
              type: integer
            source:
              type: string
            search_string:
              type: string
            no_account:
              type: boolean
            sales_person:
              type: string
            alternate_phone_number:
              type: string
            is_affiliate_customer:
              type: boolean
            updated_at:
              type: string
            created_at:
              type: string
            username:
              type: string
            is_contact_information_only:
              type: boolean
            tax_exemption_number:
              type: string
            company:
              type: string
            source_group:
              type: string
            sales_person_user_id:
              type: integer
            store_payment_methods_enabled:
              type: array
              items:
                type: string
            tax_rate:
              type: integer
            lock_default_address:
              type: boolean
            reward_tier_id:
              type: integer
            payment_net_term:
              type: integer
            credit_limit:
              type: number
            is_inactive:
              type: boolean
            use_shared_credit_limit:
              type: boolean
            override_shared_credit_limit:
              type: boolean
            default_payment_type_name:
              type: string
        shipping_address:
          type: object
          properties:
            id:
              type: integer
            customer_id:
              type: integer
            company:
              type: string
            address_line_1:
              type: string
            address_line_2:
              type: string
            city:
              type: string
            state:
              type: string
            country:
              type: string
            postal_code:
              type: string
            phone:
              type: string
            alternate_phone:
              type: string
            fax:
              type: string
            comments:
              type: string
            updated_at:
              type: string
            created_at:
              type: string
            first_name:
              type: string
            last_name:
              type: string
            address_type:
              type: string
            state_code:
              type: string
            country_code:
              type: string
        customer_payment_method:
          type: object
          properties:
            id:
              type: integer
            payment_method_id:
              type: integer
            customer_id:
              type: integer
            payment_type:
              type: string
            is_default:
              type: boolean
            card_id:
              type: integer
            updated_at:
              type: string
            created_at:
              type: string
            address_id:
              type: integer
    store_locations:
      type: object
      properties:
        id:
          type: integer
        store_id:
          type: integer
        name:
          type: string
        city:
          type: string
        state_id:
          type: integer
        non_us_state:
          type: string
        country_id:
          type: integer
        phone:
          type: string
        address_1:
          type: string
        address_2:
          type: string
        zip_code:
          type: string
        latitude: 
          type: number
        longitude:
          type: number
        notes:
          type: string
        sort_order:
          type: integer
    stores:
      type: object
      title: ''
      properties:
        id:
          type: integer
        name:
          type: string
        domain_name:
          type: string
        email:
          type: string
        fax:
          type: string
        phone:
          type: string
        keywords:
          type: string
        description:
          type: string
        all_catalog:
          type: boolean
        is_micro_store:
          type: boolean
        parent_store_id:
          type: integer
        profile_id:
          type: integer
        company_name:
          type: string
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country:
          type: string
        billing_first_name:
          type: string
        billing_last_name:
          type: string
        tech_email:
          type: string
        tech_first_name:
          type: string
        tech_last_name:
          type: string
        tech_same_as_billing:
          type: boolean
        store_logo:
          type: string
        store_image:
          type: string
        testimonial_count:
          type: integer
        average_testimonial_rating:
          type: integer
    tax_rates:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        rate:
          type: number
        region_id:
          type: integer
        is_shipping_included:
          type: boolean
        is_handling_included:
          type: boolean
        store_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
    theme_import:
      description: ''
      type: object
      properties:
        theme_id:
          type: number
        theme_name:
          type: string
          minLength: 1
      required:
        - theme_id
        - theme_name
      x-examples:
        example-1:
          theme_id: 1234
          theme_name: ThemeName
    url_redirects:
      type: object
      properties:
        id:
          type: integer
        from:
          type: string
        to:
          type: string
        is_active:
          type: boolean
        redirect_type:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
    users:
      type: object
      properties:
        id:
          type: integer
        username:
          type: string
        email:
          type: string
        phone:
          type: string
        last_login_attempt_at:
          type: string
        last_login_at:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        phone_extension:
          type: string
        alternate_phone:
          type: string
        fax:
          type: string
        profile_id:
          type: integer
        is_salesperson:
          type: boolean
    variant_inventory:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        inventory:
          type: integer
        item_number:
          type: string
        manufacturer_item_number:
          type: string
        weight:
          type: number
        product_status_id:
          type: integer
        quickbooks_item_id:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        low_stock_warning_at:
          type: integer
        low_stock_warning_enabled:
          type: boolean
        gtin:
          type: string
        variant_inventory_image: 
          type: string
        height: 
          type: number
        length: 
          type: number
        width: 
          type: number
        retail: 
          type: number
        shipper_hq_shipping_groups: 
          type: string
        shipper_hq_dimensional_rule_groups: 
          type: string
        shipper_hq_packing_boxes: 
          type: string
        description:
          type: string
    variant_groups:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        sort_order:
          type: integer
        is_hidden:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
        display_type:
          type: string
        group_header_html:
          type: string
        public_description_html:
          type: string
        group_footer_html:
          type: string
        is_non_inventory:
          type: boolean
    warehouses:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postal_code:
          type: string
        is_default:
          type: boolean
        email:
          type: string
        address_line_1:
          type: string
        address_line_2:
          type: string
        account_number:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
    wishlists:
      description: ''
      type: object
      examples:
        Example:
          value:
            id: 41
            name: ''
            cart_type: WishList
            customer_id: null
            is_public: false
            updated_at: '2020-12-11T08:57:29.79-06:00'
            created_at: '2019-05-28T17:56:07.49-05:00'
            store_id: 1
            session_id: 1899
            discount_total: 100
            subtotal: 1099.99
            shipping_total: 0
            handling_total: 0
            tax_total: 0
            grand_total: 999.99
            tax_rate: null
            additional_fees: 0
            discounted_shipping_total: 0
            region_markup_amount: null
            non_shipping_discount: 100
            gift_certificate_discount: 5
            coupon_code: ''
            associated_order_id: null
            shipping_estimate_city: null
            shipping_estimate_state_code: null
            shipping_estimate_postal_code: null
            shipping_estimate_country_code: null
            is_shipping_billed_to_account: false
            customer_payment_method_id: null
            payment_method_id: null
            is_payment_cart_only: false
            lookup_key: null
      properties:
        id:
          type: integer
        name:
          type: string
        cart_type:
          type: string
          minLength: 1
        customer_id:
          type: integer
        is_public:
          type: boolean
        updated_at:
          type: string
          minLength: 1
        created_at:
          type: string
          minLength: 1
        store_id:
          type: integer
        session_id:
          type: integer
        discount_total:
          type: number
        subtotal:
          type: number
        shipping_total:
          type: number
        handling_total:
          type: number
        tax_total:
          type: number
        grand_total:
          type: number
        tax_rate:
          type: number
        additional_fees:
          type: number
        discounted_shipping_total:
          type: number
        region_markup_amount:
          type: number
        non_shipping_discount:
          type: number
        gift_certificate_discount:
          type: number
        coupon_code:
          type: string
        associated_order_id:
          type: integer
        shipping_estimate_city:
          type: string
        shipping_estimate_state_code:
          type: string
        shipping_estimate_postal_code:
          type: string
        shipping_estimate_country_code:
          type: string
        is_shipping_billed_to_account:
          type: boolean
        customer_payment_method_id:
          type: integer
        payment_method_id:
          type: integer
        is_payment_cart_only:
          type: boolean
        lookup_key:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header
  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: {}
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            description: ''
            type: object
            x-examples:
              example-1:
                status_code: 500
                message: Internal Server Error
                details: 'Regions Class - Base POST failed - CommandText: Regions_Update - Regions Class - Error writing to the database - CommandText: Regions_Update - Status: Err - Record has been removed from the database'
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
  parameters: {}
security:
  - X-AC-Auth-Token: []