Campos mínimos para métodos de produtos e SKU's na layer

Este tutorial mostra os campos mínimos a serem preenchidos para a execução de métodos de produtos e SKU’s na API (layer) da plataforma Linx Commerce.

❗️

Importante

Para obter os retornos corretos, execute os três primeiros métodos a seguir nesta ordem: SaveProduct > SaveSKU > AddSkuToProduct

SaveProduct

Método usado para salvar um novo produto ou atualizar um produto existente
Exemplo de um novo produto salvo:

{
        "ProductID": 307,
        "ProductType": 1,
        "ProductInventory": {
            "InventoryDisplaying": {
                "DisplayStockQty": false,
                "DisplayAvailability": "Y"
            },
            "Inventory": {
                "ForceOutOfStock": false
            }
        },
        "ProductDetails": {
            "General": {
                "Name": "Mini Bike Compact Acte Teste",
                "BrandID": 30,
                "Categories": [
                    {
                        "CategoryID": 30,
                        "IsMain": true
                    }
                ]
            },
            "GeneralDisplaying": {
                "IsVisible": true,
                "VisibleFrom": "/Date(1585796340)/",
                "IsSearchable": true,
                "IsUponRequest": false
            },
            "Flag": {},
            "SkuDetails": {
                "Name": "Mini Bike Compact Acte Teste",
                "ProductDefinitionID": 16,
                "VariationProperties": []
            },
            "Purchase": {}
        },
        "ProductDescriptions": {
            "SeoDescription": {
                "PageTitle": "Mini Bike Compact Acte",
                "UrlFriendly": "mini-bike-compact-acte_5",
                "MetaDescription": "Mini Bike Compact - Acte",
                "MetaKeywords": "mini bike compact acte, mini bike compact e14 - acte, mini bike compact para exercícios, mini bike compact e14 acte sports"
            },
            "Description": {
                "ShortDescription": "A Mini Bike Compact foi desenvolvida com design moderno, dobrável e super leve, ocupa pouco espaço e pode ser transportada facilmente.",
                "LongDescription": " ",
                "WarrantyDescription": "",
                "ExtendedDescriptions": []
            },
            "TagSearch": {
                "SearchKeywords": ""
            }
        },
        "ProductMisc": {
            "AcceptanceTerm": {
                "UseAcceptanceTerm": false,
                "AcceptanceTermID": 0
            },
            "Rating": {
                "RatingSetID": 1
            }
        },
        "ProductPrice": {
            "Pricing": {
                "DisplayPrice": "Y"
            }
        },
        "ProductShipping": {
            "ShippingRegion": {
                "IsFreeShipping": false
            }
        },
        "ProductAssociations": {
            "Behaviour": {},
            "Association": {
                "Associations": []
            }
        },
        "ProductExtended": {
            "Extended": {
                "ExtendedExtensions": [
                    {
                        "ID": 180,
                        "Name": "lebes_pai",
                        "Value": "Teste"
                    },
                    {
                        "ID": 181,
                        "Name": "canal",
                        "Value": "Teste 2"
                    },
                ]
            }
        },
        "ProductVariation": {}
    }


--

Exemplo de produto modificado com os campos mínimos a serem preenchidos:

{
        "ProductID": 307,
        "ProductType": 1,
        "ProductInventory": {
            "InventoryDisplaying": {
                "DisplayStockQty": false,
                "DisplayAvailability": "Y"
            },
            "Inventory": {
                "ForceOutOfStock": false
            }
        },
        "ProductDetails": {
            "General": {
                "Name": "Mini Bike Compact Acte Teste",
                "BrandID": 30,
                "Categories": [
                    {
                        "CategoryID": 30,
                        "IsMain": true
                    }
                ]
            },
            "GeneralDisplaying": {
                "IsVisible": true,
                "VisibleFrom": "/Date(1585796340)/",
                "IsSearchable": true,
                "IsUponRequest": false
            },
            "Flag": {},
            "SkuDetails": {
                "Name": "Mini Bike Compact Acte Teste",
                "ProductDefinitionID": 16,
                "VariationProperties": []
            },
            "Purchase": {}
        },
        "ProductDescriptions": {
            "SeoDescription": {
                "PageTitle": "Mini Bike Compact Acte",
                "UrlFriendly": "mini-bike-compact-acte_5",
                "MetaDescription": "Mini Bike Compact - Acte",
                "MetaKeywords": "mini bike compact acte, mini bike compact e14 - acte, mini bike compact para exercícios, mini bike compact e14 acte sports"
            },
            "Description": {
                "ShortDescription": "A Mini Bike Compact foi desenvolvida com design moderno, dobrável e super leve, ocupa pouco espaço e pode ser transportada facilmente.",
                "LongDescription": " ",
                "WarrantyDescription": "",
                "ExtendedDescriptions": []
            }
 
        },
            "ProductPrice": {
            "Pricing": {
                "DisplayPrice": "Y"
            }
        }
    }


