openapi: 3.0.3
info:
  title: 'Affiliate API Documentation'
  description: 'REST API for affiliates: manage tracking links and sources, browse products, brands, and stores, run performance reports, and handle partnership requests. Every call is authenticated with your affiliate API key.'
  version: 1.0.0
servers:
  -
    url: 'https://affiliate-api.ainfluencer.com'
tags:
  -
    name: Brand
    description: ''
  -
    name: 'Landing Page'
    description: ''
  -
    name: Management
    description: ''
  -
    name: Partnership
    description: ''
  -
    name: Product
    description: ''
  -
    name: 'Product Link'
    description: ''
  -
    name: Report
    description: ''
  -
    name: 'Shopify Store'
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'Use the affiliate API key issued to your account. Send it as <code>X-API-Key</code> or as a Bearer token in <code>Authorization</code>. Create or manage keys from your affiliate dashboard.'
security:
  -
    default: []
paths:
  '/affiliate/v1/products/brands/{id}':
    get:
      summary: 'Brand Show'
      operationId: brandShow
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: encoded_brand_id
                    name: Apple
                    terms_file: ''
                    image: 'https://via.placeholder.com/640x480.png/0033bb?text=quia'
                    rating: '4.5'
                    review_count: 125
                    category:
                      id: encoded_category_id
                      name: Electronics
                    average_price: '299.99'
                    description: 'Premium electronics brand'
                    amazon_link: 'https://www.amazon.com/s?k=apple&ref=nb_sb_noss_2'
                    seller_storefront_link: 'https://www.amazon.com/s?me=123456789&marketplace=987654321'
                    average_commission: '15.50'
                    commission_type: percent
                    seller:
                      id: encoded_seller_id
                      name: 'John Doe'
                      avatar: 'https://api.dicebear.com/9.x/initials/png?seed=John+Doe'
                    active_contracts_count: 5
                    product_count: 12
                    partnered_statistics:
                      clicks: 203
                      add_to_cart: 67
                      sales: '1285.90'
                      units: 18
                      purchases: 15
                      conversions: 15
                      conversion_rate: '0.0739'
                      commission: '257.18'
                    active_partnership_request:
                      id: encoded_request_id
                      status: pending
                      commission: '20.00'
                      commission_type: percent
                      is_custom_commission: '1'
                      message: 'Partnership request message'
                      type: affiliate_to_seller
                      created_at: 1640995200
                    status: active
                    partnership_status: partnered
                    affiliate_count: 3
                    partnership_applied_date: 1640995200
                    slug: apple-electronics
                    landing_page_config: '{"hide_featured_products":false,"hide_brand_analytics":false,"featured_product_ids":[1,2,3]}'
                  status: success
                  message: 'brand fetched successfully'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: encoded_brand_id
                      name:
                        type: string
                        example: Apple
                      terms_file:
                        type: string
                        example: ''
                      image:
                        type: string
                        example: 'https://via.placeholder.com/640x480.png/0033bb?text=quia'
                      rating:
                        type: string
                        example: '4.5'
                      review_count:
                        type: integer
                        example: 125
                      category:
                        type: object
                        properties:
                          id:
                            type: string
                            example: encoded_category_id
                          name:
                            type: string
                            example: Electronics
                      average_price:
                        type: string
                        example: '299.99'
                      description:
                        type: string
                        example: 'Premium electronics brand'
                      amazon_link:
                        type: string
                        example: 'https://www.amazon.com/s?k=apple&ref=nb_sb_noss_2'
                      seller_storefront_link:
                        type: string
                        example: 'https://www.amazon.com/s?me=123456789&marketplace=987654321'
                      average_commission:
                        type: string
                        example: '15.50'
                      commission_type:
                        type: string
                        example: percent
                      seller:
                        type: object
                        properties:
                          id:
                            type: string
                            example: encoded_seller_id
                          name:
                            type: string
                            example: 'John Doe'
                          avatar:
                            type: string
                            example: 'https://api.dicebear.com/9.x/initials/png?seed=John+Doe'
                      active_contracts_count:
                        type: integer
                        example: 5
                      product_count:
                        type: integer
                        example: 12
                      partnered_statistics:
                        type: object
                        properties:
                          clicks:
                            type: integer
                            example: 203
                          add_to_cart:
                            type: integer
                            example: 67
                          sales:
                            type: string
                            example: '1285.90'
                          units:
                            type: integer
                            example: 18
                          purchases:
                            type: integer
                            example: 15
                          conversions:
                            type: integer
                            example: 15
                          conversion_rate:
                            type: string
                            example: '0.0739'
                          commission:
                            type: string
                            example: '257.18'
                      active_partnership_request:
                        type: object
                        properties:
                          id:
                            type: string
                            example: encoded_request_id
                          status:
                            type: string
                            example: pending
                          commission:
                            type: string
                            example: '20.00'
                          commission_type:
                            type: string
                            example: percent
                          is_custom_commission:
                            type: string
                            example: '1'
                          message:
                            type: string
                            example: 'Partnership request message'
                          type:
                            type: string
                            example: affiliate_to_seller
                          created_at:
                            type: integer
                            example: 1640995200
                      status:
                        type: string
                        example: active
                      partnership_status:
                        type: string
                        example: partnered
                      affiliate_count:
                        type: integer
                        example: 3
                      partnership_applied_date:
                        type: integer
                        example: 1640995200
                      slug:
                        type: string
                        example: apple-electronics
                      landing_page_config:
                        type: string
                        example: '{"hide_featured_products":false,"hide_brand_analytics":false,"featured_product_ids":[1,2,3]}'
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'brand fetched successfully'
      tags:
        - Brand
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the Seller Brand .'
        example: '2'
        required: true
        schema:
          type: string
  /affiliate/v1/products/brands:
    get:
      summary: 'Brand List'
      operationId: brandList
      description: ''
      parameters:
        -
          in: query
          name: 'order_by[id]'
          description: 'optional string for sort by id can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by id can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[name]'
          description: 'optional string for sort by name can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by name can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[main_category]'
          description: 'optional string for sort by category can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by category can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[user]'
          description: 'optional string for sort by seller can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by seller can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[review_count]'
          description: 'optional string for sort by review count can include: asc or desc.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'optional string for sort by review count can include: asc or desc.'
            example: 0
        -
          in: query
          name: 'order_by[rating]'
          description: 'optional string for sort by average rating can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by average rating can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[product_count]'
          description: 'optional string for sort by products count can include: asc or desc.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'optional string for sort by products count can include: asc or desc.'
            example: 0
        -
          in: query
          name: 'order_by[average_commission]'
          description: 'optional string for sort by average commission can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by average commission can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[partnership_status]'
          description: 'optional string for sort by partnership status can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by partnership status can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[average_price]'
          description: 'optional string for sort by average price can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by average price can include: asc or desc.'
            example: desc
        -
          in: query
          name: query
          description: 'optional string for search in brand name.'
          example: 'brand name'
          required: false
          schema:
            type: string
            description: 'optional string for search in brand name.'
            example: 'brand name'
        -
          in: query
          name: 'category_ids[]'
          description: 'optional array number for filter brand category.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter brand category.'
            example: 1
        -
          in: query
          name: 'seller_ids[]'
          description: 'optional array number for filter seller.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter seller.'
            example: 1
        -
          in: query
          name: price_from
          description: 'optional number for filter brand minimum price.'
          example: 1000
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand minimum price.'
            example: 1000
        -
          in: query
          name: price_to
          description: 'optional number for filter brand maximum price.'
          example: 2000
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum price.'
            example: 2000
        -
          in: query
          name: commission_from
          description: 'optional number for filter brand minimum commission.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand minimum commission.'
            example: 10
        -
          in: query
          name: commission_to
          description: 'optional number for filter brand maximum commission.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum commission.'
            example: 15
        -
          in: query
          name: rating_from
          description: 'optional number for filter brand minimum rating.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand minimum rating.'
            example: 1
        -
          in: query
          name: rating_to
          description: 'optional number for filter brand maximum rating.'
          example: 5
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum rating.'
            example: 5
        -
          in: query
          name: review_count_from
          description: 'optional number for filter brand maximum review count.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum review count.'
            example: 10
        -
          in: query
          name: review_count_to
          description: 'optional number for filter brand maximum review count.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum review count.'
            example: 20
        -
          in: query
          name: partnership_status
          description: 'optional number for filter partnership status include: partnered, not_partnered.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'optional number for filter partnership status include: partnered, not_partnered.'
            example: 0
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg_PWZ7nGw8vJ1m4R1aX9My
                      name: Flexon
                      image: ''
                      main_category:
                        id: alg_gkVdwbOKZ9Qrvl6NoneZ
                        name: 'Parts & Connectors'
                      user:
                        id: alg_PWZ7nGw8vJQ1m4R1aX9M
                        name: S.Ahmad
                        avatar: ''
                      status: active
                      average_price: '44.00'
                      average_commission: '20.00'
                      rating: '4.0'
                      review_count: 497
                      product_count: 1
                      partnership_status: not_partnered
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 1
                  status: success
                  message: 'brand fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg_PWZ7nGw8vJ1m4R1aX9My
                        name: Flexon
                        image: ''
                        main_category:
                          id: alg_gkVdwbOKZ9Qrvl6NoneZ
                          name: 'Parts & Connectors'
                        user:
                          id: alg_PWZ7nGw8vJQ1m4R1aX9M
                          name: S.Ahmad
                          avatar: ''
                        status: active
                        average_price: '44.00'
                        average_commission: '20.00'
                        rating: '4.0'
                        review_count: 497
                        product_count: 1
                        partnership_status: not_partnered
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg_PWZ7nGw8vJ1m4R1aX9My
                        name:
                          type: string
                          example: Flexon
                        image:
                          type: string
                          example: ''
                        main_category:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_gkVdwbOKZ9Qrvl6NoneZ
                            name:
                              type: string
                              example: 'Parts & Connectors'
                        user:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_PWZ7nGw8vJQ1m4R1aX9M
                            name:
                              type: string
                              example: S.Ahmad
                            avatar:
                              type: string
                              example: ''
                        status:
                          type: string
                          example: active
                        average_price:
                          type: string
                          example: '44.00'
                        average_commission:
                          type: string
                          example: '20.00'
                        rating:
                          type: string
                          example: '4.0'
                        review_count:
                          type: integer
                          example: 497
                        product_count:
                          type: integer
                          example: 1
                        partnership_status:
                          type: string
                          example: not_partnered
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 1
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'brand fetched successfully'
      tags:
        - Brand
  /affiliate/v1/landing-pages:
    get:
      summary: 'Index Landing Page'
      operationId: indexLandingPage
      description: ''
      parameters:
        -
          in: query
          name: 'order_by[created_at]'
          description: 'optional string for sort by created at can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by created at can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'category_ids[]'
          description: 'optional array number for filter landing has category  assignee.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter landing has category  assignee.'
            example: 1
        -
          in: query
          name: 'brand_ids[]'
          description: 'optional array number for filter landing has brand  assignee.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter landing has brand  assignee.'
            example: 1
        -
          in: query
          name: 'product_ids[]'
          description: 'optional array number for filter landing has product  assignee.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter landing has product  assignee.'
            example: 1
        -
          in: query
          name: created_at_from
          description: 'optional array number for filter landing has creation date greater than .'
          example: 14654834564
          required: false
          schema:
            type: integer
            description: 'optional array number for filter landing has creation date greater than .'
            example: 14654834564
        -
          in: query
          name: created_at_to
          description: 'optional array number for filter landing has creation date less than .'
          example: 14654834564
          required: false
          schema:
            type: integer
            description: 'optional array number for filter landing has creation date less than .'
            example: 14654834564
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n\"data\": [\n{\n\"id\": \"alg_8gae74jd0M10LG3XZoND\",\n\"name\": \"My landing page 3\",\n\"template\": {\n\"id\": \"alg_NOb3Z51n0VaK8odBjrJe\",\n\"title\": \"Left Side - Blue\",\n\"content\": \"Praesentium saepe voluptas praesentium quis doloremque. Est facere molestias tenetur doloremque voluptate non. Nisi eveniet perferendis quod enim officia vitae. Corrupti eos sit odio voluptas.\\n\\nQuam minus nesciunt iste recusandae expedita eius qui. Maxime eius dolor labore doloribus sapiente. Molestiae nulla qui sapiente eaque aliquam delectus dolores.\\n\\nUt quam harum et deserunt possimus temporibus. Deleniti suscipit aut sapiente eum quam tenetur laboriosam. Eius rerum velit repellat autem. Corporis corrupti quam quis.\",\n\"thumbnail\": \"left-blue.png\",\n\"grid_id\": alg_NOb3Z51n0VaK8odBjrJe\",\n\"color_id\": alg_NOb3Z51n0VaK8odBjrJe\"\n},\n\"is_default\": false,\n\"is_system\": false,\n\"links_count\": 0,\n\"created_at\": 1719476064\n},\n],\n\"pagination\": {\n\"current_page\": 1,\n\"per_page\": 15,\n\"total\": 3\n},\n\"status\": \"success\",\n\"message\": \"Landing page fetched successfully\"\n}"
      tags:
        - 'Landing Page'
  /affiliate/v1/managements/products:
    get:
      summary: 'Product List'
      operationId: productList
      description: 'This endpoint returns a list of products that the affiliate has access to.'
      parameters:
        -
          in: query
          name: query
          description: 'optional string for search in product name.'
          example: 'product name'
          required: false
          schema:
            type: string
            description: 'optional string for search in product name.'
            example: 'product name'
        -
          in: query
          name: 'brand_ids[]'
          description: 'optional array number for filter product brand.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product brand.'
            example: 1
        -
          in: query
          name: 'seller_ids[]'
          description: 'optional array number for filter product seller.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product seller.'
            example: 1
        -
          in: query
          name: price_from
          description: 'optional number for filter product minimum price.'
          example: 1000
          required: false
          schema:
            type: integer
            description: 'optional number for filter product minimum price.'
            example: 1000
        -
          in: query
          name: price_to
          description: 'optional number for filter product maximum price.'
          example: 2000
          required: false
          schema:
            type: integer
            description: 'optional number for filter product maximum price.'
            example: 2000
        -
          in: query
          name: commission_from
          description: 'optional number for filter product minimum commission.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'optional number for filter product minimum commission.'
            example: 10
        -
          in: query
          name: commission_to
          description: 'optional number for filter product maximum commission.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'optional number for filter product maximum commission.'
            example: 15
        -
          in: query
          name: availability
          description: 'optional string for filter availability.'
          example: 'in_stock or out_of_stock'
          required: false
          schema:
            type: string
            description: 'optional string for filter availability.'
            example: 'in_stock or out_of_stock'
        -
          in: query
          name: has_promotion
          description: 'optional boolean for filter products with promotions.'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'optional boolean for filter products with promotions.'
            example: 'true'
        -
          in: query
          name: status
          description: 'optional string for filter product status include: active or inactive.'
          example: active
          required: false
          schema:
            type: string
            description: 'optional string for filter product status include: active or inactive.'
            example: active
        -
          in: query
          name: inactive_date_from
          description: 'optional number for filter product minimum inactive date.'
          example: 1726177546
          required: false
          schema:
            type: integer
            description: 'optional number for filter product minimum inactive date.'
            example: 1726177546
        -
          in: query
          name: inactive_date_to
          description: 'optional number for filter product maximum inactive date.'
          example: 1726177546
          required: false
          schema:
            type: integer
            description: 'optional number for filter product maximum inactive date.'
            example: 1726177546
        -
          in: query
          name: 'order_by[id]'
          description: 'optional string for sort by id can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by id can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[name]'
          description: 'optional string for sort by name can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by name can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[brand]'
          description: 'optional string for sort by brand can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by brand can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[user]'
          description: 'optional string for sort by seller can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by seller can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[amazon_price]'
          description: 'optional string for sort by price can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by price can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[commission]'
          description: 'optional string for sort by commission can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by commission can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[has_promotion]'
          description: 'optional string for sort by has\_promotion can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by has\_promotion can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[availability]'
          description: 'optional string for sort by availability can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by availability can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[partnered_on]'
          description: 'optional string for sort by partnered\_on can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by partnered\_on can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[inactive_at]'
          description: 'optional string for sort by inactive\_at can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by inactive\_at can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[product_links_count]'
          description: 'optional string for sort by product\_links\_count can include: asc or desc.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'optional string for sort by product\_links\_count can include: asc or desc.'
            example: 0
        -
          in: query
          name: 'order_by[total_clicks]'
          description: 'optional string for sort by total\_clicks can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by total\_clicks can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[total_sales]'
          description: 'optional string for sort by total\_sales can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by total\_sales can include: asc or desc.'
            example: desc
        -
          in: query
          name: platform
          description: 'optional string for filter by platform.'
          example: 'amazon or shopify'
          required: false
          schema:
            type: string
            description: 'optional string for filter by platform.'
            example: 'amazon or shopify'
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 27
                      asin: B081TPHGGK
                      name: 'Emprian Big Bag of 600 gr (1.32 lb) Blue Wax Beans - Waxing Kit for Deep Hair Removal Works for Skin on Face, Armpit, Bikini Line, Leg, Arm - Wooden Applicators, Transparent Hard Wax Beads'
                      image: 'https://m.media-amazon.com/images/I/814tANbwLhL.jpg'
                      link: 'https://www.amazon.com/dp/B081TPHGGK?m=AQO9TRV0YRH57'
                      brand:
                        id: alg_g4rlB87nvyZKzZG5YEw1
                        name: Emprian
                        image: 'http://localhost:8082/storage/alg_g4rlB87nvyZKzZG5YEw1/conversions/Qk5sUngzZFc0YjA2ekNCbUEvbXE2YnpZeENqUkcvNDBzZFpqNG9URXJvWnlnS1lUYjJsMXd4TmFkK3lETlpZTzltTzZnYlVSMlh4Q29QaU9Sb0dHTGw0RFd3TWdBR280K0NqWm5Lank3NmM9-medium_thumbnail.jpg'
                      user:
                        id: alg_PWZ7nGw8vJQ1m4R1aX9M
                        name: s
                        avatar: ''
                      status: active
                      amazon_price: '18.83'
                      commission: '20.00'
                      commission_type: percent
                      availability: out_of_stock
                      promotions_count: 0
                      total_clicks: 0
                      total_sales: 0
                      product_links:
                        -
                          id: alg_k98ZOV1r0lJvPXE3aL2w
                          display_name: Default
                          is_default: true
                          is_system: true
                          source: null
                          link: 'https://buy.ainfluencer.com/product-link/alg_k98ZOV1r0lJvPXE3aL2w'
                          affiliate_amazon_tag: null
                      product_links_count: 1
                      partnered_on: 1726177546
                      inactive_at: null
                    -
                      id: 28
                      asin: B081TPJ12Z
                      name: 'Pink Hard Wax Beans 600 gr All in one Body Hair Removal Formula Wax Beads Works for Skin on Face Armpit Bikini Line Leg Arm Wooden Applicators 2 Prep Post Treatment Sprays Prefect Refill'
                      image: 'https://m.media-amazon.com/images/I/81tU8SVGjGL.jpg'
                      link: 'https://www.amazon.com/dp/B081TPJ12Z?m=AQO9TRV0YRH57'
                      brand:
                        id: alg_g4rlB87nvyZKzZG5YEw1
                        name: Emprian
                        image: 'http://localhost:8082/storage/alg_g4rlB87nvyZKzZG5YEw1/conversions/Qk5sUngzZFc0YjA2ekNCbUEvbXE2YnpZeENqUkcvNDBzZFpqNG9URXJvWnlnS1lUYjJsMXd4TmFkK3lETlpZTzltTzZnYlVSMlh4Q29QaU9Sb0dHTGw0RFd3TWdBR280K0NqWm5Lank3NmM9-medium_thumbnail.jpg'
                      user:
                        id: alg_PWZ7nGw8vJQ1m4R1aX9M
                        name: s
                        avatar: ''
                      status: active
                      amazon_price: '21.85'
                      commission: '20.00'
                      commission_type: percent
                      availability: out_of_stock
                      promotions_count: 0
                      total_clicks: 0
                      total_sales: 0
                      product_links:
                        -
                          id: alg_lZ2YpjWqvzJavaoO79dD
                          display_name: test3
                          is_default: false
                          is_system: false
                          source:
                            id: alg_X2Zq8RbnvPz0wM56WEoz
                            primary_id: test3
                            display_name: test3
                            sub_id: test3
                          link: 'https://buy.ainfluencer.com/product-link/alg_rVkgED43KDgvRnx61lNz'
                          affiliate_amazon_tag: null
                        -
                          id: alg_8gae74jd0M10LG3XZoND
                          display_name: Default
                          is_default: true
                          is_system: true
                          source: null
                          link: 'https://buy.ainfluencer.com/product-link/alg_8gae74jd0M10LG3XZoND'
                          affiliate_amazon_tag: null
                      product_links_count: 2
                      partnered_on: 1726177546
                      inactive_at: null
                    -
                      id: 24
                      asin: B07CXZSMM1
                      name: 'Flexon WS100KITCN 20-Piece Soaker Hose Kit, 100 ft, Black'
                      image: 'https://m.media-amazon.com/images/I/61C+FHXWQVL.jpg'
                      link: 'https://www.amazon.com/dp/B07CXZSMM1?m=AQO9TRV0YRH57'
                      brand:
                        id: alg_PWZ7nGw8vJ1m4R1aX9My
                        name: Flexon
                        image: ''
                      user:
                        id: alg_PWZ7nGw8vJQ1m4R1aX9M
                        name: s
                        avatar: ''
                      status: inactive
                      amazon_price: '44.00'
                      commission: '22.00'
                      commission_type: percent
                      availability: in_stock
                      promotions_count: 0
                      total_clicks: 200
                      total_sales: 50
                      product_links:
                        -
                          id: alg_DE4wXVog0ow0kJNGq5dM
                          display_name: Default
                          is_default: true
                          is_system: true
                          source: null
                          link: 'https://buy.ainfluencer.com/product-link/alg_DE4wXVog0ow0kJNGq5dM'
                          affiliate_amazon_tag: null
                      product_links_count: 1
                      partnered_on: 1726177546
                      inactive_at: 1726189537
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 3
                  status: success
                  message: 'product fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 27
                        asin: B081TPHGGK
                        name: 'Emprian Big Bag of 600 gr (1.32 lb) Blue Wax Beans - Waxing Kit for Deep Hair Removal Works for Skin on Face, Armpit, Bikini Line, Leg, Arm - Wooden Applicators, Transparent Hard Wax Beads'
                        image: 'https://m.media-amazon.com/images/I/814tANbwLhL.jpg'
                        link: 'https://www.amazon.com/dp/B081TPHGGK?m=AQO9TRV0YRH57'
                        brand:
                          id: alg_g4rlB87nvyZKzZG5YEw1
                          name: Emprian
                          image: 'http://localhost:8082/storage/alg_g4rlB87nvyZKzZG5YEw1/conversions/Qk5sUngzZFc0YjA2ekNCbUEvbXE2YnpZeENqUkcvNDBzZFpqNG9URXJvWnlnS1lUYjJsMXd4TmFkK3lETlpZTzltTzZnYlVSMlh4Q29QaU9Sb0dHTGw0RFd3TWdBR280K0NqWm5Lank3NmM9-medium_thumbnail.jpg'
                        user:
                          id: alg_PWZ7nGw8vJQ1m4R1aX9M
                          name: s
                          avatar: ''
                        status: active
                        amazon_price: '18.83'
                        commission: '20.00'
                        commission_type: percent
                        availability: out_of_stock
                        promotions_count: 0
                        total_clicks: 0
                        total_sales: 0
                        product_links:
                          -
                            id: alg_k98ZOV1r0lJvPXE3aL2w
                            display_name: Default
                            is_default: true
                            is_system: true
                            source: null
                            link: 'https://buy.ainfluencer.com/product-link/alg_k98ZOV1r0lJvPXE3aL2w'
                            affiliate_amazon_tag: null
                        product_links_count: 1
                        partnered_on: 1726177546
                        inactive_at: null
                      -
                        id: 28
                        asin: B081TPJ12Z
                        name: 'Pink Hard Wax Beans 600 gr All in one Body Hair Removal Formula Wax Beads Works for Skin on Face Armpit Bikini Line Leg Arm Wooden Applicators 2 Prep Post Treatment Sprays Prefect Refill'
                        image: 'https://m.media-amazon.com/images/I/81tU8SVGjGL.jpg'
                        link: 'https://www.amazon.com/dp/B081TPJ12Z?m=AQO9TRV0YRH57'
                        brand:
                          id: alg_g4rlB87nvyZKzZG5YEw1
                          name: Emprian
                          image: 'http://localhost:8082/storage/alg_g4rlB87nvyZKzZG5YEw1/conversions/Qk5sUngzZFc0YjA2ekNCbUEvbXE2YnpZeENqUkcvNDBzZFpqNG9URXJvWnlnS1lUYjJsMXd4TmFkK3lETlpZTzltTzZnYlVSMlh4Q29QaU9Sb0dHTGw0RFd3TWdBR280K0NqWm5Lank3NmM9-medium_thumbnail.jpg'
                        user:
                          id: alg_PWZ7nGw8vJQ1m4R1aX9M
                          name: s
                          avatar: ''
                        status: active
                        amazon_price: '21.85'
                        commission: '20.00'
                        commission_type: percent
                        availability: out_of_stock
                        promotions_count: 0
                        total_clicks: 0
                        total_sales: 0
                        product_links:
                          -
                            id: alg_lZ2YpjWqvzJavaoO79dD
                            display_name: test3
                            is_default: false
                            is_system: false
                            source:
                              id: alg_X2Zq8RbnvPz0wM56WEoz
                              primary_id: test3
                              display_name: test3
                              sub_id: test3
                            link: 'https://buy.ainfluencer.com/product-link/alg_rVkgED43KDgvRnx61lNz'
                            affiliate_amazon_tag: null
                          -
                            id: alg_8gae74jd0M10LG3XZoND
                            display_name: Default
                            is_default: true
                            is_system: true
                            source: null
                            link: 'https://buy.ainfluencer.com/product-link/alg_8gae74jd0M10LG3XZoND'
                            affiliate_amazon_tag: null
                        product_links_count: 2
                        partnered_on: 1726177546
                        inactive_at: null
                      -
                        id: 24
                        asin: B07CXZSMM1
                        name: 'Flexon WS100KITCN 20-Piece Soaker Hose Kit, 100 ft, Black'
                        image: 'https://m.media-amazon.com/images/I/61C+FHXWQVL.jpg'
                        link: 'https://www.amazon.com/dp/B07CXZSMM1?m=AQO9TRV0YRH57'
                        brand:
                          id: alg_PWZ7nGw8vJ1m4R1aX9My
                          name: Flexon
                          image: ''
                        user:
                          id: alg_PWZ7nGw8vJQ1m4R1aX9M
                          name: s
                          avatar: ''
                        status: inactive
                        amazon_price: '44.00'
                        commission: '22.00'
                        commission_type: percent
                        availability: in_stock
                        promotions_count: 0
                        total_clicks: 200
                        total_sales: 50
                        product_links:
                          -
                            id: alg_DE4wXVog0ow0kJNGq5dM
                            display_name: Default
                            is_default: true
                            is_system: true
                            source: null
                            link: 'https://buy.ainfluencer.com/product-link/alg_DE4wXVog0ow0kJNGq5dM'
                            affiliate_amazon_tag: null
                        product_links_count: 1
                        partnered_on: 1726177546
                        inactive_at: 1726189537
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 27
                        asin:
                          type: string
                          example: B081TPHGGK
                        name:
                          type: string
                          example: 'Emprian Big Bag of 600 gr (1.32 lb) Blue Wax Beans - Waxing Kit for Deep Hair Removal Works for Skin on Face, Armpit, Bikini Line, Leg, Arm - Wooden Applicators, Transparent Hard Wax Beads'
                        image:
                          type: string
                          example: 'https://m.media-amazon.com/images/I/814tANbwLhL.jpg'
                        link:
                          type: string
                          example: 'https://www.amazon.com/dp/B081TPHGGK?m=AQO9TRV0YRH57'
                        brand:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_g4rlB87nvyZKzZG5YEw1
                            name:
                              type: string
                              example: Emprian
                            image:
                              type: string
                              example: 'http://localhost:8082/storage/alg_g4rlB87nvyZKzZG5YEw1/conversions/Qk5sUngzZFc0YjA2ekNCbUEvbXE2YnpZeENqUkcvNDBzZFpqNG9URXJvWnlnS1lUYjJsMXd4TmFkK3lETlpZTzltTzZnYlVSMlh4Q29QaU9Sb0dHTGw0RFd3TWdBR280K0NqWm5Lank3NmM9-medium_thumbnail.jpg'
                        user:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_PWZ7nGw8vJQ1m4R1aX9M
                            name:
                              type: string
                              example: s
                            avatar:
                              type: string
                              example: ''
                        status:
                          type: string
                          example: active
                        amazon_price:
                          type: string
                          example: '18.83'
                        commission:
                          type: string
                          example: '20.00'
                        commission_type:
                          type: string
                          example: percent
                        availability:
                          type: string
                          example: out_of_stock
                        promotions_count:
                          type: integer
                          example: 0
                        total_clicks:
                          type: integer
                          example: 0
                        total_sales:
                          type: integer
                          example: 0
                        product_links:
                          type: array
                          example:
                            -
                              id: alg_k98ZOV1r0lJvPXE3aL2w
                              display_name: Default
                              is_default: true
                              is_system: true
                              source: null
                              link: 'https://buy.ainfluencer.com/product-link/alg_k98ZOV1r0lJvPXE3aL2w'
                              affiliate_amazon_tag: null
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: alg_k98ZOV1r0lJvPXE3aL2w
                              display_name:
                                type: string
                                example: Default
                              is_default:
                                type: boolean
                                example: true
                              is_system:
                                type: boolean
                                example: true
                              source:
                                type: string
                                example: null
                              link:
                                type: string
                                example: 'https://buy.ainfluencer.com/product-link/alg_k98ZOV1r0lJvPXE3aL2w'
                              affiliate_amazon_tag:
                                type: string
                                example: null
                        product_links_count:
                          type: integer
                          example: 1
                        partnered_on:
                          type: integer
                          example: 1726177546
                        inactive_at:
                          type: string
                          example: null
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 3
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'product fetched successfully'
      tags:
        - Management
  /affiliate/v1/managements/brands:
    get:
      summary: 'Brand List'
      operationId: brandList
      description: 'This endpoint returns a list of brands that the affiliate has access to.'
      parameters:
        -
          in: query
          name: query
          description: 'optional string for search in brand name.'
          example: 'brand name'
          required: false
          schema:
            type: string
            description: 'optional string for search in brand name.'
            example: 'brand name'
        -
          in: query
          name: 'category_ids[]'
          description: 'optional array number for filter brand category.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter brand category.'
            example: 1
        -
          in: query
          name: 'seller_ids[]'
          description: 'optional array number for filter seller.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter seller.'
            example: 1
        -
          in: query
          name: price_from
          description: 'optional number for filter brand minimum price.'
          example: 1000
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand minimum price.'
            example: 1000
        -
          in: query
          name: price_to
          description: 'optional number for filter brand maximum price.'
          example: 2000
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum price.'
            example: 2000
        -
          in: query
          name: rating_from
          description: 'optional number for filter brand minimum rating.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand minimum rating.'
            example: 1
        -
          in: query
          name: rating_to
          description: 'optional number for filter brand maximum rating.'
          example: 5
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum rating.'
            example: 5
        -
          in: query
          name: inactive_date_from
          description: 'optional number for filter brand inactive date from (timestamp).'
          example: 1625097600
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand inactive date from (timestamp).'
            example: 1625097600
        -
          in: query
          name: inactive_date_to
          description: 'optional number for filter brand inactive date to (timestamp).'
          example: 1627689600
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand inactive date to (timestamp).'
            example: 1627689600
        -
          in: query
          name: total_sales_from
          description: 'optional number for filter brand minimum total sales.'
          example: 100
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand minimum total sales.'
            example: 100
        -
          in: query
          name: total_sales_to
          description: 'optional number for filter brand maximum total sales.'
          example: 500
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum total sales.'
            example: 500
        -
          in: query
          name: revenue_from
          description: 'optional number for filter brand minimum revenue.'
          example: 1000
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand minimum revenue.'
            example: 1000
        -
          in: query
          name: revenue_to
          description: 'optional number for filter brand maximum revenue.'
          example: 5000
          required: false
          schema:
            type: integer
            description: 'optional number for filter brand maximum revenue.'
            example: 5000
        -
          in: query
          name: status
          description: 'optional string for filter brand status include: active or inactive.'
          example: active
          required: false
          schema:
            type: string
            description: 'optional string for filter brand status include: active or inactive.'
            example: active
        -
          in: query
          name: 'order_by[id]'
          description: 'optional string for sort by id can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by id can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[name]'
          description: 'optional string for sort by name can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by name can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[main_category]'
          description: 'optional string for sort by main category can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by main category can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[user]'
          description: 'optional string for sort by seller can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by seller can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[rating]'
          description: 'optional string for sort by rating can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by rating can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[product_count]'
          description: 'optional string for sort by product count can include: asc or desc.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'optional string for sort by product count can include: asc or desc.'
            example: 0
        -
          in: query
          name: 'order_by[average_commission]'
          description: 'optional string for sort by average commission can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by average commission can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[average_price]'
          description: 'optional string for sort by average price can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by average price can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[total_sales]'
          description: 'optional string for sort by total sales can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by total sales can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[revenue]'
          description: 'optional string for sort by revenue can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by revenue can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[inactive_at]'
          description: 'optional string for sort by inactive date can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by inactive date can include: asc or desc.'
            example: desc
        -
          in: query
          name: platform
          description: 'optional string for filter by platform.'
          example: "amazon or shopify\nReturns brands for Amazon platform and stores for Shopify platform"
          required: false
          schema:
            type: string
            description: 'optional string for filter by platform.'
            example: "amazon or shopify\nReturns brands for Amazon platform and stores for Shopify platform"
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg_PWZ7nGw8vJ1m4R1aX9My
                      name: Flexon
                      image: ''
                      main_category:
                        id: alg_gkVdwbOKZ9Qrvl6NoneZ
                        name: 'Parts & Connectors'
                      user:
                        id: alg_PWZ7nGw8vJQ1m4R1aX9M
                        name: s
                        avatar: ''
                      status: active
                      average_price: '44.00'
                      average_commission: '20.00'
                      rating: '4.0'
                      product_count: 1
                      partnered_on: 1718653264
                      inactive_at: null
                      total_sales: 260
                      revenue: 1350
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 1
                  status: success
                  message: 'brand fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg_PWZ7nGw8vJ1m4R1aX9My
                        name: Flexon
                        image: ''
                        main_category:
                          id: alg_gkVdwbOKZ9Qrvl6NoneZ
                          name: 'Parts & Connectors'
                        user:
                          id: alg_PWZ7nGw8vJQ1m4R1aX9M
                          name: s
                          avatar: ''
                        status: active
                        average_price: '44.00'
                        average_commission: '20.00'
                        rating: '4.0'
                        product_count: 1
                        partnered_on: 1718653264
                        inactive_at: null
                        total_sales: 260
                        revenue: 1350
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg_PWZ7nGw8vJ1m4R1aX9My
                        name:
                          type: string
                          example: Flexon
                        image:
                          type: string
                          example: ''
                        main_category:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_gkVdwbOKZ9Qrvl6NoneZ
                            name:
                              type: string
                              example: 'Parts & Connectors'
                        user:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_PWZ7nGw8vJQ1m4R1aX9M
                            name:
                              type: string
                              example: s
                            avatar:
                              type: string
                              example: ''
                        status:
                          type: string
                          example: active
                        average_price:
                          type: string
                          example: '44.00'
                        average_commission:
                          type: string
                          example: '20.00'
                        rating:
                          type: string
                          example: '4.0'
                        product_count:
                          type: integer
                          example: 1
                        partnered_on:
                          type: integer
                          example: 1718653264
                        inactive_at:
                          type: string
                          example: null
                        total_sales:
                          type: integer
                          example: 260
                        revenue:
                          type: integer
                          example: 1350
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 1
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'brand fetched successfully'
      tags:
        - Management
  /affiliate/v1/partnerships/brand/request:
    post:
      summary: 'Store Brand Request'
      operationId: storeBrandRequest
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'Partnership request stored successfully.',\n  'data'=>[]\n}"
      tags:
        - Partnership
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seller_brand_ids:
                  type: array
                  description: 'The <code>id</code> of an existing record in the seller_brands table.'
                  example:
                    - 16
                  items:
                    type: integer
                message:
                  type: string
                  description: 'Message text. Must not be greater than 1000 characters.'
                  example: 'I want to be your partner'
                  nullable: true
              required:
                - seller_brand_ids
  /affiliate/v1/partnerships/product/request:
    post:
      summary: 'Store Product Request'
      operationId: storeProductRequest
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'Partnership request stored successfully.',\n  'data'=>[]\n}"
      tags:
        - Partnership
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seller_product_ids:
                  type: array
                  description: 'The <code>id</code> of an existing record in the seller_products table.'
                  example:
                    - 16
                  items:
                    type: integer
                commission_type:
                  type: string
                  description: 'Commission type (percent or amount). This field is required when <code>commission</code> is present.'
                  example: percent
                  enum:
                    - percent
                    - amount
                  nullable: true
                commission:
                  type: number
                  description: 'Commission value.'
                  example: 10.0
                  nullable: true
                message:
                  type: string
                  description: 'Message text. Must not be greater than 1000 characters.'
                  example: 'I want to be your partner'
                  nullable: true
              required:
                - seller_product_ids
  /affiliate/v1/partnerships/contracts:
    get:
      summary: 'Partnership Contract List'
      operationId: partnershipContractList
      description: ''
      parameters:
        -
          in: query
          name: 'order_by[commission]'
          description: 'optional string for sort by commission can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by commission can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[price]'
          description: 'optional string for sort by price can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by price can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[profit]'
          description: 'optional string for sort by profit can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by profit can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[created_at]'
          description: 'optional string for sort by created at can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by created at can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'status[]'
          description: 'optional array of strings for search in contracts. It accpets `active` and `inactive` and `revoked`.'
          example: active
          required: false
          schema:
            type: string
            description: 'optional array of strings for search in contracts. It accpets `active` and `inactive` and `revoked`.'
            example: active
        -
          in: query
          name: 'type[]'
          description: 'optional array of strings for search in contracts. It accpets `brands` and `products`.'
          example: products
          required: false
          schema:
            type: string
            description: 'optional array of strings for search in contracts. It accpets `brands` and `products`.'
            example: products
        -
          in: query
          name: platform
          description: 'optional string for filter by platform. It accepts `amazon` or `shopify`.'
          example: amazon
          required: false
          schema:
            type: string
            description: 'optional string for filter by platform. It accepts `amazon` or `shopify`.'
            example: amazon
        -
          in: query
          name: marketplace
          description: 'optional string for filter by marketplace (only for Amazon platform).'
          example: ATVPDKIKX0DER
          required: false
          schema:
            type: string
            description: 'optional string for filter by marketplace (only for Amazon platform).'
            example: ATVPDKIKX0DER
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg@7b9ZAVdemE2voXyxNPR8
                      affiliate:
                        id: alg@7b9ZAVdemE2voXyxNPR8
                        name: 'Philip J. Fry'
                        avatar: ''
                      products:
                        -
                          id: alg@DE4wXVog0ow0kJNGq5dM
                          name: 'Consequatur et possimus nam dolorem ratione quia quibusdam.'
                          image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                          asin: null
                          sub_category:
                            id: alg@36J12ON0NdrqvYVPDeLw
                            name: 'Action & Adventure'
                          main_category: null
                          brand:
                            id: alg@lZ2YpjWqvzamaoO79dDN
                            name: 'Miss Winnifred Hoppe III'
                            image: ''
                          amazon_link: 'https://trantow.org/id-cum-autem-eveniet-est-et-voluptas.html?m=6102970121'
                          best_seller_rank: null
                          rating: '1.7'
                          price: '10.00'
                          commission: '24.00'
                          commission_type: percent
                          is_custom_commission: false
                          profit: 2.4
                          status: active
                          created_at: 1703209446
                          revoked_at: null
                      brands: []
                      total_commission: '0.00'
                      total_sales_count: 0
                      total_sales_amount: '0.00'
                      status: active
                      created_at: 1703209446
                    -
                      id: alg@YVnAZalrvYLmXD2o5bJk
                      affiliate:
                        id: alg@7b9ZAVdemE2voXyxNPR8
                        name: 'Philip J. Fry'
                        avatar: ''
                      products: []
                      brands:
                        -
                          id: alg@YVnAZalrvYLmXD2o5bJk
                          name: 'Miss Kariane Stiedemann V'
                          image: ''
                          category_name: 'Double French Horns'
                          rating: '2.8'
                          average_price: '2'
                          commission: 23
                          active_contracts_count: 0
                          product_count: null
                          profit: 0
                          status: active
                          revoked_at: null
                          created_at: 1703209446
                      total_commission: '0.00'
                      total_sales_count: 0
                      total_sales_amount: '0.00'
                      status: revoked
                      created_at: 1703209446
                    -
                      id: alg@NOb3Z51n0VaK8odBjrJe
                      affiliate:
                        id: alg@7b9ZAVdemE2voXyxNPR8
                        name: 'Philip J. Fry'
                        avatar: ''
                      products:
                        -
                          id: alg@jP9WoOz4mbVm2Ee3ALDk
                          name: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                          image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                          asin: null
                          sub_category:
                            id: alg@36J12ON0NdrqvYVPDeLw
                            name: 'Action & Adventure'
                          main_category: null
                          brand:
                            id: alg@l9xnzAZ50B20eaW8XEBw
                            name: 'Prof. Edwina Lynch'
                            image: ''
                          amazon_link: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                          best_seller_rank: null
                          rating: '4.9'
                          price: '10.00'
                          commission: '59.00'
                          commission_type: percent
                          is_custom_commission: false
                          profit: 5.9
                          status: active
                          created_at: 1702946489
                          revoked_at: null
                      brands: []
                      total_commission: '0.00'
                      total_sales_count: 0
                      total_sales_amount: '0.00'
                      status: active
                      created_at: 1702946489
                    -
                      id: alg@jP9WoOz4mbVm2Ee3ALDk
                      affiliate:
                        id: alg@7b9ZAVdemE2voXyxNPR8
                        name: 'Philip J. Fry'
                        avatar: ''
                      products: []
                      brands:
                        -
                          id: alg@NOb3Z51n0VaK8odBjrJe
                          name: 'Alysson Kutch'
                          image: ''
                          category_name: 'Cross-Country Skiing'
                          rating: '4.2'
                          average_price: null
                          commission: 57
                          active_contracts_count: 0
                          product_count: null
                          profit: 0
                          status: active
                          revoked_at: null
                          created_at: 1702946489
                      total_commission: '0.00'
                      total_sales_count: 0
                      total_sales_amount: '0.00'
                      status: revoked
                      created_at: 1702946489
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 4
                  status: success
                  message: 'partnership fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg@7b9ZAVdemE2voXyxNPR8
                        affiliate:
                          id: alg@7b9ZAVdemE2voXyxNPR8
                          name: 'Philip J. Fry'
                          avatar: ''
                        products:
                          -
                            id: alg@DE4wXVog0ow0kJNGq5dM
                            name: 'Consequatur et possimus nam dolorem ratione quia quibusdam.'
                            image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                            asin: null
                            sub_category:
                              id: alg@36J12ON0NdrqvYVPDeLw
                              name: 'Action & Adventure'
                            main_category: null
                            brand:
                              id: alg@lZ2YpjWqvzamaoO79dDN
                              name: 'Miss Winnifred Hoppe III'
                              image: ''
                            amazon_link: 'https://trantow.org/id-cum-autem-eveniet-est-et-voluptas.html?m=6102970121'
                            best_seller_rank: null
                            rating: '1.7'
                            price: '10.00'
                            commission: '24.00'
                            commission_type: percent
                            is_custom_commission: false
                            profit: 2.4
                            status: active
                            created_at: 1703209446
                            revoked_at: null
                        brands: []
                        total_commission: '0.00'
                        total_sales_count: 0
                        total_sales_amount: '0.00'
                        status: active
                        created_at: 1703209446
                      -
                        id: alg@YVnAZalrvYLmXD2o5bJk
                        affiliate:
                          id: alg@7b9ZAVdemE2voXyxNPR8
                          name: 'Philip J. Fry'
                          avatar: ''
                        products: []
                        brands:
                          -
                            id: alg@YVnAZalrvYLmXD2o5bJk
                            name: 'Miss Kariane Stiedemann V'
                            image: ''
                            category_name: 'Double French Horns'
                            rating: '2.8'
                            average_price: '2'
                            commission: 23
                            active_contracts_count: 0
                            product_count: null
                            profit: 0
                            status: active
                            revoked_at: null
                            created_at: 1703209446
                        total_commission: '0.00'
                        total_sales_count: 0
                        total_sales_amount: '0.00'
                        status: revoked
                        created_at: 1703209446
                      -
                        id: alg@NOb3Z51n0VaK8odBjrJe
                        affiliate:
                          id: alg@7b9ZAVdemE2voXyxNPR8
                          name: 'Philip J. Fry'
                          avatar: ''
                        products:
                          -
                            id: alg@jP9WoOz4mbVm2Ee3ALDk
                            name: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                            image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                            asin: null
                            sub_category:
                              id: alg@36J12ON0NdrqvYVPDeLw
                              name: 'Action & Adventure'
                            main_category: null
                            brand:
                              id: alg@l9xnzAZ50B20eaW8XEBw
                              name: 'Prof. Edwina Lynch'
                              image: ''
                            amazon_link: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                            best_seller_rank: null
                            rating: '4.9'
                            price: '10.00'
                            commission: '59.00'
                            commission_type: percent
                            is_custom_commission: false
                            profit: 5.9
                            status: active
                            created_at: 1702946489
                            revoked_at: null
                        brands: []
                        total_commission: '0.00'
                        total_sales_count: 0
                        total_sales_amount: '0.00'
                        status: active
                        created_at: 1702946489
                      -
                        id: alg@jP9WoOz4mbVm2Ee3ALDk
                        affiliate:
                          id: alg@7b9ZAVdemE2voXyxNPR8
                          name: 'Philip J. Fry'
                          avatar: ''
                        products: []
                        brands:
                          -
                            id: alg@NOb3Z51n0VaK8odBjrJe
                            name: 'Alysson Kutch'
                            image: ''
                            category_name: 'Cross-Country Skiing'
                            rating: '4.2'
                            average_price: null
                            commission: 57
                            active_contracts_count: 0
                            product_count: null
                            profit: 0
                            status: active
                            revoked_at: null
                            created_at: 1702946489
                        total_commission: '0.00'
                        total_sales_count: 0
                        total_sales_amount: '0.00'
                        status: revoked
                        created_at: 1702946489
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg@7b9ZAVdemE2voXyxNPR8
                        affiliate:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg@7b9ZAVdemE2voXyxNPR8
                            name:
                              type: string
                              example: 'Philip J. Fry'
                            avatar:
                              type: string
                              example: ''
                        products:
                          type: array
                          example:
                            -
                              id: alg@DE4wXVog0ow0kJNGq5dM
                              name: 'Consequatur et possimus nam dolorem ratione quia quibusdam.'
                              image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                              asin: null
                              sub_category:
                                id: alg@36J12ON0NdrqvYVPDeLw
                                name: 'Action & Adventure'
                              main_category: null
                              brand:
                                id: alg@lZ2YpjWqvzamaoO79dDN
                                name: 'Miss Winnifred Hoppe III'
                                image: ''
                              amazon_link: 'https://trantow.org/id-cum-autem-eveniet-est-et-voluptas.html?m=6102970121'
                              best_seller_rank: null
                              rating: '1.7'
                              price: '10.00'
                              commission: '24.00'
                              commission_type: percent
                              is_custom_commission: false
                              profit: 2.4
                              status: active
                              created_at: 1703209446
                              revoked_at: null
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: alg@DE4wXVog0ow0kJNGq5dM
                              name:
                                type: string
                                example: 'Consequatur et possimus nam dolorem ratione quia quibusdam.'
                              image:
                                type: string
                                example: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                              asin:
                                type: string
                                example: null
                              sub_category:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: alg@36J12ON0NdrqvYVPDeLw
                                  name:
                                    type: string
                                    example: 'Action & Adventure'
                              main_category:
                                type: string
                                example: null
                              brand:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: alg@lZ2YpjWqvzamaoO79dDN
                                  name:
                                    type: string
                                    example: 'Miss Winnifred Hoppe III'
                                  image:
                                    type: string
                                    example: ''
                              amazon_link:
                                type: string
                                example: 'https://trantow.org/id-cum-autem-eveniet-est-et-voluptas.html?m=6102970121'
                              best_seller_rank:
                                type: string
                                example: null
                              rating:
                                type: string
                                example: '1.7'
                              price:
                                type: string
                                example: '10.00'
                              commission:
                                type: string
                                example: '24.00'
                              commission_type:
                                type: string
                                example: percent
                              is_custom_commission:
                                type: boolean
                                example: false
                              profit:
                                type: number
                                example: 2.4
                              status:
                                type: string
                                example: active
                              created_at:
                                type: integer
                                example: 1703209446
                              revoked_at:
                                type: string
                                example: null
                        brands:
                          type: array
                          example: []
                        total_commission:
                          type: string
                          example: '0.00'
                        total_sales_count:
                          type: integer
                          example: 0
                        total_sales_amount:
                          type: string
                          example: '0.00'
                        status:
                          type: string
                          example: active
                        created_at:
                          type: integer
                          example: 1703209446
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 4
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'partnership fetched successfully'
      tags:
        - Partnership
  '/affiliate/v1/partnerships/contracts/{contractId}':
    get:
      summary: 'Show Partnership Contract Details'
      operationId: showPartnershipContractDetails
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n{\n\"status\": \"success\",\n\"message\": \"words.partnership_contract Successfully Fetched\",\n\"data\": {\n\"id\": 20,\n\"seller\": {\n\"id\": \"alg@jP9WoOz4mbBVm2Ee3ALD\",\n\"name\": \"test\"\n},\n\"status\": \"active\",\n\"partnered_at\": 1734376523,\n\"brandDetails\": [],\n\"productDetails\": {\n\"brand\": \"Emprian\",\n\"product\": \"B081TPHGGK\",\n\"category\": \"Beauty & Personal Care\",\n\"price\": \"18.83\",\n\"profit\": 3.77,\n\"commission_type\": \"percent\",\n\"commission\": \"20.00\",\n\"affiliates_count\": 1,\n\"terms_of_sale\": \"\"\n}\n}"
      tags:
        - Partnership
    parameters:
      -
        in: path
        name: contractId
        description: 'The ID of the partnership contract.'
        example: 1
        required: true
        schema:
          type: integer
  '/affiliate/v1/partnerships/contracts/{contractId}/revoke':
    put:
      summary: 'Revoke Partnership Contract'
      operationId: revokePartnershipContract
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  \"status\" => \"success\",\n  \"message\" => \"Partnership contract revoked successfully.\",\n  \"data\" => []\n}"
      tags:
        - Partnership
    parameters:
      -
        in: path
        name: contractId
        description: ''
        example: architecto
        required: true
        schema:
          type: string
  /affiliate/v1/partnerships/requests:
    get:
      summary: 'Partnership Request List'
      operationId: partnershipRequestList
      description: ''
      parameters:
        -
          in: query
          name: 'order_by[commission]'
          description: 'optional string for sort by commission can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by commission can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[price]'
          description: 'optional string for sort by price can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by price can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[profit]'
          description: 'optional string for sort by profit can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by profit can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[created_at]'
          description: 'optional string for sort by created at can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by created at can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'status[]'
          description: 'optional array of strings for search in contracts. It accepts `accepted`, `canceled`, `pending` and `rejected`.'
          example: active
          required: false
          schema:
            type: string
            description: 'optional array of strings for search in contracts. It accepts `accepted`, `canceled`, `pending` and `rejected`.'
            example: active
        -
          in: query
          name: 'type[]'
          description: 'optional array of strings for search in contracts. It accepts `brands` and `products`.'
          example: products
          required: false
          schema:
            type: string
            description: 'optional array of strings for search in contracts. It accepts `brands` and `products`.'
            example: products
        -
          in: query
          name: direction
          description: 'optional string for search in contracts. It accepts `seller_to_affiliate` and `affiliate_to_seller`.'
          example: affiliate_to_seller
          required: false
          schema:
            type: string
            description: 'optional string for search in contracts. It accepts `seller_to_affiliate` and `affiliate_to_seller`.'
            example: affiliate_to_seller
        -
          in: query
          name: platform
          description: 'optional string for filter by platform. It accepts `amazon` or `shopify`.'
          example: amazon
          required: false
          schema:
            type: string
            description: 'optional string for filter by platform. It accepts `amazon` or `shopify`.'
            example: amazon
        -
          in: query
          name: marketplace
          description: 'optional string for filter by marketplace (only for Amazon platform).'
          example: ATVPDKIKX0DER
          required: false
          schema:
            type: string
            description: 'optional string for filter by marketplace (only for Amazon platform).'
            example: ATVPDKIKX0DER
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg@DE4wXVog0ow0kJNGq5dM
                      seller:
                        id: alg@bANMR19W0j1qKqBQDrOY
                        name: 'Austyn Hackett'
                        avatar: ''
                      products:
                        -
                          id: alg@jP9WoOz4mbVm2Ee3ALDk
                          name: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                          image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                          asin: null
                          sub_category:
                            id: alg@36J12ON0NdrqvYVPDeLw
                            name: 'Action & Adventure'
                          main_category: null
                          brand:
                            id: alg@l9xnzAZ50B20eaW8XEBw
                            name: 'Prof. Edwina Lynch'
                            image: ''
                          best_seller_rank: null
                          rating: '4.9'
                          amazon_link: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                          price: '10.00'
                          profit: 0
                          commission: null
                          commission_type: null
                          is_custom_commission: false
                          status: active
                      brands: []
                      status: pending
                      type: seller_to_affiliate
                      created_at: 1717208058
                    -
                      id: alg@lZ2YpjWqvzamaoO79dDN
                      seller: null
                      products:
                        -
                          id: alg@NOb3Z51n0VaK8odBjrJe
                          name: 'Ratione vel esse explicabo et error sed amet.'
                          image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                          asin: null
                          sub_category:
                            id: alg@8MEDr2kvAknB0W43jVZx
                            name: Highlighters
                          main_category: null
                          brand:
                            id: alg@rVkgED43KDgvRnx61lNz
                            name: 'Ada Fisher'
                            image: ''
                          best_seller_rank: null
                          rating: '1.0'
                          amazon_link: 'http://larkin.com/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121'
                          price: '10.00'
                          profit: 0
                          commission: null
                          commission_type: null
                          status: active
                      brands: []
                      status: pending
                      type: seller_to_affiliate
                      created_at: 1717207524
                    -
                      id: alg@rVkgED43KDgvRnx61lNz
                      seller: null
                      products:
                        -
                          id: alg@NOb3Z51n0VaK8odBjrJe
                          name: 'Ratione vel esse explicabo et error sed amet.'
                          image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                          asin: null
                          sub_category:
                            id: alg@8MEDr2kvAknB0W43jVZx
                            name: Highlighters
                          main_category: null
                          brand:
                            id: alg@rVkgED43KDgvRnx61lNz
                            name: 'Ada Fisher'
                            image: ''
                          best_seller_rank: null
                          rating: '1.0'
                          amazon_link: 'http://larkin.com/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121'
                          price: '10.00'
                          profit: 0
                          commission: null
                          commission_type: null
                          status: active
                      brands: []
                      status: pending
                      type: seller_to_affiliate
                      created_at: 1717206650
                    -
                      id: alg@X2Zq8RbnvPz0wM56WEoz
                      affiliate:
                        id: alg@7b9ZAVdemE2voXyxNPR8
                        name: 'Philip J. Fry'
                        avatar: ''
                      products:
                        -
                          id: alg@NOb3Z51n0VaK8odBjrJe
                          name: 'Ratione vel esse explicabo et error sed amet.'
                          image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                          asin: null
                          sub_category:
                            id: alg@8MEDr2kvAknB0W43jVZx
                            name: Highlighters
                          main_category: null
                          brand:
                            id: alg@rVkgED43KDgvRnx61lNz
                            name: 'Ada Fisher'
                            image: ''
                          best_seller_rank: null
                          rating: '1.0'
                          amazon_link: 'http://larkin.com/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121'
                          price: '10.00'
                          profit: 0
                          commission: null
                          commission_type: null
                          status: active
                      brands: []
                      status: pending
                      type: seller_to_affiliate
                      created_at: 1717206059
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 4
                  status: success
                  message: 'partnership fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg@DE4wXVog0ow0kJNGq5dM
                        seller:
                          id: alg@bANMR19W0j1qKqBQDrOY
                          name: 'Austyn Hackett'
                          avatar: ''
                        products:
                          -
                            id: alg@jP9WoOz4mbVm2Ee3ALDk
                            name: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                            image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                            asin: null
                            sub_category:
                              id: alg@36J12ON0NdrqvYVPDeLw
                              name: 'Action & Adventure'
                            main_category: null
                            brand:
                              id: alg@l9xnzAZ50B20eaW8XEBw
                              name: 'Prof. Edwina Lynch'
                              image: ''
                            best_seller_rank: null
                            rating: '4.9'
                            amazon_link: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                            price: '10.00'
                            profit: 0
                            commission: null
                            commission_type: null
                            is_custom_commission: false
                            status: active
                        brands: []
                        status: pending
                        type: seller_to_affiliate
                        created_at: 1717208058
                      -
                        id: alg@lZ2YpjWqvzamaoO79dDN
                        seller: null
                        products:
                          -
                            id: alg@NOb3Z51n0VaK8odBjrJe
                            name: 'Ratione vel esse explicabo et error sed amet.'
                            image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                            asin: null
                            sub_category:
                              id: alg@8MEDr2kvAknB0W43jVZx
                              name: Highlighters
                            main_category: null
                            brand:
                              id: alg@rVkgED43KDgvRnx61lNz
                              name: 'Ada Fisher'
                              image: ''
                            best_seller_rank: null
                            rating: '1.0'
                            amazon_link: 'http://larkin.com/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121'
                            price: '10.00'
                            profit: 0
                            commission: null
                            commission_type: null
                            status: active
                        brands: []
                        status: pending
                        type: seller_to_affiliate
                        created_at: 1717207524
                      -
                        id: alg@rVkgED43KDgvRnx61lNz
                        seller: null
                        products:
                          -
                            id: alg@NOb3Z51n0VaK8odBjrJe
                            name: 'Ratione vel esse explicabo et error sed amet.'
                            image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                            asin: null
                            sub_category:
                              id: alg@8MEDr2kvAknB0W43jVZx
                              name: Highlighters
                            main_category: null
                            brand:
                              id: alg@rVkgED43KDgvRnx61lNz
                              name: 'Ada Fisher'
                              image: ''
                            best_seller_rank: null
                            rating: '1.0'
                            amazon_link: 'http://larkin.com/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121'
                            price: '10.00'
                            profit: 0
                            commission: null
                            commission_type: null
                            status: active
                        brands: []
                        status: pending
                        type: seller_to_affiliate
                        created_at: 1717206650
                      -
                        id: alg@X2Zq8RbnvPz0wM56WEoz
                        affiliate:
                          id: alg@7b9ZAVdemE2voXyxNPR8
                          name: 'Philip J. Fry'
                          avatar: ''
                        products:
                          -
                            id: alg@NOb3Z51n0VaK8odBjrJe
                            name: 'Ratione vel esse explicabo et error sed amet.'
                            image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                            asin: null
                            sub_category:
                              id: alg@8MEDr2kvAknB0W43jVZx
                              name: Highlighters
                            main_category: null
                            brand:
                              id: alg@rVkgED43KDgvRnx61lNz
                              name: 'Ada Fisher'
                              image: ''
                            best_seller_rank: null
                            rating: '1.0'
                            amazon_link: 'http://larkin.com/voluptatem-esse-eum-sapiente-beatae-deleniti?m=6102970121'
                            price: '10.00'
                            profit: 0
                            commission: null
                            commission_type: null
                            status: active
                        brands: []
                        status: pending
                        type: seller_to_affiliate
                        created_at: 1717206059
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg@DE4wXVog0ow0kJNGq5dM
                        seller:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg@bANMR19W0j1qKqBQDrOY
                            name:
                              type: string
                              example: 'Austyn Hackett'
                            avatar:
                              type: string
                              example: ''
                        products:
                          type: array
                          example:
                            -
                              id: alg@jP9WoOz4mbVm2Ee3ALDk
                              name: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                              image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                              asin: null
                              sub_category:
                                id: alg@36J12ON0NdrqvYVPDeLw
                                name: 'Action & Adventure'
                              main_category: null
                              brand:
                                id: alg@l9xnzAZ50B20eaW8XEBw
                                name: 'Prof. Edwina Lynch'
                                image: ''
                              best_seller_rank: null
                              rating: '4.9'
                              amazon_link: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                              price: '10.00'
                              profit: 0
                              commission: null
                              commission_type: null
                              is_custom_commission: false
                              status: active
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: alg@jP9WoOz4mbVm2Ee3ALDk
                              name:
                                type: string
                                example: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                              image:
                                type: string
                                example: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                              asin:
                                type: string
                                example: null
                              sub_category:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: alg@36J12ON0NdrqvYVPDeLw
                                  name:
                                    type: string
                                    example: 'Action & Adventure'
                              main_category:
                                type: string
                                example: null
                              brand:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: alg@l9xnzAZ50B20eaW8XEBw
                                  name:
                                    type: string
                                    example: 'Prof. Edwina Lynch'
                                  image:
                                    type: string
                                    example: ''
                              best_seller_rank:
                                type: string
                                example: null
                              rating:
                                type: string
                                example: '4.9'
                              amazon_link:
                                type: string
                                example: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                              price:
                                type: string
                                example: '10.00'
                              profit:
                                type: integer
                                example: 0
                              commission:
                                type: string
                                example: null
                              commission_type:
                                type: string
                                example: null
                              is_custom_commission:
                                type: boolean
                                example: false
                              status:
                                type: string
                                example: active
                        brands:
                          type: array
                          example: []
                        status:
                          type: string
                          example: pending
                        type:
                          type: string
                          example: seller_to_affiliate
                        created_at:
                          type: integer
                          example: 1717208058
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 4
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'partnership fetched successfully'
      tags:
        - Partnership
  /affiliate/v1/products:
    get:
      summary: 'Product List'
      operationId: productList
      description: 'Get a paginated list of products from Amazon or Shopify platform.'
      parameters:
        -
          in: query
          name: platform
          description: "optional string The platform to fetch products from. Must be either 'amazon' or 'shopify' if provided."
          example: amazon
          required: false
          schema:
            type: string
            description: "optional string The platform to fetch products from. Must be either 'amazon' or 'shopify' if provided."
            example: amazon
        -
          in: query
          name: query
          description: 'optional string for search in product name.'
          example: 'product name'
          required: false
          schema:
            type: string
            description: 'optional string for search in product name.'
            example: 'product name'
        -
          in: query
          name: 'category_ids[]'
          description: 'optional array number for filter product category.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product category.'
            example: 1
        -
          in: query
          name: 'brand_ids[]'
          description: 'optional array number for filter product brand.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product brand.'
            example: 1
        -
          in: query
          name: 'shopify_profile_ids[]'
          description: 'optional array int for Shopify: filter by ShopifyAccountStore ids.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array int for Shopify: filter by ShopifyAccountStore ids.'
            example: 1
        -
          in: query
          name: 'seller_ids[]'
          description: 'optional array number for filter product seller.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product seller.'
            example: 1
        -
          in: query
          name: price_from
          description: 'optional number for filter product minimum price.'
          example: 1000
          required: false
          schema:
            type: integer
            description: 'optional number for filter product minimum price.'
            example: 1000
        -
          in: query
          name: price_to
          description: 'optional number for filter product maximum price.'
          example: 2000
          required: false
          schema:
            type: integer
            description: 'optional number for filter product maximum price.'
            example: 2000
        -
          in: query
          name: commission_from
          description: 'optional number for filter product minimum commission.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'optional number for filter product minimum commission.'
            example: 10
        -
          in: query
          name: commission_to
          description: 'optional number for filter product maximum commission.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'optional number for filter product maximum commission.'
            example: 15
        -
          in: query
          name: rating_from
          description: 'optional number for filter product minimum rating.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional number for filter product minimum rating.'
            example: 1
        -
          in: query
          name: rating_to
          description: 'optional number for filter product maximum rating.'
          example: 5
          required: false
          schema:
            type: integer
            description: 'optional number for filter product maximum rating.'
            example: 5
        -
          in: query
          name: review_count_from
          description: 'optional number for filter product minimum review count.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'optional number for filter product minimum review count.'
            example: 10
        -
          in: query
          name: review_count_to
          description: 'optional number for filter product maximum review count.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'optional number for filter product maximum review count.'
            example: 20
        -
          in: query
          name: partnership_status
          description: 'optional string for filter partnership status.'
          example: 'partnered or not_partnered'
          required: false
          schema:
            type: string
            description: 'optional string for filter partnership status.'
            example: 'partnered or not_partnered'
        -
          in: query
          name: availability
          description: 'optional string for filter availability.'
          example: 'in_stock, out_of_stock, in_stock_scarce, leadtime, available_date, removed, preorder'
          required: false
          schema:
            type: string
            description: 'optional string for filter availability.'
            example: 'in_stock, out_of_stock, in_stock_scarce, leadtime, available_date, removed, preorder'
        -
          in: query
          name: one_promote
          description: 'optional bool for filter auto_approval_brand.'
          example: 'true or false'
          required: false
          schema:
            type: string
            description: 'optional bool for filter auto_approval_brand.'
            example: 'true or false'
        -
          in: query
          name: 'order_by[id]'
          description: 'optional string for sort by id can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by id can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[name]'
          description: 'optional string for sort by name can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by name can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[main_category]'
          description: 'optional string for sort by category can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by category can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[brand]'
          description: 'optional string for sort by brand can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by brand can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[best_seller_rank]'
          description: 'optional string for sort by bsr can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by bsr can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[user]'
          description: 'optional string for sort by seller can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by seller can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[amazon_price]'
          description: 'optional string for sort by price can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by price can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[rating]'
          description: 'optional string for sort by rating can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by rating can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[review_count]'
          description: 'optional string for sort by review_count can include: asc or desc.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'optional string for sort by review_count can include: asc or desc.'
            example: 0
        -
          in: query
          name: 'order_by[commission]'
          description: 'optional string for sort by commission can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by commission can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[has_promotion]'
          description: 'optional string for sort by has_promotion can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by has_promotion can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[partnership_status]'
          description: 'optional string for sort by partnership_status can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by partnership_status can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[availability]'
          description: 'optional string for sort by availability can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by availability can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[status]'
          description: 'optional string for sort by status can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by status can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[featured]'
          description: 'optional string for sort by featured can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by featured can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[highest_profit]'
          description: 'optional string for sort by highest_profit can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by highest_profit can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[recommended]'
          description: 'optional string for sort by recommended can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by recommended can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[popular]'
          description: 'optional string for sort by popular can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by popular can include: asc or desc.'
            example: desc
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  message: Unauthenticated.
                  data: []
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: Unauthenticated.
                  data:
                    type: array
                    example: []
      tags:
        - Product
  '/affiliate/v1/products/{id}':
    get:
      summary: 'Product Show'
      operationId: productShow
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: alg_lMWxe1baKXVm9gLnX8Qz
                    name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                    main_category:
                      id: alg_QlAxz9rvWoRdv85OwqoD
                      name: 'Beauty & Personal Care'
                    sub_category:
                      id: alg_98ZOV1r0l5aMmPXE3aL2
                      name: 'Waxing Kits'
                    images:
                      - 'https://m.media-amazon.com/images/I/81UaTcwVIFL.jpg'
                      - 'https://m.media-amazon.com/images/I/81s87rI-tKL.jpg'
                      - 'https://m.media-amazon.com/images/I/81R7izbTqUL.jpg'
                      - 'https://m.media-amazon.com/images/I/81TIrg-LUCL.jpg'
                      - 'https://m.media-amazon.com/images/I/71HlLZ-GI7L.jpg'
                      - 'https://m.media-amazon.com/images/I/81ytHRmbk+L.jpg'
                    details: []
                    description:
                      - "✅ EVERYTHING YOU NEED - Our self waxing kit set has all the tools you need to remove unwanted hair from head to toe. You'll get a wax warmer device, 200 Grams of Blue Wax Beads, Two Different Type of Wooden Spatulas for Face and Body, Nose Applicators and a Electric Nose Hair Trimmer, Cooling gel pad, and Hair Removal Scissors."
                      - '✅ EFFECTIVE HAIR REMOVAL - This home wax kit effectively facilitates the removal of even the shortest and finest hair. Keep your legs, armpits, and skin flawless, smooth and fuzz-free for longer.'
                      - '✅ WORKS WITH YOUR PREFERRED WAX - Designed to work with different types of waxes, our warmer lets you use what works best for you. You can go for beans, beads, block, Brazilian, hard, or canned wax.'
                      - '✅ EASY TO USE WAX KIT - We provide step-by-step instructions that are easy to follow. You can easily adjust the heating temperature of our wax warmer device using its manual setting knob.'
                      - '✅ SAVE TIME & MONEY! - Salon visits are not only expensive, but they also take time. Our professional-grade wax hair removal kit lets you complete your waxing session from the comfort of your home.'
                    amazon_link: 'https://www.amazon.com/dp/B07YLG56B2'
                    asin: B07YLG56B2
                    best_seller_rank: 146
                    rating: '4.3'
                    amazon_price: '36.75'
                    review_count: 313
                    commission: '40.00'
                    commission_type: percent
                    yppu: 14.7
                    brand:
                      id: alg_g4rlB87nvyZKzZG5YEw1
                      name: Emprian
                      image: ''
                      amazon_link: null
                      commission: '23.33'
                      commission_type: percent
                      terms_file: ''
                    seller:
                      id: alg_PWZ7nGw8vJQ1m4R1aX9M
                      name: S.Ahmad
                      avatar: ''
                      user_type: 'Pro Seller'
                      is_plan_free: false
                    promotions:
                      -
                        id: alg_7b9ZAVdemE2voXyxNPR8
                        name: saaa
                        value_type: percent
                        value: '32.00'
                        start_date: 1717286400
                        end_date: 1876521600
                        is_public: true
                    affiliateProductLinks:
                      -
                        id: alg_JWq3xEoGKgWKLXyMrRA2
                        display_name: test
                        is_default: false
                        is_system: false
                        seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                        product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        product_category_name: 'Waxing Kits'
                        brand_name: Emprian
                        source:
                          id: alg_7b9ZAVdemE2voXyxNPR8
                          primary_id: test2
                          display_name: test1
                          sub_id: test2
                        link: 'https://buy.ainfluencer.com/product-link/alg_JWq3xEoGKgWKLXyMrRA2'
                        affiliate_amazon_tag: null
                        promotion: null
                        landing_page: null
                        created_at: 1715979891
                      -
                        id: alg_lZ2YpjWqvzamaoO79dDN
                        display_name: stesatasdf
                        is_default: false
                        is_system: false
                        seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                        product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        product_category_name: 'Waxing Kits'
                        brand_name: Emprian
                        source:
                          id: alg_7b9ZAVdemE2voXyxNPR8
                          primary_id: test2
                          display_name: test1
                          sub_id: test2
                        link: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                        affiliate_amazon_tag: null
                        promotion:
                          id: alg_7b9ZAVdemE2voXyxNPR8
                          value: '32.00'
                          value_type: percent
                        landing_page: null
                        created_at: 1718748552
                      -
                        id: alg_rZnBN5Wb01E0kX132Olq
                        display_name: Default
                        is_default: true
                        is_system: true
                        seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                        product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        product_category_name: 'Waxing Kits'
                        brand_name: Emprian
                        source: null
                        link: 'https://buy.ainfluencer.com/product-link/alg_rZnBN5Wb01E0kX132Olq'
                        affiliate_amazon_tag: null
                        promotion: null
                        landing_page: null
                        created_at: 1718912840
                    partnership_status: partnered
                    availability: out_of_stock
                    status: active
                    total_commission_paid: 1550
                    active_partnership_request: null
                    page_views: 1583
                    total_sales: 260
                    commission_paid: '1350'
                    has_product_partnership: false
                  status: success
                  message: 'product fetched successfully'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: alg_lMWxe1baKXVm9gLnX8Qz
                      name:
                        type: string
                        example: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                      main_category:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_QlAxz9rvWoRdv85OwqoD
                          name:
                            type: string
                            example: 'Beauty & Personal Care'
                      sub_category:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_98ZOV1r0l5aMmPXE3aL2
                          name:
                            type: string
                            example: 'Waxing Kits'
                      images:
                        type: array
                        example:
                          - 'https://m.media-amazon.com/images/I/81UaTcwVIFL.jpg'
                          - 'https://m.media-amazon.com/images/I/81s87rI-tKL.jpg'
                          - 'https://m.media-amazon.com/images/I/81R7izbTqUL.jpg'
                          - 'https://m.media-amazon.com/images/I/81TIrg-LUCL.jpg'
                          - 'https://m.media-amazon.com/images/I/71HlLZ-GI7L.jpg'
                          - 'https://m.media-amazon.com/images/I/81ytHRmbk+L.jpg'
                        items:
                          type: string
                      details:
                        type: array
                        example: []
                      description:
                        type: array
                        example:
                          - "✅ EVERYTHING YOU NEED - Our self waxing kit set has all the tools you need to remove unwanted hair from head to toe. You'll get a wax warmer device, 200 Grams of Blue Wax Beads, Two Different Type of Wooden Spatulas for Face and Body, Nose Applicators and a Electric Nose Hair Trimmer, Cooling gel pad, and Hair Removal Scissors."
                          - '✅ EFFECTIVE HAIR REMOVAL - This home wax kit effectively facilitates the removal of even the shortest and finest hair. Keep your legs, armpits, and skin flawless, smooth and fuzz-free for longer.'
                          - '✅ WORKS WITH YOUR PREFERRED WAX - Designed to work with different types of waxes, our warmer lets you use what works best for you. You can go for beans, beads, block, Brazilian, hard, or canned wax.'
                          - '✅ EASY TO USE WAX KIT - We provide step-by-step instructions that are easy to follow. You can easily adjust the heating temperature of our wax warmer device using its manual setting knob.'
                          - '✅ SAVE TIME & MONEY! - Salon visits are not only expensive, but they also take time. Our professional-grade wax hair removal kit lets you complete your waxing session from the comfort of your home.'
                        items:
                          type: string
                      amazon_link:
                        type: string
                        example: 'https://www.amazon.com/dp/B07YLG56B2'
                      asin:
                        type: string
                        example: B07YLG56B2
                      best_seller_rank:
                        type: integer
                        example: 146
                      rating:
                        type: string
                        example: '4.3'
                      amazon_price:
                        type: string
                        example: '36.75'
                      review_count:
                        type: integer
                        example: 313
                      commission:
                        type: string
                        example: '40.00'
                      commission_type:
                        type: string
                        example: percent
                      yppu:
                        type: number
                        example: 14.7
                      brand:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_g4rlB87nvyZKzZG5YEw1
                          name:
                            type: string
                            example: Emprian
                          image:
                            type: string
                            example: ''
                          amazon_link:
                            type: string
                            example: null
                          commission:
                            type: string
                            example: '23.33'
                          commission_type:
                            type: string
                            example: percent
                          terms_file:
                            type: string
                            example: ''
                      seller:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_PWZ7nGw8vJQ1m4R1aX9M
                          name:
                            type: string
                            example: S.Ahmad
                          avatar:
                            type: string
                            example: ''
                          user_type:
                            type: string
                            example: 'Pro Seller'
                          is_plan_free:
                            type: boolean
                            example: false
                      promotions:
                        type: array
                        example:
                          -
                            id: alg_7b9ZAVdemE2voXyxNPR8
                            name: saaa
                            value_type: percent
                            value: '32.00'
                            start_date: 1717286400
                            end_date: 1876521600
                            is_public: true
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_7b9ZAVdemE2voXyxNPR8
                            name:
                              type: string
                              example: saaa
                            value_type:
                              type: string
                              example: percent
                            value:
                              type: string
                              example: '32.00'
                            start_date:
                              type: integer
                              example: 1717286400
                            end_date:
                              type: integer
                              example: 1876521600
                            is_public:
                              type: boolean
                              example: true
                      affiliateProductLinks:
                        type: array
                        example:
                          -
                            id: alg_JWq3xEoGKgWKLXyMrRA2
                            display_name: test
                            is_default: false
                            is_system: false
                            seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                            product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                            product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                            product_category_name: 'Waxing Kits'
                            brand_name: Emprian
                            source:
                              id: alg_7b9ZAVdemE2voXyxNPR8
                              primary_id: test2
                              display_name: test1
                              sub_id: test2
                            link: 'https://buy.ainfluencer.com/product-link/alg_JWq3xEoGKgWKLXyMrRA2'
                            affiliate_amazon_tag: null
                            promotion: null
                            landing_page: null
                            created_at: 1715979891
                          -
                            id: alg_lZ2YpjWqvzamaoO79dDN
                            display_name: stesatasdf
                            is_default: false
                            is_system: false
                            seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                            product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                            product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                            product_category_name: 'Waxing Kits'
                            brand_name: Emprian
                            source:
                              id: alg_7b9ZAVdemE2voXyxNPR8
                              primary_id: test2
                              display_name: test1
                              sub_id: test2
                            link: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                            affiliate_amazon_tag: null
                            promotion:
                              id: alg_7b9ZAVdemE2voXyxNPR8
                              value: '32.00'
                              value_type: percent
                            landing_page: null
                            created_at: 1718748552
                          -
                            id: alg_rZnBN5Wb01E0kX132Olq
                            display_name: Default
                            is_default: true
                            is_system: true
                            seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                            product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                            product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                            product_category_name: 'Waxing Kits'
                            brand_name: Emprian
                            source: null
                            link: 'https://buy.ainfluencer.com/product-link/alg_rZnBN5Wb01E0kX132Olq'
                            affiliate_amazon_tag: null
                            promotion: null
                            landing_page: null
                            created_at: 1718912840
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_JWq3xEoGKgWKLXyMrRA2
                            display_name:
                              type: string
                              example: test
                            is_default:
                              type: boolean
                              example: false
                            is_system:
                              type: boolean
                              example: false
                            seller_product_id:
                              type: string
                              example: alg_lMWxe1baKXVm9gLnX8Qz
                            product_name:
                              type: string
                              example: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                            product_image:
                              type: string
                              example: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                            product_category_name:
                              type: string
                              example: 'Waxing Kits'
                            brand_name:
                              type: string
                              example: Emprian
                            source:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: alg_7b9ZAVdemE2voXyxNPR8
                                primary_id:
                                  type: string
                                  example: test2
                                display_name:
                                  type: string
                                  example: test1
                                sub_id:
                                  type: string
                                  example: test2
                            link:
                              type: string
                              example: 'https://buy.ainfluencer.com/product-link/alg_JWq3xEoGKgWKLXyMrRA2'
                            affiliate_amazon_tag:
                              type: string
                              example: null
                            promotion:
                              type: string
                              example: null
                            landing_page:
                              type: string
                              example: null
                            created_at:
                              type: integer
                              example: 1715979891
                      partnership_status:
                        type: string
                        example: partnered
                      availability:
                        type: string
                        example: out_of_stock
                      status:
                        type: string
                        example: active
                      total_commission_paid:
                        type: integer
                        example: 1550
                      active_partnership_request:
                        type: string
                        example: null
                      page_views:
                        type: integer
                        example: 1583
                      total_sales:
                        type: integer
                        example: 260
                      commission_paid:
                        type: string
                        example: '1350'
                      has_product_partnership:
                        type: boolean
                        example: false
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'product fetched successfully'
      tags:
        - Product
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the Product .'
        example: '2'
        required: true
        schema:
          type: string
  '/affiliate/v1/products/{id}/variations':
    get:
      summary: 'Product Variation List'
      operationId: productVariationList
      description: ''
      parameters:
        -
          in: query
          name: 'order_by[price]'
          description: 'optional string for sort by price can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by price can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[commission]'
          description: 'optional string for sort by commission can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by commission can include: asc or desc.'
            example: desc
        -
          in: query
          name: 'order_by[name]'
          description: 'optional string for sort by name can include: asc or desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'optional string for sort by name can include: asc or desc.'
            example: desc
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg@jP9WoOz4mbVm2Ee3ALDk
                      name: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                      image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                      asin: q123eefw5
                      brand: brand
                      rating: '4.9'
                      price: '10.00'
                      commission: '20.00'
                      commission_type: percent
                      link: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 1
                  status: success
                  message: 'products fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg@jP9WoOz4mbVm2Ee3ALDk
                        name: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                        image: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                        asin: q123eefw5
                        brand: brand
                        rating: '4.9'
                        price: '10.00'
                        commission: '20.00'
                        commission_type: percent
                        link: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg@jP9WoOz4mbVm2Ee3ALDk
                        name:
                          type: string
                          example: 'Quia placeat cum sit voluptas et officiis eaque minima.'
                        image:
                          type: string
                          example: 'https://m.media-amazon.com/images/I/41DusbJFRoL._AA64_.jpg'
                        asin:
                          type: string
                          example: q123eefw5
                        brand:
                          type: string
                          example: brand
                        rating:
                          type: string
                          example: '4.9'
                        price:
                          type: string
                          example: '10.00'
                        commission:
                          type: string
                          example: '20.00'
                        commission_type:
                          type: string
                          example: percent
                        link:
                          type: string
                          example: 'http://www.bechtelar.com/repudiandae-vitae-commodi-dignissimos-deserunt-nisi-veritatis-ut?m=6102970121'
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 1
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'products fetched successfully'
      tags:
        - Product
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the product.'
        example: architecto
        required: true
        schema:
          type: string
  /affiliate/v1/products/links/sources:
    get:
      summary: 'Product Link Source List'
      operationId: productLinkSourceList
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                  message: 'Product link source fetched successfully'
                  data:
                    -
                      primary_id: 121212
                      display_name: Tests
                      sub_id: 1212
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'Product link source fetched successfully'
                  data:
                    type: array
                    example:
                      -
                        primary_id: 121212
                        display_name: Tests
                        sub_id: 1212
                    items:
                      type: object
                      properties:
                        primary_id:
                          type: integer
                          example: 121212
                        display_name:
                          type: string
                          example: Tests
                        sub_id:
                          type: integer
                          example: 1212
      tags:
        - 'Product Link'
    post:
      summary: 'Create Product Link Source'
      operationId: createProductLinkSource
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'affiliate product Link Source created successfully',\n  'data'=>{\n      \"id\":87922,\n      \"name\":\"Roberta Fay\",\n      \"username\":\"simonis.chelsie\",\n      \"email\":\"example@gmail.com\",\n    }\n}"
      tags:
        - 'Product Link'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                primary_id:
                  type: string
                  description: 'source primary id. Must not be greater than 255 characters.'
                  example: '25441'
                display_name:
                  type: string
                  description: 'source display name. Must not be greater than 255 characters.'
                  example: Facebook
                sub_id:
                  type: string
                  description: 'source sub id.'
                  example: '25443'
                  nullable: true
              required:
                - primary_id
                - display_name
  '/affiliate/v1/products/links/sources/{productLinkSourceId}':
    get:
      summary: 'Show Product Link Source'
      operationId: showProductLinkSource
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n   \"status\":\"success\",\n   \"message\":\"Data fetched successfully\",\n   \"data\":{\n      \"id\":87922,\n      \"name\":\"Roberta Fay\",\n      \"username\":\"simonis.chelsie\",\n      \"email\":\"example@gmail.com\",\n    }\n}"
      tags:
        - 'Product Link'
    put:
      summary: 'Update Product Link Source'
      operationId: updateProductLinkSource
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'product Link updated successfully',\n  'data'=>[]\n}"
      tags:
        - 'Product Link'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                primary_id:
                  type: string
                  description: 'source primary id. Must not be greater than 255 characters.'
                  example: '25441'
                display_name:
                  type: string
                  description: 'source display name. Must not be greater than 255 characters.'
                  example: Facebook
                sub_id:
                  type: string
                  description: 'source sub id.'
                  example: '25443'
                  nullable: true
              required:
                - primary_id
                - display_name
    delete:
      summary: 'Delete Product Link'
      operationId: deleteProductLink
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'product Link deleted successfully',\n  'data'=>[]\n}"
      tags:
        - 'Product Link'
    parameters:
      -
        in: path
        name: productLinkSourceId
        description: ''
        example: architecto
        required: true
        schema:
          type: string
  /affiliate/v1/products/links:
    get:
      summary: 'Link List'
      operationId: linkList
      description: ''
      parameters:
        -
          in: query
          name: query
          description: 'optional string for search in product name or tracking number .'
          example: 0
          required: false
          schema:
            type: integer
            description: 'optional string for search in product name or tracking number .'
            example: 0
        -
          in: query
          name: 'category_ids[]'
          description: 'optional array number for filter product category.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product category.'
            example: 1
        -
          in: query
          name: 'brand_ids[]'
          description: 'optional array number for filter product brand.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product brand.'
            example: 1
        -
          in: query
          name: 'product_ids[]'
          description: 'optional array number for filter product .'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter product .'
            example: 1
        -
          in: query
          name: 'source_ids[]'
          description: 'optional array number for filter source .'
          example: 1
          required: false
          schema:
            type: integer
            description: 'optional array number for filter source .'
            example: 1
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg_JWq3xEoGKgWKLXyMrRA2
                      display_name: test
                      is_default: false
                      is_system: false
                      seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                      product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                      product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                      product_category_name: 'Waxing Kits'
                      brand_name: Emprian
                      source:
                        id: alg_7b9ZAVdemE2voXyxNPR8
                        primary_id: test2
                        display_name: test1
                        sub_id: test2
                      link: 'https://buy.ainfluencer.com/product-link/alg_JWq3xEoGKgWKLXyMrRA2'
                      affiliate_amazon_tag: null
                      promotion: null
                      landing_page: null
                      created_at: 1715979891
                    -
                      id: alg_lZ2YpjWqvzamaoO79dDN
                      display_name: stesatasdf
                      is_default: false
                      is_system: false
                      seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                      product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                      product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                      product_category_name: 'Waxing Kits'
                      brand_name: Emprian
                      source:
                        id: alg_7b9ZAVdemE2voXyxNPR8
                        primary_id: test2
                        display_name: test1
                        sub_id: test2
                      link: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                      affiliate_amazon_tag: null
                      promotion:
                        id: alg_7b9ZAVdemE2voXyxNPR8
                        value: '32.00'
                        value_type: percent
                      landing_page: null
                      created_at: 1718748552
                    -
                      id: alg_rZnBN5Wb01E0kX132Olq
                      display_name: Default
                      is_default: true
                      is_system: true
                      seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                      product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                      product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                      product_category_name: 'Waxing Kits'
                      brand_name: Emprian
                      source: null
                      link: 'https://buy.ainfluencer.com/product-link/alg_rZnBN5Wb01E0kX132Olq'
                      affiliate_amazon_tag: null
                      promotion: null
                      landing_page: null
                      created_at: 1718912840
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 3
                  status: success
                  message: 'affiliate product link fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg_JWq3xEoGKgWKLXyMrRA2
                        display_name: test
                        is_default: false
                        is_system: false
                        seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                        product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        product_category_name: 'Waxing Kits'
                        brand_name: Emprian
                        source:
                          id: alg_7b9ZAVdemE2voXyxNPR8
                          primary_id: test2
                          display_name: test1
                          sub_id: test2
                        link: 'https://buy.ainfluencer.com/product-link/alg_JWq3xEoGKgWKLXyMrRA2'
                        affiliate_amazon_tag: null
                        promotion: null
                        landing_page: null
                        created_at: 1715979891
                      -
                        id: alg_lZ2YpjWqvzamaoO79dDN
                        display_name: stesatasdf
                        is_default: false
                        is_system: false
                        seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                        product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        product_category_name: 'Waxing Kits'
                        brand_name: Emprian
                        source:
                          id: alg_7b9ZAVdemE2voXyxNPR8
                          primary_id: test2
                          display_name: test1
                          sub_id: test2
                        link: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                        affiliate_amazon_tag: null
                        promotion:
                          id: alg_7b9ZAVdemE2voXyxNPR8
                          value: '32.00'
                          value_type: percent
                        landing_page: null
                        created_at: 1718748552
                      -
                        id: alg_rZnBN5Wb01E0kX132Olq
                        display_name: Default
                        is_default: true
                        is_system: true
                        seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                        product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        product_category_name: 'Waxing Kits'
                        brand_name: Emprian
                        source: null
                        link: 'https://buy.ainfluencer.com/product-link/alg_rZnBN5Wb01E0kX132Olq'
                        affiliate_amazon_tag: null
                        promotion: null
                        landing_page: null
                        created_at: 1718912840
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg_JWq3xEoGKgWKLXyMrRA2
                        display_name:
                          type: string
                          example: test
                        is_default:
                          type: boolean
                          example: false
                        is_system:
                          type: boolean
                          example: false
                        seller_product_id:
                          type: string
                          example: alg_lMWxe1baKXVm9gLnX8Qz
                        product_name:
                          type: string
                          example: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        product_image:
                          type: string
                          example: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        product_category_name:
                          type: string
                          example: 'Waxing Kits'
                        brand_name:
                          type: string
                          example: Emprian
                        source:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_7b9ZAVdemE2voXyxNPR8
                            primary_id:
                              type: string
                              example: test2
                            display_name:
                              type: string
                              example: test1
                            sub_id:
                              type: string
                              example: test2
                        link:
                          type: string
                          example: 'https://buy.ainfluencer.com/product-link/alg_JWq3xEoGKgWKLXyMrRA2'
                        affiliate_amazon_tag:
                          type: string
                          example: null
                        promotion:
                          type: string
                          example: null
                        landing_page:
                          type: string
                          example: null
                        created_at:
                          type: integer
                          example: 1715979891
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 3
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'affiliate product link fetched successfully'
      tags:
        - 'Product Link'
    post:
      summary: 'Create Product Link'
      operationId: createProductLink
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                  message: 'affiliate product link fetched successfully'
                  data:
                    id: alg_lZ2YpjWqvzamaoO79dDN
                    display_name: stesatasdf
                    is_default: false
                    is_system: false
                    seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                    product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                    product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                    product_category_name: 'Waxing Kits'
                    brand_name: Emprian
                    source:
                      id: alg_7b9ZAVdemE2voXyxNPR8
                      primary_id: test2
                      display_name: test1
                      sub_id: test2
                    link: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                    affiliate_amazon_tag: null
                    promotion:
                      id: alg_7b9ZAVdemE2voXyxNPR8
                      value: '32.00'
                      value_type: percent
                    landing_page:
                      id: alg_l9xnzAZ50B20eaW8XEBw
                      name: 'My landing page2'
                      template:
                        id: alg_rVkgED43KDgvRnx61lNz
                        title: 'Right Side - Purple'
                        content: "Et magni quia qui dicta nobis. Nostrum nihil rerum ipsa sit architecto et voluptatem.\n\nCommodi qui fuga illum saepe culpa sit. Quam odit sed laborum corrupti sapiente.\n\nAut nemo sequi qui aut illum facilis voluptas. Est molestiae non molestiae magni iusto. Necessitatibus asperiores sint eligendi sit. Et enim cupiditate dicta dignissimos voluptatem. Repudiandae iusto commodi rerum deserunt qui quo."
                        thumbnail: right-purple.png
                        grid_id: 3
                        color_id: 2
                    created_at: 1718748552
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'affiliate product link fetched successfully'
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: alg_lZ2YpjWqvzamaoO79dDN
                      display_name:
                        type: string
                        example: stesatasdf
                      is_default:
                        type: boolean
                        example: false
                      is_system:
                        type: boolean
                        example: false
                      seller_product_id:
                        type: string
                        example: alg_lMWxe1baKXVm9gLnX8Qz
                      product_name:
                        type: string
                        example: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                      product_image:
                        type: string
                        example: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                      product_category_name:
                        type: string
                        example: 'Waxing Kits'
                      brand_name:
                        type: string
                        example: Emprian
                      source:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_7b9ZAVdemE2voXyxNPR8
                          primary_id:
                            type: string
                            example: test2
                          display_name:
                            type: string
                            example: test1
                          sub_id:
                            type: string
                            example: test2
                      link:
                        type: string
                        example: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                      affiliate_amazon_tag:
                        type: string
                        example: null
                      promotion:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_7b9ZAVdemE2voXyxNPR8
                          value:
                            type: string
                            example: '32.00'
                          value_type:
                            type: string
                            example: percent
                      landing_page:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_l9xnzAZ50B20eaW8XEBw
                          name:
                            type: string
                            example: 'My landing page2'
                          template:
                            type: object
                            properties:
                              id:
                                type: string
                                example: alg_rVkgED43KDgvRnx61lNz
                              title:
                                type: string
                                example: 'Right Side - Purple'
                              content:
                                type: string
                                example: "Et magni quia qui dicta nobis. Nostrum nihil rerum ipsa sit architecto et voluptatem.\n\nCommodi qui fuga illum saepe culpa sit. Quam odit sed laborum corrupti sapiente.\n\nAut nemo sequi qui aut illum facilis voluptas. Est molestiae non molestiae magni iusto. Necessitatibus asperiores sint eligendi sit. Et enim cupiditate dicta dignissimos voluptatem. Repudiandae iusto commodi rerum deserunt qui quo."
                              thumbnail:
                                type: string
                                example: right-purple.png
                              grid_id:
                                type: integer
                                example: 3
                              color_id:
                                type: integer
                                example: 2
                      created_at:
                        type: integer
                        example: 1718748552
      tags:
        - 'Product Link'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                seller_product_id:
                  type: integer
                  description: 'seller product id. The <code>id</code> of an existing record in the seller_products table.'
                  example: 1
                landing_page_id:
                  type: integer
                  description: 'landing page id. The <code>id</code> of an existing record in the landing_pages table.'
                  example: 1
                seller_promotion_id:
                  type: integer
                  description: 'seller promotion id. The <code>id</code> of an existing record in the seller_promotions table.'
                  example: 1
                  nullable: true
                display_name:
                  type: string
                  description: 'display name.'
                  example: 'Maud Ward'
                  nullable: true
                source_id:
                  type: integer
                  description: 'product link source id. This field is required when <code>source</code> is not present. The <code>id</code> of an existing record in the affiliate_product_link_sources table.'
                  example: 1
                source:
                  type: object
                  description: 'This field is required when <code>source_id</code> is not present.'
                  example: null
                  properties:
                    name:
                      type: string
                      description: 'This field is required when <code>source</code> is present.'
                      example: architecto
                    primary_id:
                      type: string
                      description: 'This field is required when <code>source</code> is present.'
                      example: architecto
                    sub_id:
                      type: string
                      description: ''
                      example: architecto
                      nullable: true
                is_default:
                  type: boolean
                  description: 'Is default product link.'
                  example: false
              required:
                - seller_product_id
                - landing_page_id
  '/affiliate/v1/products/links/set-default/{productLinkId}':
    post:
      summary: 'Set default product link'
      operationId: setDefaultProductLink
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'Default product link set successfully',\n  'data'=>[]\n}"
      tags:
        - 'Product Link'
    parameters:
      -
        in: path
        name: productLinkId
        description: ''
        example: architecto
        required: true
        schema:
          type: string
  '/affiliate/v1/products/links/{productLinkId}':
    get:
      summary: 'Show Product Link'
      operationId: showProductLink
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                  message: 'affiliate product link fetched successfully'
                  data:
                    id: alg_lZ2YpjWqvzamaoO79dDN
                    display_name: stesatasdf
                    is_default: false
                    is_system: false
                    seller_product_id: alg_lMWxe1baKXVm9gLnX8Qz
                    product_name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                    product_image: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                    product_category_name: 'Waxing Kits'
                    brand_name: Emprian
                    source:
                      id: alg_7b9ZAVdemE2voXyxNPR8
                      primary_id: test2
                      display_name: test1
                      sub_id: test2
                    link: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                    affiliate_amazon_tag: null
                    promotion:
                      id: alg_7b9ZAVdemE2voXyxNPR8
                      value: '32.00'
                      value_type: percent
                    landing_page:
                      id: alg_l9xnzAZ50B20eaW8XEBw
                      name: 'My landing page2'
                      template:
                        id: alg_rVkgED43KDgvRnx61lNz
                        title: 'Right Side - Purple'
                        content: "Et magni quia qui dicta nobis. Nostrum nihil rerum ipsa sit architecto et voluptatem.\n\nCommodi qui fuga illum saepe culpa sit. Quam odit sed laborum corrupti sapiente.\n\nAut nemo sequi qui aut illum facilis voluptas. Est molestiae non molestiae magni iusto. Necessitatibus asperiores sint eligendi sit. Et enim cupiditate dicta dignissimos voluptatem. Repudiandae iusto commodi rerum deserunt qui quo."
                        thumbnail: right-purple.png
                        grid_id: 3
                        color_id: 2
                    created_at: 1718748552
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'affiliate product link fetched successfully'
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: alg_lZ2YpjWqvzamaoO79dDN
                      display_name:
                        type: string
                        example: stesatasdf
                      is_default:
                        type: boolean
                        example: false
                      is_system:
                        type: boolean
                        example: false
                      seller_product_id:
                        type: string
                        example: alg_lMWxe1baKXVm9gLnX8Qz
                      product_name:
                        type: string
                        example: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                      product_image:
                        type: string
                        example: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                      product_category_name:
                        type: string
                        example: 'Waxing Kits'
                      brand_name:
                        type: string
                        example: Emprian
                      source:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_7b9ZAVdemE2voXyxNPR8
                          primary_id:
                            type: string
                            example: test2
                          display_name:
                            type: string
                            example: test1
                          sub_id:
                            type: string
                            example: test2
                      link:
                        type: string
                        example: 'https://buy.ainfluencer.com/product-link/alg_lZ2YpjWqvzamaoO79dDN'
                      affiliate_amazon_tag:
                        type: string
                        example: null
                      promotion:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_7b9ZAVdemE2voXyxNPR8
                          value:
                            type: string
                            example: '32.00'
                          value_type:
                            type: string
                            example: percent
                      landing_page:
                        type: object
                        properties:
                          id:
                            type: string
                            example: alg_l9xnzAZ50B20eaW8XEBw
                          name:
                            type: string
                            example: 'My landing page2'
                          template:
                            type: object
                            properties:
                              id:
                                type: string
                                example: alg_rVkgED43KDgvRnx61lNz
                              title:
                                type: string
                                example: 'Right Side - Purple'
                              content:
                                type: string
                                example: "Et magni quia qui dicta nobis. Nostrum nihil rerum ipsa sit architecto et voluptatem.\n\nCommodi qui fuga illum saepe culpa sit. Quam odit sed laborum corrupti sapiente.\n\nAut nemo sequi qui aut illum facilis voluptas. Est molestiae non molestiae magni iusto. Necessitatibus asperiores sint eligendi sit. Et enim cupiditate dicta dignissimos voluptatem. Repudiandae iusto commodi rerum deserunt qui quo."
                              thumbnail:
                                type: string
                                example: right-purple.png
                              grid_id:
                                type: integer
                                example: 3
                              color_id:
                                type: integer
                                example: 2
                      created_at:
                        type: integer
                        example: 1718748552
      tags:
        - 'Product Link'
    put:
      summary: 'Update Product Link'
      operationId: updateProductLink
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'product Link updated successfully',\n  'data'=>[]\n}"
      tags:
        - 'Product Link'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                landing_page_id:
                  type: integer
                  description: 'landing page id. The <code>id</code> of an existing record in the landing_pages table.'
                  example: 1
                display_name:
                  type: string
                  description: 'display name.'
                  example: 'Maud Ward'
                  nullable: true
                seller_promotion_id:
                  type: integer
                  description: 'seller promotion id. The <code>id</code> of an existing record in the seller_promotions table.'
                  example: 1
                  nullable: true
                is_default:
                  type: boolean
                  description: 'Is default product link.'
                  example: false
              required:
                - landing_page_id
    delete:
      summary: 'Delete Product Link'
      operationId: deleteProductLink
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n  'status'=>'success',\n  'message'=>'affiliate product Link deleted successfully',\n  'data'=>[]\n}"
      tags:
        - 'Product Link'
    parameters:
      -
        in: path
        name: productLinkId
        description: ''
        example: architecto
        required: true
        schema:
          type: string
  /affiliate/v1/reports/performance:
    get:
      summary: 'Performance Report List'
      operationId: performanceReportList
      description: ''
      parameters:
        -
          in: query
          name: from_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: to_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: 'seller_product_id[]'
          description: ''
          example: '4'
          required: false
          schema:
            type: string
            description: ''
            example: '4'
        -
          in: query
          name: 'seller_brand_id[]'
          description: ''
          example: '7'
          required: false
          schema:
            type: string
            description: ''
            example: '7'
        -
          in: query
          name: 'seller_id[]'
          description: ''
          example: '7'
          required: false
          schema:
            type: string
            description: ''
            example: '7'
        -
          in: query
          name: 'source_id[]'
          description: ''
          example: '7'
          required: false
          schema:
            type: string
            description: ''
            example: '7'
        -
          in: query
          name: 'order_by[date]'
          description: ''
          example: asc
          required: false
          schema:
            type: string
            description: ''
            example: asc
        -
          in: query
          name: 'order_by[commission]'
          description: ''
          example: desc
          required: false
          schema:
            type: string
            description: ''
            example: desc
        -
          in: query
          name: 'order_by[clicks]'
          description: ''
          example: asc
          required: false
          schema:
            type: string
            description: ''
            example: asc
        -
          in: query
          name: 'order_by[sales]'
          description: ''
          example: desc
          required: false
          schema:
            type: string
            description: ''
            example: desc
        -
          in: query
          name: 'order_by[conversions]'
          description: ''
          example: asc
          required: false
          schema:
            type: string
            description: ''
            example: asc
        -
          in: query
          name: 'order_by[conversion_rate]'
          description: ''
          example: desc
          required: false
          schema:
            type: string
            description: ''
            example: desc
        -
          in: query
          name: page
          description: ''
          example: '1'
          required: false
          schema:
            type: string
            description: ''
            example: '1'
        -
          in: query
          name: platform
          description: ''
          example: '0'
          required: false
          schema:
            type: string
            description: ''
            example: '0'
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      date: 1701388800
                      clicks: 20
                      add_to_cart: 3
                      sales: '25.50'
                      conversions: 5
                      conversion_rate: 0
                      commission: '0.00'
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 2
                  status: success
                  message: 'report fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        date: 1701388800
                        clicks: 20
                        add_to_cart: 3
                        sales: '25.50'
                        conversions: 5
                        conversion_rate: 0
                        commission: '0.00'
                    items:
                      type: object
                      properties:
                        date:
                          type: integer
                          example: 1701388800
                        clicks:
                          type: integer
                          example: 20
                        add_to_cart:
                          type: integer
                          example: 3
                        sales:
                          type: string
                          example: '25.50'
                        conversions:
                          type: integer
                          example: 5
                        conversion_rate:
                          type: integer
                          example: 0
                        commission:
                          type: string
                          example: '0.00'
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 2
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'report fetched successfully'
      tags:
        - Report
  /affiliate/v1/reports/product:
    post:
      summary: 'Product Report List'
      operationId: productReportList
      description: ''
      parameters:
        -
          in: query
          name: from_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: to_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: seller_brand_id
          description: ''
          example: '7'
          required: false
          schema:
            type: string
            description: ''
            example: '7'
        -
          in: query
          name: page
          description: ''
          example: '1'
          required: false
          schema:
            type: string
            description: ''
            example: '1'
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      product:
                        id: alg_EXdg5Yj903W0kwep28zo
                        brand_id: alg_PWZ7nGw8vJ1m4R1aX9My
                        name: 'Flexon WS100KITCN 20-Piece Soaker Hose Kit, 100 ft, Black'
                        thumbnail: 'https://m.media-amazon.com/images/I/61C+FHXWQVL._AA64_.jpg'
                        asin: null
                        amazon_link: 'https://www.amazon.com/dp/B07CXZSMM1?m=AQO9TRV0YRH57'
                      clicks: 200
                      add_to_cart: 50
                      sales: '1200.00'
                      conversions: 50
                      conversion_rate: 25
                      commission: '200.00'
                    -
                      product:
                        id: alg_lMWxe1baKXVm9gLnX8Qz
                        brand_id: alg_g4rlB87nvyZKzZG5YEw1
                        name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                        thumbnail: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                        asin: null
                        amazon_link: 'https://www.amazon.com/dp/B07YLG56B2?m=AQO9TRV0YRH57'
                      clicks: 703
                      add_to_cart: 244
                      sales: '4000.00'
                      conversions: 220
                      conversion_rate: 31
                      commission: '850.00'
                  status: success
                  message: 'report fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        product:
                          id: alg_EXdg5Yj903W0kwep28zo
                          brand_id: alg_PWZ7nGw8vJ1m4R1aX9My
                          name: 'Flexon WS100KITCN 20-Piece Soaker Hose Kit, 100 ft, Black'
                          thumbnail: 'https://m.media-amazon.com/images/I/61C+FHXWQVL._AA64_.jpg'
                          asin: null
                          amazon_link: 'https://www.amazon.com/dp/B07CXZSMM1?m=AQO9TRV0YRH57'
                        clicks: 200
                        add_to_cart: 50
                        sales: '1200.00'
                        conversions: 50
                        conversion_rate: 25
                        commission: '200.00'
                      -
                        product:
                          id: alg_lMWxe1baKXVm9gLnX8Qz
                          brand_id: alg_g4rlB87nvyZKzZG5YEw1
                          name: 'Emprian Waxing kit Wax Warmer - 200gr Blue Wax Beads, Wax Pot for Women and Men - Painless Waxing for Full Body, Legs, Face, Eyebrows, Bikini and Armpit - Easy to Use Hair Removal Wax Warmer for Salon'
                          thumbnail: 'https://m.media-amazon.com/images/I/81UaTcwVIFL._AA64_.jpg'
                          asin: null
                          amazon_link: 'https://www.amazon.com/dp/B07YLG56B2?m=AQO9TRV0YRH57'
                        clicks: 703
                        add_to_cart: 244
                        sales: '4000.00'
                        conversions: 220
                        conversion_rate: 31
                        commission: '850.00'
                    items:
                      type: object
                      properties:
                        product:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_EXdg5Yj903W0kwep28zo
                            brand_id:
                              type: string
                              example: alg_PWZ7nGw8vJ1m4R1aX9My
                            name:
                              type: string
                              example: 'Flexon WS100KITCN 20-Piece Soaker Hose Kit, 100 ft, Black'
                            thumbnail:
                              type: string
                              example: 'https://m.media-amazon.com/images/I/61C+FHXWQVL._AA64_.jpg'
                            asin:
                              type: string
                              example: null
                            amazon_link:
                              type: string
                              example: 'https://www.amazon.com/dp/B07CXZSMM1?m=AQO9TRV0YRH57'
                        clicks:
                          type: integer
                          example: 200
                        add_to_cart:
                          type: integer
                          example: 50
                        sales:
                          type: string
                          example: '1200.00'
                        conversions:
                          type: integer
                          example: 50
                        conversion_rate:
                          type: integer
                          example: 25
                        commission:
                          type: string
                          example: '200.00'
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'report fetched successfully'
      tags:
        - Report
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                seller_product_ids:
                  type: array
                  description: 'Seller product id required. The <code>id</code> of an existing record in the seller_products table.'
                  example:
                    - 0
                  items:
                    type: integer
  /affiliate/v1/reports/brand:
    post:
      summary: 'Brand Report List'
      operationId: brandReportList
      description: ''
      parameters:
        -
          in: query
          name: from_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: to_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: page
          description: ''
          example: '1'
          required: false
          schema:
            type: string
            description: ''
            example: '1'
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      brand:
                        id: alg_PWZ7nGw8vJ1m4R1aX9My
                        name: Flexon
                        image: ''
                      clicks: 200
                      add_to_cart: 50
                      sales: '1200.00'
                      conversions: 50
                      conversion_rate: 25
                      commission: '200.00'
                    -
                      brand:
                        id: alg_g4rlB87nvyZKzZG5YEw1
                        name: Emprian
                        image: ''
                      clicks: 703
                      add_to_cart: 244
                      sales: '4000.00'
                      conversions: 220
                      conversion_rate: 31
                      commission: '850.00'
                  status: success
                  message: 'report fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        brand:
                          id: alg_PWZ7nGw8vJ1m4R1aX9My
                          name: Flexon
                          image: ''
                        clicks: 200
                        add_to_cart: 50
                        sales: '1200.00'
                        conversions: 50
                        conversion_rate: 25
                        commission: '200.00'
                      -
                        brand:
                          id: alg_g4rlB87nvyZKzZG5YEw1
                          name: Emprian
                          image: ''
                        clicks: 703
                        add_to_cart: 244
                        sales: '4000.00'
                        conversions: 220
                        conversion_rate: 31
                        commission: '850.00'
                    items:
                      type: object
                      properties:
                        brand:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_PWZ7nGw8vJ1m4R1aX9My
                            name:
                              type: string
                              example: Flexon
                            image:
                              type: string
                              example: ''
                        clicks:
                          type: integer
                          example: 200
                        add_to_cart:
                          type: integer
                          example: 50
                        sales:
                          type: string
                          example: '1200.00'
                        conversions:
                          type: integer
                          example: 50
                        conversion_rate:
                          type: integer
                          example: 25
                        commission:
                          type: string
                          example: '200.00'
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'report fetched successfully'
      tags:
        - Report
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                seller_brand_ids:
                  type: array
                  description: 'Brand id (Amazon) or store id (Shopify), per X-Platform. The <code>id</code> of an existing record in the seller_brands table.'
                  example:
                    - 1
                  items:
                    type: integer
  /affiliate/v1/reports/source:
    post:
      summary: 'Source Report List'
      operationId: sourceReportList
      description: ''
      parameters:
        -
          in: query
          name: from_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: to_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: page
          description: ''
          example: '1'
          required: false
          schema:
            type: string
            description: ''
            example: '1'
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      date: 1718713490
                      source:
                        id: alg_YVnAZalrvYLmXD2o5bJk
                        name: test2
                      clicks: 0
                      add_to_cart: 0
                      sales: '0.00'
                      conversions: 0
                      conversion_rate: 0
                      commission: '0.00'
                    -
                      date: 1718713490
                      source:
                        id: alg_7b9ZAVdemE2voXyxNPR8
                        name: test1
                      clicks: 903
                      add_to_cart: 294
                      sales: '5200.00'
                      conversions: 270
                      conversion_rate: 29
                      commission: '1050.00'
                  status: success
                  message: 'report fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        date: 1718713490
                        source:
                          id: alg_YVnAZalrvYLmXD2o5bJk
                          name: test2
                        clicks: 0
                        add_to_cart: 0
                        sales: '0.00'
                        conversions: 0
                        conversion_rate: 0
                        commission: '0.00'
                      -
                        date: 1718713490
                        source:
                          id: alg_7b9ZAVdemE2voXyxNPR8
                          name: test1
                        clicks: 903
                        add_to_cart: 294
                        sales: '5200.00'
                        conversions: 270
                        conversion_rate: 29
                        commission: '1050.00'
                    items:
                      type: object
                      properties:
                        date:
                          type: integer
                          example: 1718713490
                        source:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_YVnAZalrvYLmXD2o5bJk
                            name:
                              type: string
                              example: test2
                        clicks:
                          type: integer
                          example: 0
                        add_to_cart:
                          type: integer
                          example: 0
                        sales:
                          type: string
                          example: '0.00'
                        conversions:
                          type: integer
                          example: 0
                        conversion_rate:
                          type: integer
                          example: 0
                        commission:
                          type: string
                          example: '0.00'
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'report fetched successfully'
      tags:
        - Report
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                source_ids:
                  type: array
                  description: 'Source is required. The <code>id</code> of an existing record in the affiliate_product_link_sources table.'
                  example:
                    - 0
                  items:
                    type: integer
  /affiliate/v1/reports/landing-page:
    post:
      summary: 'Landing Page Report List'
      operationId: landingPageReportList
      description: ''
      parameters:
        -
          in: query
          name: from_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: to_date
          description: ''
          example: 2023/08/11
          required: false
          schema:
            type: string
            description: ''
            example: 2023/08/11
        -
          in: query
          name: seller_product_id
          description: ''
          example: '4'
          required: false
          schema:
            type: string
            description: ''
            example: '4'
        -
          in: query
          name: page
          description: ''
          example: '1'
          required: false
          schema:
            type: string
            description: ''
            example: '1'
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg_YVnAZalrvYLmXD2o5bJk
                      name: test
                      views: 3
                      conversions: 2
                      conversion_rate: '0.67'
                    -
                      id: alg_X2Zq8RbnvPz0wM56WEoz
                      name: test2
                      views: 4
                      conversions: 3
                      conversion_rate: '0.75'
                  status: success
                  message: 'report fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg_YVnAZalrvYLmXD2o5bJk
                        name: test
                        views: 3
                        conversions: 2
                        conversion_rate: '0.67'
                      -
                        id: alg_X2Zq8RbnvPz0wM56WEoz
                        name: test2
                        views: 4
                        conversions: 3
                        conversion_rate: '0.75'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg_YVnAZalrvYLmXD2o5bJk
                        name:
                          type: string
                          example: test
                        views:
                          type: integer
                          example: 3
                        conversions:
                          type: integer
                          example: 2
                        conversion_rate:
                          type: string
                          example: '0.67'
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'report fetched successfully'
      tags:
        - Report
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                landing_page_ids:
                  type: array
                  description: 'Landing page is required. The <code>id</code> of an existing record in the landing_pages table.'
                  example:
                    - 0
                  items:
                    type: integer
  /affiliate/v1/stores:
    get:
      summary: 'Store List'
      operationId: storeList
      description: ''
      parameters:
        -
          in: query
          name: main_category_id
          description: 'Filter by main category ID(s). Can be a single ID or array of IDs.'
          example: '1 or [1,2,3]'
          required: false
          schema:
            type: string
            description: 'Filter by main category ID(s). Can be a single ID or array of IDs.'
            example: '1 or [1,2,3]'
        -
          in: query
          name: min_avg_price
          description: 'Filter stores with average price greater than or equal to this value.'
          example: '10.50'
          required: false
          schema:
            type: string
            description: 'Filter stores with average price greater than or equal to this value.'
            example: '10.50'
        -
          in: query
          name: max_avg_price
          description: 'Filter stores with average price less than or equal to this value.'
          example: '100.00'
          required: false
          schema:
            type: string
            description: 'Filter stores with average price less than or equal to this value.'
            example: '100.00'
        -
          in: query
          name: min_avg_commission
          description: 'Filter stores with average commission greater than or equal to this value.'
          example: '5.00'
          required: false
          schema:
            type: string
            description: 'Filter stores with average commission greater than or equal to this value.'
            example: '5.00'
        -
          in: query
          name: max_avg_commission
          description: 'Filter stores with average commission less than or equal to this value.'
          example: '20.00'
          required: false
          schema:
            type: string
            description: 'Filter stores with average commission less than or equal to this value.'
            example: '20.00'
        -
          in: query
          name: status
          description: 'Filter by status. Can be numeric (1=Active, 2=Inactive, 3=Suspended) or string (active, inactive, suspended).'
          example: active
          required: false
          schema:
            type: string
            description: 'Filter by status. Can be numeric (1=Active, 2=Inactive, 3=Suspended) or string (active, inactive, suspended).'
            example: active
        -
          in: query
          name: partnership_status
          description: 'Filter by partnership status. Values: partnered, not_partnered.'
          example: partnered
          required: false
          schema:
            type: string
            description: 'Filter by partnership status. Values: partnered, not_partnered.'
            example: partnered
        -
          in: query
          name: 'order_by[main_category_id]'
          description: 'Sort by main category ID. Values: asc, desc.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort by main category ID. Values: asc, desc.'
            example: asc
        -
          in: query
          name: 'order_by[product_count]'
          description: 'Sort by product count. Values: asc, desc.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Sort by product count. Values: asc, desc.'
            example: 0
        -
          in: query
          name: 'order_by[avg_price]'
          description: 'Sort by average price. Values: asc, desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort by average price. Values: asc, desc.'
            example: desc
        -
          in: query
          name: 'order_by[avg_commission]'
          description: 'Sort by average commission. Values: asc, desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort by average commission. Values: asc, desc.'
            example: desc
        -
          in: query
          name: 'order_by[status]'
          description: 'Sort by status. Values: asc, desc.'
          example: asc
          required: false
          schema:
            type: string
            description: 'Sort by status. Values: asc, desc.'
            example: asc
        -
          in: query
          name: 'order_by[partnership_status]'
          description: 'Sort by partnership status. Values: asc, desc.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort by partnership status. Values: asc, desc.'
            example: desc
        -
          in: query
          name: per_page
          description: 'Number of items per page. Default: 15. Max: 100.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'Number of items per page. Default: 15. Max: 100.'
            example: 20
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: alg_PWZ7nGw8vJ1m4R1aX9My
                      store_domain: example.myshopify.com
                      seller:
                        id: alg_PWZ7nGw8vJQ1m4R1aX9M
                        name: S.Ahmad
                        avatar: ''
                      main_category: null
                      products_count: 10
                      avg_price: null
                      avg_commission: null
                      partnership_status: partnered
                  pagination:
                    current_page: 1
                    per_page: 15
                    total: 1
                  status: success
                  message: 'stores fetched successfully'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: alg_PWZ7nGw8vJ1m4R1aX9My
                        store_domain: example.myshopify.com
                        seller:
                          id: alg_PWZ7nGw8vJQ1m4R1aX9M
                          name: S.Ahmad
                          avatar: ''
                        main_category: null
                        products_count: 10
                        avg_price: null
                        avg_commission: null
                        partnership_status: partnered
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: alg_PWZ7nGw8vJ1m4R1aX9My
                        store_domain:
                          type: string
                          example: example.myshopify.com
                        seller:
                          type: object
                          properties:
                            id:
                              type: string
                              example: alg_PWZ7nGw8vJQ1m4R1aX9M
                            name:
                              type: string
                              example: S.Ahmad
                            avatar:
                              type: string
                              example: ''
                        main_category:
                          type: string
                          example: null
                        products_count:
                          type: integer
                          example: 10
                        avg_price:
                          type: string
                          example: null
                        avg_commission:
                          type: string
                          example: null
                        partnership_status:
                          type: string
                          example: partnered
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 1
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'stores fetched successfully'
      tags:
        - 'Shopify Store'
  '/affiliate/v1/stores/{id}':
    get:
      summary: 'Store Show'
      operationId: storeShow
      description: ''
      parameters:
        -
          in: header
          name: X-Platform
          description: ''
          example: 'shopify | amazon | amazon-{marketplace_id} | amazon-{tld} | amazon.{tld}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: encoded_store_id
                    store_domain: example.myshopify.com
                    shop_name: 'Example Store'
                    main_category:
                      id: encoded_category_id
                      name: Electronics
                    avg_commission: '15.50'
                    avg_price: '299.99'
                    terms_of_sale: null
                    seller:
                      id: encoded_seller_id
                      name: 'John Doe'
                      avatar: 'https://api.dicebear.com/9.x/initials/png?seed=John+Doe'
                    product_count: 12
                    status: active
                    partnership_status: partnered
                    active_partnership_request:
                      id: encoded_request_id
                      status: pending
                      commission: '20.00'
                      commission_type: percent
                      is_custom_commission: '1'
                      message: 'Partnership request message'
                      type: affiliate_to_seller
                      created_at: 1640995200
                    affiliate_count: 3
                    partnership_applied_date: 1640995200
                  status: success
                  message: 'store fetched successfully'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: encoded_store_id
                      store_domain:
                        type: string
                        example: example.myshopify.com
                      shop_name:
                        type: string
                        example: 'Example Store'
                      main_category:
                        type: object
                        properties:
                          id:
                            type: string
                            example: encoded_category_id
                          name:
                            type: string
                            example: Electronics
                      avg_commission:
                        type: string
                        example: '15.50'
                      avg_price:
                        type: string
                        example: '299.99'
                      terms_of_sale:
                        type: string
                        example: null
                      seller:
                        type: object
                        properties:
                          id:
                            type: string
                            example: encoded_seller_id
                          name:
                            type: string
                            example: 'John Doe'
                          avatar:
                            type: string
                            example: 'https://api.dicebear.com/9.x/initials/png?seed=John+Doe'
                      product_count:
                        type: integer
                        example: 12
                      status:
                        type: string
                        example: active
                      partnership_status:
                        type: string
                        example: partnered
                      active_partnership_request:
                        type: object
                        properties:
                          id:
                            type: string
                            example: encoded_request_id
                          status:
                            type: string
                            example: pending
                          commission:
                            type: string
                            example: '20.00'
                          commission_type:
                            type: string
                            example: percent
                          is_custom_commission:
                            type: string
                            example: '1'
                          message:
                            type: string
                            example: 'Partnership request message'
                          type:
                            type: string
                            example: affiliate_to_seller
                          created_at:
                            type: integer
                            example: 1640995200
                      affiliate_count:
                        type: integer
                        example: 3
                      partnership_applied_date:
                        type: integer
                        example: 1640995200
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: 'store fetched successfully'
      tags:
        - 'Shopify Store'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the Shopify Account Store.'
        example: 1
        required: true
        schema:
          type: integer
