Have any question?
1-800-224-0976
Contact Us
RegisterLogin
API2Cart - AcademyAPI2Cart - Academy
  • Courses
  • How It Works
  • Pricing
  • Use Cases
  • Integrations
  • API Docs
  • Partnership

    For Tech Specialists

    • Home
    • All courses
    • For Tech Specialists
    • Introduction Course for eCommerce Tech Specialists
    CoursesFor Tech SpecialistsIntroduction Course for eCommerce Tech Specialists
    • Introduction 1

      • Lecture1.1
        Introduction (video) 02 min
      • Lecture1.2
        API2Cart: Benefits for developers 02 min
      • Lecture1.3
        Industries that can benefit from API2Cart 04 min
      • Quiz1.1
        Quiz yourself 3 questions
    • Start Building Your Integration 1

      • Lecture2.1
        How to Get Started with API2Cart 06 min
      • Lecture2.2
        API methods to work with carts 04 min
      • Lecture2.3
        API methods to work with products from stores 04 min
      • Lecture2.4
        API methods to work with orders from stores and shipments 04 min
      • Lecture2.5
        API2Cart: Use Case (example) 03 min
      • Quiz2.1
        Quiz yourself 2 6 questions
    • Frequently asked questions during integration development 0

      • Lecture3.1
        How to update the credit card number in the subscription? 04 min
      • Lecture3.2
        Is there a timeout set for the request from API2Cart server to the store? 02 min
      • Lecture3.3
        What is the reason for appearing of 404-error on the integration bridge page even after clearing all the cache and rebuilding the indexes? 02 min
      • Lecture3.4
        Why is it better to integrate with multiple shopping platforms via a unified API of API2Cart than to build the integration with each platform separately on my own? 04 min
      • Lecture3.5
        How to install Magento 2 Plugin? 01 min

      API methods to work with products from stores

      The main API methods to work with products from stores. With their help, you can count items, get and update product lists and details, add variants and options together with currencies, taxes and manufacturers, etc.

          1. product.list

      This method lets API2Cart users get the list of products from the store. It returns 10 products by default.

      Response structure:

      {
        "return_code": int,
        "return_message": string,
        "result":{
          "products_count": int,
          "product":[ array
            {
              "id": string,
              "type": string,
              "u_model": string,
              "u_sku": string,
              "name": string,
              "description": string,
              "short_description": string,
              "price": decimal,
              "quantity": int,
              "u_brand": string,
              "categories_ids": string,
              "stores_ids": string,
              "url": string,
              "seo_url": string,
              "meta_title": string,
              "meta_keywords": string,
              "meta_description": string,
              "avail_sale": string,
              "avail_view": string,
              "weight": decimal,
              "sort_order": int,
              "backorders": string,
              "manage_stock": string,
              "create_at": string,
              "modified_at": string,
              "tax_class_id": string,
              "dimensions_unit": string,
              "width": decimal,
              "height": decimal,
              "length": decimal,
              "special_price":[ array
                {
                  "value": decimal,
                  "avail": string,
                  "created_at": string,
                  "modified_at": string,
                  "expired_at": string
                }
              ],
              "tier_price":[ array
                {
                  "tier_price_count1": int,
                  "tier_price_value1": decimal,
                  "tier_prices_count": int
                  ...
                }
              ],
              "group_price":[ array
                {
                  "id": string,
                  "group_id": string,
                  "price": decimal,
                  "store_id": string,
                  "quantity": decimal,
                  "start_time": string,
                  "expire_time": string
                },
                ...
              ],
              "images":[ array
                {
                  "item":[ array
                    {
                      "http_path": string,
                      "type": string,
                      "mime-type": string,
                      "alt": string,
                      "avail": string,
                      "file_name": string,
                      "create_at": string,
                      "modified_at": string,
                      "size": int
                    },
                    ...              
                  ]
                }
              ],
              "product_options":[ array,
                {
                  "option":[ array
                    {
                      "id": string,
                      "product_option_id": string,
                      "name": string,
                      "type": string,
                      "required": string,
                      "option_value":[ array
                        {
                          "value":[ array
                            {
                              "id": string,
                              "product_option_value_id": string,
                              "name": string,
                              "price": decimal,
                              "type_price": string,
                              "quantity": int
                            },
                            ...               
                          ]
                        }
                      ]
                    },
                    ...
                  ]
                }
              ],
              "product_variants":[ array,
                {
                  "product_variant":[ array
                    {
                      "id": string,
                      "attribute_set_name": string,
                      "type": string,
                      "u_model": string,
                      "u_sku": string,
                      "name": string,
                      "description": string,
                      "price": decimal,
                      "quantity": int,
                      "u_brand_id": string,
                      "u_brand": string,
                      "categories_ids": string,
                      "url": string,
                      "seo_url": string,
                      "meta_title": string,
                      "meta_keywords": string,
                      "meta_description": string,
                      "avail_sale": string,
                      "avail_view": string,
                      "weight": decimal,
                      "sort_order": int,
                      "create_at": string,
                      "modified_at": string,
                      "special_price":[ array
                        {
                          "value": decimal,
                          "avail": string,
                          "created_at": string,
                          "modified_at": string,
                          "expired_at": string
                        }
                      ],
                      "tax_class_id": string,
                      "images": array,
                      "u_upc": string,
                      "u_mpn": string,
                      "categories": deprecated,
                      "combinations":[ array
                        {
                          "combination":[ array
                            {
                              "name": string,
                              "option_id": string,
                              "value_id": string
                            },
                            {
                              "name": string,
                              "option_id": string,
                              "value_id": string
                             }
                             ...
                          ]
                        }
                      ]
                    },
                    ...
                  ]
                }
              ],
              "u_upc": string,
              "u_mpn": string,
              "categories": deprecated,
              "related_products_ids": string,
              "tax_class":[ deprecated
                {
                  "tax_class_id": string,
                  "name": string,
                  "created_at": string,
                  "modified_at": string,
                  "value": deprecated,
                  "avail": string,
                  "value_type": int,
                  "tax_rates":[ array
                    {
                      "tax_rate":[ array
                        {
                          "tax_rate_id": string,
                          "name": string,
                          "type": int,
                          "value": decimal,
                          "create_at": string,
                          "modified_at": string
                        },
                        ...                  
                      ]
                    }
                  ]
                }
              ],
            },
            ...      
          ]
        }
      }
      

          2. product.info

      This method allows retrieving products with related information, including name, description, price, category and all needed data.

      Response structure:

      {
        "return_code": int,
        "return_message": string,
        "result":{
          "id": string,
          "type": string,
          "u_model": string,
          "u_sku": string,
          "name": string,
          "description": string,
          "short_description": string,
          "price": decimal,
          "quantity": int,
          "u_brand": string,
          "categories_ids": string,
          "stores_ids": string,
          "url": string,
          "seo_url": string,
          "meta_title": string,
          "meta_keywords": string,
          "meta_description": string,
          "avail_sale": string,
          "avail_view": string,
          "weight": decimal,
          "sort_order": int,
          "backorders": string,
          "manage_stock": string,
          "create_at": string,
          "modified_at": string,
          "tax_class_id": string,
          "dimensions_unit": string,
          "width": decimal,
          "height": decimal,
          "length": decimal,
          "special_price":[ array
            {
              "value": decimal,
              "avail": string,
              "created_at": string,
              "modified_at": string,
              "expired_at": string
            }
          ],
          "tier_price":[ array
            {
              "tier_price_count1": int,
              "tier_price_value1": decimal,
              "tier_prices_count": int
              ...
            }
          ],
          "group_price":[ array
            {
              "id": string,
              "group_id": string,
              "price": decimal,
              "store_id": string,
              "quantity": decimal,
              "start_time": string,
              "expire_time": string
            },
            ...
          ],
          "images":[ array
            {
              "item":[ array
                {
                  "http_path": string,
                  "type": string,
                  "mime-type": string,
                  "alt": string,
                  "avail": string,
                  "file_name": string,
                  "create_at": string,
                  "modified_at": string,
                  "size": int
                },
                ...              
              ]
            }
          ],
          "product_options":[ array,
            {
              "option":[ array
                {
                  "id": string,
                  "product_option_id": string,
                  "name": string,
                  "type": string,
                  "required": string,
                  "option_value":[ array
                    {
                      "value":[ array
                        {
                          "id": string,
                          "product_option_value_id": string,
                          "name": string,
                          "price": decimal,
                          "type_price": string,
                          "quantity": int
                        },
                        ...               
                      ]
                    }
                  ]
                },
                ...
              ]
            }
          ],
          "product_variants":[ array,
            {
              "product_variant":[ array
                {
                  "id": string,
                  "attribute_set_name": string,
                  "type": string,
                  "u_model": string,
                  "u_sku": string,
                  "name": string,
                  "description": string,
                  "price": decimal,
                  "quantity": int,
                  "u_brand_id": string,
                  "u_brand": string,
                  "categories_ids": string,
                  "url": string,
                  "seo_url": string,
                  "meta_title": string,
                  "meta_keywords": string,
                  "meta_description": string,
                  "avail_sale": string,
                  "avail_view": string,
                  "weight": decimal,
                  "sort_order": int,
                  "create_at": string,
                  "modified_at": string,
                  "special_price":[ array
                    {
                      "value": decimal,
                      "avail": string,
                      "created_at": string,
                      "modified_at": string,
                      "expired_at": string
                    }
                  ],
                  "tax_class_id": string,
                  "images": array,
                  "u_upc": string,
                  "u_mpn": string,
                  "categories": deprecated,
                  "combinations":[ array
                    {
                      "combination":[ array
                        {
                          "name": string,
                          "option_id": string,
                          "value_id": string
                        },
                        {
                          "name": string,
                          "option_id": string,
                          "value_id": string
                         }
                         ...
                      ]
                    }
                  ]
                },
                ...
              ]
            }
          ],
          "u_upc": string,
          "u_mpn": string,
          "categories": deprecated,
          "related_products_ids": string,
          "tax_class":[ deprecated
            {
              "tax_class_id": string,
              "name": string,
              "created_at": string,
              "modified_at": string,
              "value": deprecated,
              "avail": string,
              "value_type": int,
              "tax_rates":[ array
                {
                  "tax_rate":[ array
                    {
                      "tax_rate_id": string,
                      "name": string,
                      "type": int,
                      "value": decimal,
                      "create_at": string,
                      "modified_at": string
                    },
                    ...                  
                  ]
                }
              ]
            }
          ]
        }
      }
      

           3. product.add

      This method allows adding products to the store.

      Response structure:

      {
        "return_code": int, 
        "return_message": string, 
        "result":{
          "product_id": string
        }
      }
      

           4. product.delete

      This method provides you with the possibility to delete products from the store.

      Response structure:

      {
        "return_code": int,
        "return_message": string,
        "result":{
          "delete_items": int
        }
      }
      

      The whole list of API methods to work with products and their details you can find here: Product

       

      Related material:

      API Methods for Warehouse Management Systems

      API Integration Methods for Pricing Software

      API Docs

      Prev API methods to work with carts
      Next API methods to work with orders from stores and shipments

      Leave A Reply Cancel reply

      Your email address will not be published. Required fields are marked *

      Latest Courses

      Getting Started

      Getting Started

      Free
      Course for Partners

      Course for Partners

      Free
      Introduction Course for eCommerce SaaS Providers

      Introduction Course for eCommerce SaaS Providers

      Free

      GETTING STARTED

      • Pricing
      • Use Cases
      • Supported Methods
      • Supported Platforms
      • Webhooks
      • On-Premise Solution
      • Courses

      INFORMATION

      • Blog
      • Resources
      • Clients
      • Testimonials
      • Sitemap
      • Integration Partner
      • Contact Us
      • Complaint Form
      • Affiliate Program

      DEVELOPER RESOURCES

      • API Documentation
      • Code Samples
      • Release Notes
      • SDK

      SUPPORT

      • FAQ
      • Submit a Feature
      • Service Level Agreement
      • Terms Service
      • Privacy Policy
      • Security

      © 2019 MagneticOne

      Login with Facebook Login with Google

      Login with your site account

      Facebook Google

      Lost your password?

      Not a member yet? Register now

      Register a new account

      Are you a member? Login now