--

Exemplo de produto modificado com todos os campos preenchidos:

{
        "ProductID": 307,
        "ProductType": 1,
        "ProductInventory": {
            "InventoryDisplaying": {
                "DisplayStockQty": false,
                "DisplayAvailability": "Y"
            },
            "Inventory": {
                "ForceOutOfStock": false
            }
        },
        "ProductDetails": {
            "General": {
                "Name": "Mini Bike Compact Acte Teste",
                "BrandID": 30,
                "Categories": [
                    {
                        "CategoryID": 30,
                        "IsMain": true
                    }
                ]
            },
            "GeneralDisplaying": {
                "IsVisible": true,
                "VisibleFrom": "/Date(1585796340)/",
                "IsSearchable": true,
                "IsUponRequest": false
            },
            "Flag": {},
            "SkuDetails": {
                "Name": "Mini Bike Compact Acte Teste",
                "ProductDefinitionID": 16,
                "VariationProperties": []
            },
            "Purchase": {}
        },
        "ProductDescriptions": {
            "SeoDescription": {
                "PageTitle": "Mini Bike Compact Acte",
                "UrlFriendly": "mini-bike-compact-acte_5",
                "MetaDescription": "Mini Bike Compact - Acte",
                "MetaKeywords": "mini bike compact acte, mini bike compact e14 - acte, mini bike compact para exercícios, mini bike compact e14 acte sports"
            },
            "Description": {
                "ShortDescription": "A Mini Bike Compact foi desenvolvida com design moderno, dobrável e super leve, ocupa pouco espaço e pode ser transportada facilmente.",
                "LongDescription": " ",
                "WarrantyDescription": "",
                "ExtendedDescriptions": []
            },
            "TagSearch": {
                "SearchKeywords": ""
            }
        },
        "ProductMisc": {
            "AcceptanceTerm": {
                "UseAcceptanceTerm": false,
                "AcceptanceTermID": 0
            },
            "Rating": {
                "RatingSetID": 1
            }
        },
        "ProductPrice": {
            "Pricing": {
                "DisplayPrice": "Y"
            }
        },
        "ProductShipping": {
            "ShippingRegion": {
                "IsFreeShipping": false
            }
        },
        "ProductAssociations": {
            "Behaviour": {},
            "Association": {
                "Associations": []
            }
        },
        "ProductExtended": {
            "Extended": {
                "ExtendedExtensions": [
                    {
                        "ID": 180,
                        "Name": "lebes_pai",
                        "Value": "Teste"
                    },
                    {
                        "ID": 181,
                        "Name": "canal",
                        "Value": "Teste 2"
                    },
                ]
            }
        },
        "ProductVariation": {}
    }

SaveSKU

Método usado para salvar ou atualizar um SKU
Exemplo de um novo SKU salvo:

