O método UpdateProduct possibilita inserir ou atualizar dados a nível cadastral de produtos ou SKUs.
Premissas:
- O método está contido em Catalog, na layer;
- URL: http://nomedoambiente.layer.com.br/v1/Catalog/API.svc/web/UpdateProduct
- Método = POST;
- As propriedades obrigatórias a serem informadas no método para que seja permitido o update, serão:
- ID do produto ou ID de Integração;
- CatalogItemType (5 = SKU e 6 = Produto);
- Limitação para update em lote será de 100 produtos ou SKUs. - A composição o lote deverá ser de apenas um tipo, produto ou SKU;
- Apenas propriedades a nível cadastral poderão ser alteradas. - Preço e estoque, por exemplo, não poderão ser alterados a partir desse método;
- Devem ser informadas na requisição apenas propriedades correspondentes ao tipo da entidade que será atualizada.
Propriedades que o método permitirá atualizar:
Entidade | Propriedade tabela | Propriedade Admin | Descrição |
Produto | SKU | SKU | Código do SKU |
Produto | Name | Nome | Nome |
Produto | IntegrationID | Identificador de Integração | Identificador de Integração |
Produto | BrandID | Marca | Marca do Produto |
Produto | IsVisible | Exibir esse produto no site | Definir se o produto deve ou não ser exibido no site |
Produto | VisibleFrom | Exibir a partir de | Definir a data inicial para exibição do produto |
Produto | VisibleTo | Exibir até | Definir a data de término de exibição de produto |
Produto | IsSearchable | Esse produto pode ser pesquisado | Definir se o Produto pode ou não pode ser pesquisado no site |
Produto | DisplayPrice | Exibir preço na loja | Definir se o preço pode ou não pode ser exibido no site |
Produto | DisplayAvailability | Exibir disponibilidade | Definir se produto está disponível (com estoque) ou indisponível (sem estoque) no site. |
Produto | DisplayStockQty | Exibir quantidade de estoque no site | Definir exibição de quantidade de estoque do produto no site |
Produto | IsNew | Exibir esse produto como novo | Defini exibição se o produto pe novo no site |
Produto | IsFreeShipping | Esse produto possui frete grátis para Ecommerce | Definir se o produto possui frete grátis |
Produto | IsUponRequest | Esse produto será comercializado sob-consulta | Definir se proíbe o cliente de concretizar a compra sozinho, necessitando de consulta do lojista. |
Produto | AcceptanceTermID | Termo de Aceite do Produto | Determina qual termo de aceitação o produto estará vinculado. |
Produto | PurchasingPolicyID | Política de compra | Definir qual a política de compra que o produto irá seguir. |
Produto | PurchasingFormID | Formulário de compra | Permite que seja vinculado um formulário de compra para a finalização do pedido. É útil para lojistas que vendem produtos que necessitam de comprovantes como receita médica, por exemplo. |
Produto | PageTitle | Título da página | Definir o nome do produto que será exibido na PDP (página do produto) do site. |
Produto | UrlFriendly | Url amigável | Definir a UTL do produto no site |
Produto | MetaDescription | Meta description | - |
Produto | MetaKeywords | Meta keywords: | - |
Produto | ShortDescription | Descrição Curta | - |
Produto | LongDescription | Descrição Longa | - |
Produto | WarrantyDescription | Descrição de Garantia | - |
Produto | SearchKeywords | Termos para Pesquisa | - |
Produto | RatingSetID | Avaliação | Grupo de Avaliação |
SKU | SKU | SKU | Código do SKU |
SKU | IntegrationID | Identificador de Integração | Identificador de Integração: |
SKU | Name | Nome | Nome do SKU |
SKU | UPC | Código de barras (EAN) | Definir o Código de Barras do SKU |
SKU | IsVisible | Exibir esse produto no site | Definir se o SKU deve ou não ser exibido no site |
SKU | VisibleFrom | Exibir a partir de | Definir a data inicial para exibição do produto |
SKU | VisibleTo | Exibir até | Definir a data de término de exibição de produto |
SKU | Preorderable | Este SKU encontra-se em pré-venda | Definir se o SKU encontra-se ou não encontra-se em pré-venda no site |
SKU | PreorderDate | Em pré-venda até | Definir a data de término de pré-venda do SKU |
SKU | PreorderLimit | Limite de pré-venda | Definir quantidade limite de pré-venda do SKU |
SKU | Backorderable | Permitir que este SKU seja vendido sem estoque | - |
SKU | BackorderLimit | Limite de venda sem estoque | - |
SKU | PurchasingPolicyID | Política de compra | Definir qual a política de compra que o sku irá seguir. |
SKU | PurchasingFormID | Formulário de compra | Permite que seja vinculado um formulário de compra para a finalização do pedido. É útil para lojistas que vendem produtos que necessitam de comprovantes como receita médica, por exemplo. |
SKU | DenyPromo | Este SKU não participa de promoções | Definir se o SKU participa ou n’ao participa de promoção |
SKU | Weight | Peso | Definir o peso do SKU |
SKU | Width | Largura | Definir a largura do SKU |
SKU | Height | Altura | Definir a altura do produto |
SKU | Depth | Profundidade | Definir a profundidade do produto |
SKU | ProductConditionID | Condição do SKU | Definir condição do SKU no site (Novo, Semi-Novo, Usado, Reutilizado) |
SKU | DisplayCondition | Exibir Condição no Site | Definir se será exibida a condição do SKU no contexto do site |
SKU | WrappingQty | Quantidade por Embalagem | Definir quantidade por Embalagem |
Body's Samples:
- Body Sample - Layer:
[
{
"ProductID": 0,
"CatalogItemType": "1 - Catalog",
"Sku": "string",
"Name": "string",
"IntegrationID": "string",
"BrandID": 0,
"IsVisible": true,
"VisibleFrom": "2023-09-01T20:26:30.555Z",
"VisibleTo": "2023-09-01T20:26:30.555Z",
"IsSearchable": true,
"DisplayPrice": "string",
"DisplayAvailability": "string",
"DisplayStockQty": true,
"IsNew": true,
"IsFreeShipping": true,
"IsUponRequest": true,
"AcceptanceTermID": 0,
"PurchasingPolicyID": 0,
"PurchasingFormID": 0,
"PageTitle": "string",
"UrlFriendly": "string",
"MetaDescription": "string",
"MetaKeywords": "string",
"ShortDescription": "string",
"LongDescription": "string",
"WarrantyDescription": "string",
"SearchKeywords": "string",
"RatingSetID": 0,
"UPC": "string",
"Preorderable": true,
"PreorderDate": "2023-09-01T20:26:30.555Z",
"PreorderLimit": 0,
"Backorderable": true,
"BackorderLimit": 0,
"DenyPromo": true,
"Weight": 0,
"Width": 0,
"Height": 0,
"Depth": 0,
"ProductConditionID": 0,
"DisplayCondition": true,
"WrappingQty": 0
}
]
- Body Sample preenchido - Produto:
[
{
"ProductID": 123,
"CatalogItemType": "6",
"MetaDescription": "Produto Teste - Linx",
"MetaKeywords": "produto teste linx, produto para teste, produto de teste",
"ShortDescription": "Produto para teste do método UpdateProduct",
}
]
- Body Sample preenchido - Produtos:
[
{
"ProductID": 123,
"CatalogItemType": "6",
"MetaDescription": "Produto Teste - Linx",
"MetaKeywords": "produto teste linx, produto para teste, produto de teste",
"ShortDescription": "Produto para teste do método UpdateProduct",
},
{
"ProductID": 124,
"CatalogItemType": "6",
"MetaDescription": "Produto Teste - Linx 1.0",
"MetaKeywords": "produto teste linx, produto para teste, produto de teste",
"ShortDescription": "Produto para teste do método UpdateProduct",
}
]
- Body Sample preenchido - SKU:
[
{
"ProductID": 125,
"CatalogItemType": "5",
"Depth": 2,
"Height": 30,
"Weight": 40,
"Width": 50
}
]
- Body Sample preenchido - SKUs:
[
{
"ProductID": 125,
"CatalogItemType": "5",
"Depth": 2,
"Height": 30,
"Weight": 40,
"Width": 50
},
{
"ProductID": 126,
"CatalogItemType": "5",
"Depth": 1,
"Height": 10,
"Weight": 20,
"Width": 30
}
]