Products

Retrieve a product given an ID

GEThttps://api.zydon.com.br/api/sales/products/{id}

Authorization

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

Path parameters

id*string

Query parameters

Response

200404500

OK

Body

application/json

idstring

activeboolean

namestring

skustring

short_descriptionstring

long_descriptionstring

ean_gtinstring

brand_idstring

brand_namestring

video_urlstring

pricenumber

stocknumber

warehouse_defaultstring

warehouse_default_namestring

maximum_discountnumber

minimum_stocknumber

minimum_for_salenumber

multiple_for_salenumber

standard_unit_idstring

standard_unit_namestring

standard_unit_abbreviationstring

category_idstring

category_namestring

product_weightnumber

product_widthnumber

product_heightnumber

product_depthnumber

packaging_weightnumber

packaging_widthnumber

packaging_heightnumber

packaging_depthnumber

alternative_unitsarray of AlternativeUnitResponse (object)

imagesarray of ProductImageResponse (object)

attributesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/products/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "active": false,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "brand_name": "text",
  "video_url": "text",
  "price": 0,
  "stock": 0,
  "warehouse_default": "text",
  "warehouse_default_name": "text",
  "maximum_discount": 0,
  "minimum_stock": 0,
  "minimum_for_sale": 0,
  "multiple_for_sale": 0,
  "standard_unit_id": "text",
  "standard_unit_name": "text",
  "standard_unit_abbreviation": "text",
  "category_id": "text",
  "category_name": "text",
  "product_weight": 0,
  "product_width": 0,
  "product_height": 0,
  "product_depth": 0,
  "packaging_weight": 0,
  "packaging_width": 0,
  "packaging_height": 0,
  "packaging_depth": 0,
  "alternative_units": [
    {
      "id": "text",
      "product_id": "text",
      "unit_id": "text",
      "unit_name": "text",
      "unit_abbreviation": "text",
      "decimals_for_quantity": 0,
      "value_multiplier": 0,
      "quantity": 0
    }
  ],
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": false
    }
  ]
}

Update a existing product

PUThttps://api.zydon.com.br/api/sales/products/{id}

Authorization

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

Path parameters

id*string

Body

application/json

active*boolean

name*string

sku*string

short_description*string

long_description*string

ean_gtin*string

brand_id*string

video_url*string

price*number

stock*number

warehouse_defaultstring

maximum_discountnumber

minimum_stock*number

minimum_for_sale*number

multiple_for_sale*number

standard_unit_idstring

category_id*string

product_weight*number

product_width*number

product_height*number

product_depth*number

packaging_weight*number

packaging_width*number

packaging_height*number

packaging_depth*number

imagesarray of ProductImageRequest (object)

alternative_unitsarray of UpdateProductAlternativeUnitRequest (object)

attributesobject

Response

200422500

Product updated successfully

Body

application/json

idstring

activeboolean

namestring

skustring

short_descriptionstring

long_descriptionstring

ean_gtinstring

brand_idstring

brand_namestring

video_urlstring

pricenumber

stocknumber

warehouse_defaultstring

warehouse_default_namestring

maximum_discountnumber

minimum_stocknumber

minimum_for_salenumber

multiple_for_salenumber

standard_unit_idstring

standard_unit_namestring

standard_unit_abbreviationstring

category_idstring

category_namestring

product_weightnumber

product_widthnumber

product_heightnumber

product_depthnumber

packaging_weightnumber

packaging_widthnumber

packaging_heightnumber

packaging_depthnumber

alternative_unitsarray of AlternativeUnitResponse (object)

imagesarray of ProductImageResponse (object)

attributesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/products/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "brand_id": "text",
      "category_id": "text",
      "ean_gtin": "text",
      "long_description": "text",
      "minimum_for_sale": 0,
      "minimum_stock": 0,
      "multiple_for_sale": 0,
      "name": "text",
      "packaging_depth": 0,
      "packaging_height": 0,
      "packaging_weight": 0,
      "packaging_width": 0,
      "price": 0,
      "product_depth": 0,
      "product_height": 0,
      "product_weight": 0,
      "product_width": 0,
      "short_description": "text",
      "sku": "text",
      "stock": 0,
      "video_url": "text"
    }),
});
const data = await response.json();

Response

200422500

{
  "id": "text",
  "active": false,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "brand_name": "text",
  "video_url": "text",
  "price": 0,
  "stock": 0,
  "warehouse_default": "text",
  "warehouse_default_name": "text",
  "maximum_discount": 0,
  "minimum_stock": 0,
  "minimum_for_sale": 0,
  "multiple_for_sale": 0,
  "standard_unit_id": "text",
  "standard_unit_name": "text",
  "standard_unit_abbreviation": "text",
  "category_id": "text",
  "category_name": "text",
  "product_weight": 0,
  "product_width": 0,
  "product_height": 0,
  "product_depth": 0,
  "packaging_weight": 0,
  "packaging_width": 0,
  "packaging_height": 0,
  "packaging_depth": 0,
  "alternative_units": [
    {
      "id": "text",
      "product_id": "text",
      "unit_id": "text",
      "unit_name": "text",
      "unit_abbreviation": "text",
      "decimals_for_quantity": 0,
      "value_multiplier": 0,
      "quantity": 0
    }
  ],
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": false
    }
  ]
}