{
    
    "IntegrationID": 102030,
    "SKU": 102040,
    "ProductType": 1,
    "StockKeepUnitDetails": {
        "GeneralDisplaying": {
            "IsSearchable": true,
            "IsUponRequest": false,
            "IsVisible": true,
            "VisibleFrom": "/Date(1585796340)/"
        },
        "SkuDetails": {
            
            "Name":"Mini Bike Compact Acte Teste Azul",
            "ProductDefinitionID": 16,
            "Suppliers": [],
            "VariationProperties": []
        }
    },
    "StockKeepUnitInventory": {
        "Backorder": {
            "BackorderLimit": 0,
            "Backorderable": false
        },
        "Handling": {
            "InStockHandlingDays": 0,
            "OutStockHandlingDays": 0
        },
        "Preorder": {
            "Preorderable": false
        },
        "Purchase": {
            "MaximumQtyAllowed": 0,
            "MinimumQtyAllowed": 0
        },
        "SkuInventory": {
            "DisableOnReorderPoint": true,
            "ForceOutOfStock": false,
            "ManageStock": true,
            "NotifyReorderPoint": true,
            "ReorderPoint": 0,
            "Replenishment": 0
        },
        "SkuInventoryDisplaying": {}
    },
    "StockKeepUnitMisc": {
        "SkuMisc": {
            "DisplayCondition": true,
            "ProductConditionID": 1,
            "UPC": "7898578452146",
            "UomID": 2,
            "WrappingQty": 1
        }
    },
    "StockKeepUnitPrice": {
        "ProductType": 5,
        "Promotion": {
            "DenyPromo": false,
            "DisplayPromoOnlyCheckout": false,
            "IsPromo": true,
            "PromoFrom": "\/Date(1585796340)\/",
            "PromoPrice": 341
        },
        "SkuPricing": {
            "Cost": 0,
            "Price": 342,
            "Tax": 0
        }
    },
    "StockKeepUnitShipping": {
        "Dimension": {
            "Depth": 2,
            "Height": 40,
            "Weight": 40,
            "Width": 40
        },
        "Delivery": {
            "IsDeliverable": true,
            "ShipsIndividually": true
        }
    },
    "StockKeepUnitExtended": {
        "Extended": {
            "ExtendedExtensions": [
                
            ]
        }
    }
}{
    "ProductID": 346,
    "IntegrationID": 102030,
    "SKU": 102040,
    "ProductType": 1,
    "StockKeepUnitDetails": {
        "GeneralDisplaying": {
            "IsSearchable": true,
            "IsUponRequest": false,
            "IsVisible": true,
            "VisibleFrom": "/Date(1585796340)/"
        },
        "SkuDetails": {
            
            "Name":"Mini Bike Compact Acte Teste Azul",
            "ProductDefinitionID": 16,
            "Suppliers": [],
            "VariationProperties": []
        }
    },
    "StockKeepUnitInventory": {
        "Backorder": {
            "BackorderLimit": 0,
            "Backorderable": false
        },
        "Handling": {
            "InStockHandlingDays": 0,
            "OutStockHandlingDays": 0
        },
        "Preorder": {
            "Preorderable": false
        },
        "Purchase": {
            "MaximumQtyAllowed": 0,
            "MinimumQtyAllowed": 0
        },
        "SkuInventory": {
            "DisableOnReorderPoint": true,
            "ForceOutOfStock": false,
            "ManageStock": true,
            "NotifyReorderPoint": true,
            "ReorderPoint": 0,
            "Replenishment": 0
        },
        "SkuInventoryDisplaying": {}
    },
    "StockKeepUnitMisc": {
        "SkuMisc": {
            "DisplayCondition": true,
            "ProductConditionID": 1,
            "UPC": "7898578452146",
            "UomID": 2,
            "WrappingQty": 1
        }
    },
    "StockKeepUnitPrice": {
        "ProductType": 5,
        "Promotion": {
            "DenyPromo": false,
            "DisplayPromoOnlyCheckout": false,
            "IsPromo": true,
            "PromoFrom": "\/Date(1585796340)\/",
            "PromoPrice": 341
        },
        "SkuPricing": {
            "Cost": 0,
            "Price": 342,
            "Tax": 0
        }
    },
    "StockKeepUnitShipping": {
        "Dimension": {
            "Depth": 2,
            "Height": 40,
            "Weight": 40,
            "Width": 40
        },
        "Delivery": {
            "IsDeliverable": true,
            "ShipsIndividually": true
        }
    },
    "StockKeepUnitExtended": {
        "Extended": {
            "ExtendedExtensions": [
                
            ]
        }
    }
}

Exemplo de SKU modificado com os campos mínimos a serem preenchidos:

