Products

Retrieve a product given an ID

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Parâmetros de consulta

summarybooleanOpcionalDefault: false

Respostas

200

OK

application/json

404

Product was not found

application/json

500

An internal server error was thrown

application/json

get

/products/{id}

HTTPcURLJavaScriptPython

GET /api/sales/products/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "active": true,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "brand_name": "text",
  "video_url": "text",
  "price": 1,
  "stock": 1,
  "warehouse_default": "text",
  "warehouse_default_name": "text",
  "maximum_discount": 1,
  "minimum_stock": 1,
  "minimum_for_sale": 1,
  "multiple_for_sale": 1,
  "standard_unit_id": "text",
  "standard_unit_name": "text",
  "standard_unit_abbreviation": "text",
  "standard_unit_decimals_for_quantity": 1,
  "category_id": "text",
  "category_name": "text",
  "product_weight": 1,
  "product_width": 1,
  "product_height": 1,
  "product_depth": 1,
  "packaging_weight": 1,
  "packaging_width": 1,
  "packaging_height": 1,
  "packaging_depth": 1,
  "highlight": true,
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "maximum_markup": 1,
  "alternative_units": [
    {
      "id": "text",
      "product_id": "text",
      "unit_id": "text",
      "unit_name": "text",
      "unit_abbreviation": "text",
      "decimals_for_quantity": 1,
      "value_multiplier": 1,
      "quantity": 1
    }
  ],
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "image_url": "text",
      "main": true
    }
  ],
  "category_specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "specification_id": "text",
          "name": "text",
          "type": "text",
          "options": [
            "text"
          ],
          "values": [
            "text"
          ]
        }
      ]
    }
  ],
  "recommended_products": [
    {
      "id": "text",
      "recommended_product_id": "text",
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "image": {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "image_url": "text",
        "main": true
      }
    }
  ],
  "similar_products": [
    {
      "id": "text",
      "similar_product_id": "text",
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "image": {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "image_url": "text",
        "main": true
      }
    }
  ],
  "variations": [
    {
      "id": "text",
      "sku": "text",
      "price": 1,
      "stock": 1,
      "variation_weight": 1,
      "variation_width": 1,
      "variation_height": 1,
      "variation_depth": 1,
      "packaging_weight": 1,
      "packaging_width": 1,
      "packaging_height": 1,
      "packaging_depth": 1,
      "images": [
        {
          "resource_id": "text",
          "main": true
        }
      ],
      "values": [
        {
          "variation_id": "text",
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update a existing product

put

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

activebooleanObrigatório

namestringObrigatório

skustringObrigatório

short_descriptionstringObrigatório

long_descriptionstringObrigatório

ean_gtinstringObrigatório

brand_idstringObrigatório

video_urlstringObrigatório

pricenumberObrigatório

stocknumberObrigatório

warehouse_defaultstringOpcional

maximum_discountnumberOpcional

minimum_stocknumberObrigatório

minimum_for_salenumberObrigatório

multiple_for_salenumberObrigatório

standard_unit_idstringOpcional

category_idstringObrigatório

product_weightnumberObrigatório

product_widthnumberObrigatório

product_heightnumberObrigatório

product_depthnumberObrigatório

packaging_weightnumberObrigatório

packaging_widthnumberObrigatório

packaging_heightnumberObrigatório

packaging_depthnumberObrigatório

highlightbooleanOpcional

seo_titlestringOpcional

seo_descriptionstringOpcional

seo_meta_keywordsstring[]Opcional

maximum_markupnumberOpcional

Respostas

200

Product updated successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

/products/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/products/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1462

{
  "active": true,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "video_url": "text",
  "price": 1,
  "stock": 1,
  "warehouse_default": "text",
  "maximum_discount": 1,
  "minimum_stock": 1,
  "minimum_for_sale": 1,
  "multiple_for_sale": 1,
  "standard_unit_id": "text",
  "category_id": "text",
  "product_weight": 1,
  "product_width": 1,
  "product_height": 1,
  "product_depth": 1,
  "packaging_weight": 1,
  "packaging_width": 1,
  "packaging_height": 1,
  "packaging_depth": 1,
  "highlight": true,
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "maximum_markup": 1,
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": true
    }
  ],
  "alternative_units": [
    {
      "id": "text",
      "unit_id": "text",
      "decimals_for_quantity": 1,
      "value_multiplier": 1,
      "quantity": 1
    }
  ],
  "category_specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "specification_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "recommended_products": [
    {
      "id": "text",
      "recommended_product_id": "text"
    }
  ],
  "similar_products": [
    {
      "id": "text",
      "similar_product_id": "text"
    }
  ],
  "variations": [
    {
      "id": "text",
      "sku": "text",
      "price": 1,
      "stock": 1,
      "variation_weight": 1,
      "variation_width": 1,
      "variation_height": 1,
      "variation_depth": 1,
      "packaging_weight": 1,
      "packaging_width": 1,
      "packaging_height": 1,
      "packaging_depth": 1,
      "images": [
        {
          "resource_id": "text",
          "main": true
        }
      ],
      "values": [
        {
          "variation_id": "text",
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "active": true,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "brand_name": "text",
  "video_url": "text",
  "price": 1,
  "stock": 1,
  "warehouse_default": "text",
  "warehouse_default_name": "text",
  "maximum_discount": 1,
  "minimum_stock": 1,
  "minimum_for_sale": 1,
  "multiple_for_sale": 1,
  "standard_unit_id": "text",
  "standard_unit_name": "text",
  "standard_unit_abbreviation": "text",
  "category_id": "text",
  "category_name": "text",
  "product_weight": 1,
  "product_width": 1,
  "product_height": 1,
  "product_depth": 1,
  "packaging_weight": 1,
  "packaging_width": 1,
  "packaging_height": 1,
  "packaging_depth": 1,
  "highlight": true,
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "maximum_markup": 1,
  "alternative_units": [
    {
      "id": "text",
      "product_id": "text",
      "unit_id": "text",
      "unit_name": "text",
      "unit_abbreviation": "text",
      "decimals_for_quantity": 1,
      "value_multiplier": 1,
      "quantity": 1
    }
  ],
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "image_url": "text",
      "main": true
    }
  ],
  "category_specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "specification_id": "text",
          "name": "text",
          "type": "text",
          "options": [
            "text"
          ],
          "values": [
            "text"
          ]
        }
      ]
    }
  ],
  "recommended_products": [
    {
      "id": "text",
      "recommended_product_id": "text",
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "image": {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "image_url": "text",
        "main": true
      }
    }
  ],
  "similar_products": [
    {
      "id": "text",
      "similar_product_id": "text",
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "image": {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "image_url": "text",
        "main": true
      }
    }
  ],
  "variations": [
    {
      "id": "text",
      "sku": "text",
      "price": 1,
      "stock": 1,
      "variation_weight": 1,
      "variation_width": 1,
      "variation_height": 1,
      "variation_depth": 1,
      "packaging_weight": 1,
      "packaging_width": 1,
      "packaging_height": 1,
      "packaging_depth": 1,
      "images": [
        {
          "resource_id": "text",
          "main": true
        }
      ],
      "values": [
        {
          "variation_id": "text",
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remove an existing product

delete

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

Product removed successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete

/products/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/products/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text"
}

List all products

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

only_activebooleanOpcional

category_idstringOpcional

criteriastring[]Opcional

argumentsstringOpcional

product_idsstring[]Opcional

summarybooleanOpcionalDefault: false

Respostas

200

OK

application/json

404

Product was not found

application/json

500

An internal server error was thrown

application/json

get

/products

HTTPcURLJavaScriptPython

GET /api/sales/products HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "active": true,
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "long_description": "text",
      "ean_gtin": "text",
      "brand_id": "text",
      "brand_name": "text",
      "video_url": "text",
      "main_image_url": "text",
      "price": 1,
      "stock": 1,
      "warehouse_default": "text",
      "warehouse_default_name": "text",
      "maximum_discount": 1,
      "minimum_stock": 1,
      "minimum_for_sale": 1,
      "multiple_for_sale": 1,
      "standard_unit_id": "text",
      "standard_unit_name": "text",
      "standard_unit_abbreviation": "text",
      "standard_unit_decimals_for_quantity": 1,
      "category_id": "text",
      "category_name": "text",
      "product_weight": 1,
      "product_width": 1,
      "product_height": 1,
      "product_depth": 1,
      "packaging_weight": 1,
      "packaging_width": 1,
      "packaging_height": 1,
      "packaging_depth": 1,
      "highlight": true,
      "seo_title": "text",
      "seo_description": "text",
      "seo_meta_keywords": [
        "text"
      ],
      "maximum_markup": 1,
      "alternative_units": [
        {
          "id": "text",
          "product_id": "text",
          "unit_id": "text",
          "unit_name": "text",
          "unit_abbreviation": "text",
          "decimals_for_quantity": 1,
          "value_multiplier": 1,
          "quantity": 1
        }
      ],
      "variations": [
        {
          "id": "text",
          "sku": "text",
          "price": 1,
          "stock": 1,
          "variation_weight": 1,
          "variation_width": 1,
          "variation_height": 1,
          "variation_depth": 1,
          "packaging_weight": 1,
          "packaging_width": 1,
          "packaging_height": 1,
          "packaging_depth": 1,
          "images": [
            {
              "resource_id": "text",
              "main": true
            }
          ],
          "values": [
            {
              "variation_id": "text",
              "name": "text",
              "value": "text"
            }
          ]
        }
      ],
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "category_specifications": [
        {
          "name": "text",
          "items": [
            {
              "id": "text",
              "specification_id": "text",
              "name": "text",
              "type": "text",
              "options": [
                "text"
              ],
              "values": [
                "text"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Create a new product

post

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

activebooleanObrigatório

namestringObrigatório

skustringObrigatório

short_descriptionstringObrigatório

long_descriptionstringObrigatório

ean_gtinstringObrigatório

brand_idstringObrigatório

video_urlstringObrigatório

pricenumberObrigatório

stocknumberObrigatório

warehouse_defaultstringOpcional

maximum_discountnumberObrigatório

minimum_stocknumberObrigatório

minimum_for_salenumberObrigatório

multiple_for_salenumberObrigatório

standard_unit_idstringOpcional

category_idstringObrigatório

product_weightnumberObrigatório

product_widthnumberObrigatório

product_heightnumberObrigatório

product_depthnumberObrigatório

packaging_weightnumberObrigatório

packaging_widthnumberObrigatório

packaging_heightnumberObrigatório

packaging_depthnumberObrigatório

highlightbooleanOpcional

seo_titlestringOpcional

seo_descriptionstringOpcional

seo_meta_keywordsstring[]Opcional

maximum_markupnumberOpcional

Respostas

200

Product created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/products

HTTPcURLJavaScriptPython

POST /api/sales/products HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1450

{
  "id": "text",
  "active": true,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "video_url": "text",
  "price": 1,
  "stock": 1,
  "warehouse_default": "text",
  "maximum_discount": 1,
  "minimum_stock": 1,
  "minimum_for_sale": 1,
  "multiple_for_sale": 1,
  "standard_unit_id": "text",
  "category_id": "text",
  "product_weight": 1,
  "product_width": 1,
  "product_height": 1,
  "product_depth": 1,
  "packaging_weight": 1,
  "packaging_width": 1,
  "packaging_height": 1,
  "packaging_depth": 1,
  "highlight": true,
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "maximum_markup": 1,
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": true
    }
  ],
  "alternative_units": [
    {
      "id": "text",
      "unit_id": "text",
      "decimals_for_quantity": 1,
      "value_multiplier": 1,
      "quantity": 1
    }
  ],
  "category_specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "specification_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "recommended_products": [
    {
      "recommended_product_id": "text"
    }
  ],
  "similar_products": [
    {
      "similar_product_id": "text"
    }
  ],
  "variations": [
    {
      "id": "text",
      "sku": "text",
      "price": 1,
      "stock": 1,
      "variation_weight": 1,
      "variation_width": 1,
      "variation_height": 1,
      "variation_depth": 1,
      "packaging_weight": 1,
      "packaging_width": 1,
      "packaging_height": 1,
      "packaging_depth": 1,
      "images": [
        {
          "resource_id": "text",
          "main": true
        }
      ],
      "values": [
        {
          "variation_id": "text",
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "active": true,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "brand_name": "text",
  "video_url": "text",
  "price": 1,
  "stock": 1,
  "warehouse_default": "text",
  "warehouse_default_name": "text",
  "maximum_discount": 1,
  "minimum_stock": 1,
  "minimum_for_sale": 1,
  "multiple_for_sale": 1,
  "standard_unit_id": "text",
  "standard_unit_name": "text",
  "standard_unit_abbreviation": "text",
  "category_id": "text",
  "category_name": "text",
  "product_weight": 1,
  "product_width": 1,
  "product_height": 1,
  "product_depth": 1,
  "packaging_weight": 1,
  "packaging_width": 1,
  "packaging_height": 1,
  "packaging_depth": 1,
  "highlight": true,
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "maximum_markup": 1,
  "alternative_units": [
    {
      "id": "text",
      "product_id": "text",
      "unit_id": "text",
      "unit_name": "text",
      "unit_abbreviation": "text",
      "decimals_for_quantity": 1,
      "value_multiplier": 1,
      "quantity": 1
    }
  ],
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "image_url": "text",
      "main": true
    }
  ],
  "category_specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "specification_id": "text",
          "name": "text",
          "type": "text",
          "options": [
            "text"
          ],
          "values": [
            "text"
          ]
        }
      ]
    }
  ],
  "recommended_products": [
    {
      "id": "text",
      "recommended_product_id": "text",
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "image": {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "image_url": "text",
        "main": true
      }
    }
  ],
  "similar_products": [
    {
      "id": "text",
      "similar_product_id": "text",
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "image": {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "image_url": "text",
        "main": true
      }
    }
  ],
  "variations": [
    {
      "id": "text",
      "sku": "text",
      "price": 1,
      "stock": 1,
      "variation_weight": 1,
      "variation_width": 1,
      "variation_height": 1,
      "variation_depth": 1,
      "packaging_weight": 1,
      "packaging_width": 1,
      "packaging_height": 1,
      "packaging_depth": 1,
      "images": [
        {
          "resource_id": "text",
          "main": true
        }
      ],
      "values": [
        {
          "variation_id": "text",
          "name": "text",
          "value": "text"
        }
      ]
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}