Remove an existing product

DELETEhttps://api.zydon.com.br/api/sales/products/{id}

Authorization

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

Path parameters

id*string

Response

204422500

Product removed successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/products/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

204422500

{
  "id": "text"
}

List all products

GEThttps://api.zydon.com.br/api/sales/products

Authorization

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

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListProductResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/products', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "active": false,
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "long_description": "text",
      "ean_gtin": "text",
      "brand_id": "text",
      "brand_name": "text",
      "video_url": "text",
      "price": 0,
      "stock": 0,
      "warehouse_default": "text",
      "warehouse_default_name": "text",
      "maximum_discount": 0,
      "minimum_stock": 0,
      "minimum_for_sale": 0,
      "multiple_for_sale": 0,
      "standard_unit_id": "text",
      "standard_unit_name": "text",
      "standard_unit_abbreviation": "text",
      "category_id": "text",
      "category_name": "text",
      "product_weight": 0,
      "product_width": 0,
      "product_height": 0,
      "product_depth": 0,
      "packaging_weight": 0,
      "packaging_width": 0,
      "packaging_height": 0,
      "packaging_depth": 0,
      "alternative_units": [
        {
          "id": "text",
          "product_id": "text",
          "unit_id": "text",
          "unit_name": "text",
          "unit_abbreviation": "text",
          "decimals_for_quantity": 0,
          "value_multiplier": 0,
          "quantity": 0
        }
      ]
    }
  ]
}

Create a new product

POSThttps://api.zydon.com.br/api/sales/products

Authorization

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

Body

application/json

idstring

active*boolean

name*string

sku*string

short_description*string

long_description*string

ean_gtin*string

brand_id*string

video_url*string

price*number

stock*number

warehouse_defaultstring

maximum_discount*number

minimum_stock*number

minimum_for_sale*number

multiple_for_sale*number

standard_unit_idstring

category_id*string

product_weight*number

product_width*number

product_height*number

product_depth*number

packaging_weight*number

packaging_width*number

packaging_height*number

packaging_depth*number

imagesarray of ProductImageRequest (object)

alternative_unitsarray of CreateProductAlternativeUnitRequest (object)

attributesobject

Response

200422500

Product created successfully

Body

application/json

idstring

activeboolean

namestring

skustring

short_descriptionstring

long_descriptionstring

ean_gtinstring

brand_idstring

brand_namestring

video_urlstring

pricenumber

stocknumber

warehouse_defaultstring

warehouse_default_namestring

maximum_discountnumber

minimum_stocknumber

minimum_for_salenumber

multiple_for_salenumber

standard_unit_idstring

standard_unit_namestring

standard_unit_abbreviationstring

category_idstring

category_namestring

product_weightnumber

product_widthnumber

product_heightnumber

product_depthnumber

packaging_weightnumber

packaging_widthnumber

packaging_heightnumber

packaging_depthnumber

alternative_unitsarray of AlternativeUnitResponse (object)

imagesarray of ProductImageResponse (object)

attributesobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/products', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "active": false,
      "brand_id": "text",
      "category_id": "text",
      "ean_gtin": "text",
      "long_description": "text",
      "maximum_discount": 0,
      "minimum_for_sale": 0,
      "minimum_stock": 0,
      "multiple_for_sale": 0,
      "name": "text",
      "packaging_depth": 0,
      "packaging_height": 0,
      "packaging_weight": 0,
      "packaging_width": 0,
      "price": 0,
      "product_depth": 0,
      "product_height": 0,
      "product_weight": 0,
      "product_width": 0,
      "short_description": "text",
      "sku": "text",
      "stock": 0,
      "video_url": "text"
    }),
});
const data = await response.json();

Response

200422500

{
  "id": "text",
  "active": false,
  "name": "text",
  "sku": "text",
  "short_description": "text",
  "long_description": "text",
  "ean_gtin": "text",
  "brand_id": "text",
  "brand_name": "text",
  "video_url": "text",
  "price": 0,
  "stock": 0,
  "warehouse_default": "text",
  "warehouse_default_name": "text",
  "maximum_discount": 0,
  "minimum_stock": 0,
  "minimum_for_sale": 0,
  "multiple_for_sale": 0,
  "standard_unit_id": "text",
  "standard_unit_name": "text",
  "standard_unit_abbreviation": "text",
  "category_id": "text",
  "category_name": "text",
  "product_weight": 0,
  "product_width": 0,
  "product_height": 0,
  "product_depth": 0,
  "packaging_weight": 0,
  "packaging_width": 0,
  "packaging_height": 0,
  "packaging_depth": 0,
  "alternative_units": [
    {
      "id": "text",
      "product_id": "text",
      "unit_id": "text",
      "unit_name": "text",
      "unit_abbreviation": "text",
      "decimals_for_quantity": 0,
      "value_multiplier": 0,
      "quantity": 0
    }
  ],
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": false
    }
  ]
}