{
    "ProductID": 346,
    "IntegrationID": 102030,
    "SKU": 102040,
    "ProductType": 1,
    "StockKeepUnitDetails": {
        "GeneralDisplaying": {
            "IsSearchable": true,
            "IsUponRequest": false,
            "IsVisible": true,
            "VisibleFrom": "/Date(1585796340)/"
        },
        "SkuDetails": {
            
            "Name":"Mini Bike Compact Acte Teste Azul",
            "ProductDefinitionID": 16,
            "Suppliers": [],
            "VariationProperties": []
        }
    },
    "StockKeepUnitInventory": {
        "Backorder": {
            "BackorderLimit": 0,
            "Backorderable": false
        },
        "Handling": {
            "InStockHandlingDays": 0,
            "OutStockHandlingDays": 0
        },
        
      "SkuInventory": {
            
            
        },
        "SkuInventoryDisplaying": {}
    },

    "StockKeepUnitPrice": {
        "ProductType": 5,
        "Promotion": {
            "DenyPromo": false,
            "DisplayPromoOnlyCheckout": false,
            "IsPromo": true,
            "PromoFrom": "\/Date(1585796340)\/",
            "PromoPrice": 341
        },
        "SkuPricing": {
            "Cost": 0,
            "Price": 342

        }
    }
}

Exemplo de SKU modificado com todos os campos preenchidos:

{
    "ProductID": 346,
    "IntegrationID": 102030,
    "SKU": 102040,
    "ProductType": 1,
    "StockKeepUnitDetails": {
        "GeneralDisplaying": {
            "IsSearchable": true,
            "IsUponRequest": false,
            "IsVisible": true,
            "VisibleFrom": "/Date(1585796340)/"
        },
        "SkuDetails": {
            
            "Name":"Mini Bike Compact Acte Teste Verde",
            

            "ProductDefinitionID": 16,
            "Suppliers": [],
            "VariationProperties": []
        }
    },
    "StockKeepUnitInventory": {
        "Backorder": {
            "BackorderLimit": 0,
            "Backorderable": false
        },
        "Handling": {
            "InStockHandlingDays": 0,
            "OutStockHandlingDays": 0
        },
        "Preorder": {
            "Preorderable": false
        },
        "Purchase": {
            "MaximumQtyAllowed": 0,
            "MinimumQtyAllowed": 0
        },
        "SkuInventory": {
            "DisableOnReorderPoint": true,
            "ForceOutOfStock": false,
            "ManageStock": true,
            "NotifyReorderPoint": true,
            "ReorderPoint": 0,
            "Replenishment": 0
        },
        "SkuInventoryDisplaying": {}
    },
    "StockKeepUnitMisc": {
        "SkuMisc": {
            "DisplayCondition": true,
            "ProductConditionID": 1,
            "UPC": "7898578452146",
            "UomID": 2,
            "WrappingQty": 1
        }
    },
    "StockKeepUnitPrice": {
        "ProductType": 5,
        "Promotion": {
            "DenyPromo": false,
            "DisplayPromoOnlyCheckout": false,
            "IsPromo": true,
            "PromoFrom": "\/Date(1585796340)\/",
            "PromoPrice": 341
        },
        "SkuPricing": {
            "Cost": 0,
            "Price": 342,
            "Tax": 0
        }
    },
    "StockKeepUnitShipping": {
        "Dimension": {
            "Depth": 2,
            "Height": 40,
            "Weight": 40,
            "Width": 40
        },
        "Delivery": {
            "IsDeliverable": true,
            "ShipsIndividually": true
        }
    },
    "StockKeepUnitExtended": {
        "Extended": {
            "ExtendedExtensions": [
                
            ]
        }
    }
}

AddSKUToProduct

Método usado para adicionar um SKU criado a um produto
Ex.:

{
  "SkuID": 312,
  "ProductID": 307
}

GetProduct

Método usado para retornar um determinado produto
Exemplo de mapeamento usando o método GetProduct:

