VTEX · Example Payload

Vtex Skubyalternateid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Skubyalternateid Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "SkubyAlternateId",
  "method": "GET",
  "path": "/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/{alternateId}",
  "summary": "VTex Get SKU by alternate ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": 310118450,
        "ProductId": 2,
        "NameComplete": "Caixa de Areia Azul Petmate sku test",
        "ComplementName": "",
        "ProductName": "Caixa de Areia Azul Petmate",
        "ProductDescription": "",
        "ProductRefId": "",
        "TaxCode": "",
        "SkuName": "sku test",
        "IsActive": true,
        "IsTransported": true,
        "IsInventoried": true,
        "IsGiftCardRecharge": false,
        "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451-55-55/caixa-areia-azul-petmate.jpg?v=637139451191670000",
        "DetailUrl": "/caixa-de-areia-azul-petmate/p",
        "CSCIdentification": null,
        "BrandId": "2000005",
        "BrandName": "Petmate",
        "IsBrandActive": true,
        "Dimension": {
          "cubicweight": 0.2083,
          "height": 10.0,
          "length": 10.0,
          "weight": 10.0,
          "width": 10.0
        },
        "RealDimension": {
          "realCubicWeight": 0.0,
          "realHeight": 0.0,
          "realLength": 0.0,
          "realWeight": 0.0,
          "realWidth": 0.0
        },
        "ManufacturerCode": "123",
        "IsKit": false,
        "KitItems": [],
        "Services": [],
        "Categories": [],
        "CategoriesFullPath": [
          "/3/15/",
          "/3/",
          "/1/"
        ],
        "Attachments": [],
        "Collections": [],
        "SkuSellers": [
          {
            "SellerId": "1",
            "StockKeepingUnitId": 310118450,
            "SellerStockKeepingUnitId": "310118450",
            "IsActive": true,
            "FreightCommissionPercentage": 0.0,
            "ProductCommissionPercentage": 0.0
          }
        ],
        "SalesChannels": [
          1,
          3
        ],
        "Images": [
          {
            "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451/caixa-areia-azul-petmate.jpg?v=637139451191670000",
            "ImageName": null,
            "FileId": 155451
          }
        ],
        "Videos": [],
        "SkuSpecifications": [],
        "ProductSpecifications": [],
        "ProductClustersIds": "151,158",
        "PositionsInClusters": {
          "151": 1,
          "158": 2
        },
        "ProductClusterNames": {
          "151": "asdfghj",
          "158": "Cole\u00e7\u00e3o halloween"
        },
        "ProductClusterHighlights": {
          "151": "asdfghj"
        },
        "ProductCategoryIds": "/3/15/",
        "IsDirectCategoryActive": true,
        "ProductGlobalCategoryId": 5000,
        "ProductCategories": {
          "15": "Caixa de Areia",
          "3": "Higiene",
          "1": "Alimenta\u00e7\u00e3o"
        },
        "CommercialConditionId": 1,
        "RewardValue": 0.0,
        "AlternateIds": {
          "RefId": "1"
        },
        "AlternateIdValues": [
          "1"
        ],
        "EstimatedDateArrival": null,
        "MeasurementUnit": "un",
        "UnitMultiplier": 1.0,
        "InformationSource": null,
        "ModalType": null,
        "KeyWords": "",
        "ReleaseDate": "2020-01-06T00:00:00Z",
        "ProductIsVisible": true,
        "ShowIfNotAvailable": true,
        "IsProductActive": true,
        "ProductFinalScore": 0
      }
    }
  ]
}