{
  "CreatedBy": "core.mario.falcao", -- NAO
  "CreatedDate": "/Date(1629287956547-0300)/", - NAO
  "IntegrationID": "", --NAO
  "ModifiedBy": "",--NAO
  "ModifiedDate": "/Date(1629301874570-0300)/",-- NAO
  "Name": "Mini Bike Compact Acte Teste", -- SIM Vai no Objeto General - SkuDetails
  "ProductID": 307,-- SIM -Necessário passar para modificar o Produto
  "SKU": "1701",-- NAO 
  "AcceptanceTermID": 0,-- NAO
  "BrandID": 30,-- SIM - ProductDatails > General > BrandId
  "CatalogItemType": 6,-- NAO, esse cód demonstra se é PordutoPai e Sku - 6 ProdutoPai, 5 Sku 
  "CategoriesID": [
    30
  ], SIM - ProductDatails > General > Categories > CategoryId
  "DefinitionID": 16, SIM -- SkuDatails > ProductDefinitionId
  "DisplayAvailability": "Y", SIM -- ProductInventory > InventoryDisplaying > DisplayAvailability
  "DisplayPrice": "Y", SIM -- ProductPrice > Pricing > DisplayPrice
  "DisplayStockQty": false, SIM -- ProductInventory > InventoryDisplaying > DisplayStockQty
  "FlagsID": [],SIM -- Vazio -- ver no modelo, se tiver passar
  "IsDeleted": false, NAO
  "IsFreeShipping": false,NAO
  "IsNew": false,NAO
  "IsSearchable": true, SIM -- GeneralDisplaying > IsSearchable
  "IsUponRequest": false, SIM -- GeneralDisplaying > IsUponRequest
  "IsVisible": true, SIM -- GeneralDisplaying > IsVisible
  "LongDescription": " ", SIM -- Description > LongDescription
  "Medias": [],NAO
  "MediasID": [],NAO
  "MetaDescription": "Mini Bike Compact - Acte", SIM, ProductDescriptions > SeoDescription > MetaDescription
  "MetaKeywords": "mini bike compact acte, mini bike compact e14 - acte, mini bike compact para exercícios, mini bike compact e14 acte sports", SIM, ProductDescriptions > SeoDescription > MetaKeywords
  "MetadataValues": [ -- Abaixo os metadados, não e obrigatório passar eles, apenas se quiser mudar.
    {
      "DisplayName": "Referência",
      "FormattedValue": "",
      "InputType": 1,
      "IntegrationID": "10",
      "PropertyGroup": "description",
      "PropertyMetadataID": 64,
      "PropertyName": "Reference",
      "SerializedBlobValue": "",
      "SerializedValue": null,
      "Value": null
    },
    {
      "DisplayName": "Descrição Curta Integração",
      "FormattedValue": "",
      "InputType": 1,
      "IntegrationID": "2",
      "PropertyGroup": "description",
      "PropertyMetadataID": 71,
      "PropertyName": "ShortDescriptionAbac",
      "SerializedBlobValue": "",
      "SerializedValue": null,
      "Value": null
    },
    {
      "DisplayName": "Listagem Múltipla",
      "FormattedValue": "",
      "InputType": 3,
      "IntegrationID": null,
      "PropertyGroup": "extended",
      "PropertyMetadataID": 143,
      "PropertyName": "multiple",
      "SerializedBlobValue": null,
      "SerializedValue": "009725",
      "Value": "009725"
    },
    {
      "DisplayName": "Lebes Pai",
      "FormattedValue": "",
      "InputType": 0,
      "IntegrationID": null,
      "PropertyGroup": "extended",
      "PropertyMetadataID": 180,
      "PropertyName": "lebes_pai",
      "SerializedBlobValue": null,
      "SerializedValue": "",
      "Value": null
    },
    {
      "DisplayName": "canal",
      "FormattedValue": "009725",
      "InputType": 0,
      "IntegrationID": null,
      "PropertyGroup": "extended",
      "PropertyMetadataID": 181,
      "PropertyName": "canal",
      "SerializedBlobValue": null,
      "SerializedValue": "009725",
      "Value": "009725"
    },
    {
      "DisplayName": "Gênero",
      "FormattedValue": "",
      "InputType": 0,
      "IntegrationID": null,
      "PropertyGroup": "extended",
      "PropertyMetadataID": 6130,
      "PropertyName": "Genero",
      "SerializedBlobValue": null,
      "SerializedValue": "",
      "Value": null
    }
  ],
  "NewFrom": null, --NAO
  "NewTo": null,-- NAO
  "PageTitle": "Mini Bike Compact Acte", --SIM -- ProductDescriptions > SeoDescription > PageTitle
  "PurchasingPolicyID": null, -- NAO
  "RatingSetID": 1,-- NAO
  "SearchKeywords": "",-- NAO
  "SendToMarketplace": false,-- NAO
  "ShippingRegionsID": [],-- NAO
  "ShortDescription": "A Mini Bike Compact foi desenvolvida com design moderno, dobrável e super leve, ocupa pouco espaço e pode ser transportada facilmente.",-- SIM -- Description > ShortDescription
  "SkusID": [],--NAO, apenas informa os skus ivnulados ao pai
  "TagsID": [],--NAO,
  "UrlFriendly": "mini-bike-compact-acte-5",--SIM
  "UseAcceptanceTerm": false,--NAO
  "VisibleFrom": "/Date(1592996340-0300)/",--SIM  GeneralDisplaying > VisibleFrom
  "VisibleTo": null,--NAO
  "WarrantyDescription": "" --SIM - Description > WarrantyDescription
}

GetSKU

Método usado para retornar um determinado SKU
Exemplo de mapeamento usando o método GetSKU:

{
    "CreatedBy": "",--NAO
    "CreatedDate": "/Date(1629313395947-0300)/",--NAO
    "IntegrationID": null,--NAO --
    "ModifiedBy": "",--NAO
    "ModifiedDate": "/Date(1629374478453-0300)/",--NAO
    "Name": "Mini Bike Compact Acte Teste Azul",--SIM > SkuDetails
    "ProductID": 346,--SIM > Modificar
    "SKU": "102040",--SIM
    "BackorderLimit": 0.00,-- SIM
    "Backorderable": false,-- SIM
    "ConditionID": 1,-- NAO
    "Cost": 0.000,-- SIM
    "DefinitionID": 16, -- SIM
    "Depth": 2.000, -- NAO
    "DisplayCondition": true, -- NAO
    "Height": 40.000,-- NAO
    "IsDeleted": false, -- NAO
    "IsVisible": true, -- SIM
    "ManageStock": false, -- NAO
    "MaximumQtyAllowed": 0.00, -- NAO
    "MetadataValues": [-- NAO 
        {
            "DisplayName": "Tamanho",
            "FormattedValue": "",
            "InputType": 4,
            "IntegrationID": "15",
            "PropertyGroup": "variation",
            "PropertyMetadataID": 40,
            "PropertyName": "Tamanho",
            "SerializedBlobValue": null,
            "SerializedValue": "",
            "Value": null
        },
        {
            "DisplayName": "Circunferência",
            "FormattedValue": "",
            "InputType": 7,
            "IntegrationID": null,
            "PropertyGroup": "extended",
            "PropertyMetadataID": 96,
            "PropertyName": "Circunferencia",
            "SerializedBlobValue": null,
            "SerializedValue": "",
            "Value": null
        }
    ],
    "MinimumQtyAllowed": 0.00, -- NAO
    "ParentRelations": [
        {
            "ParentID": 307,
            "ParentIntegrationID": "",
            "ParentSKU": "1710"
        }
    ],
    "ParentsID": [
        307
    ],
    "PreorderDate": null, -- NAO
    "PreorderLimit": 0.00,-- NAO
    "Preorderable": false,-- NAO
    "PurchasingPolicyID": null, -- NAO
    "SuppliersID": [],-- NAO
    "Tax": 0.000,-- NAO
    "UPC": "7898578452146",-- NAO
    "UnitOfMeasureID": 2 -- NAO,
    "VisibleFrom": "/Date(1592996340-0300)/",-- SIM
    "VisibleTo": null,-- NAO
    "Weight": 40.000,-- NAO
    "Width": 40.000,-- NAO
    "WrappingQty": 1.00 -- NAO
}

Did this page help you?