VTvtex
SKU

Get SKU by reference ID

Changed on

Retrieves information about a specific SKU by its RefId.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
CatalogContentSKUs

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/catalog/pvt/stockkeepingunit

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/catalog/pvt/stockkeepingunit
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Query parameters

RefIdstring required
Example:1

SKU reference ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Idinteger

SKU unique identifier.

ProductIdinteger

ID of the product associated with this SKU.

IsActiveboolean

Defines if the SKU is active (true) or not (false).

ActivateIfPossibleboolean

When set to true, this attribute will automatically update the SKU as active once associated with an image or an active component.

Namestring

SKU name, meaning the variation of the previously added product. For example: Product - Fridge, SKU - 110V.

RefIdstring

Reference code used internally for organizational purposes. Must be unique. Required only if Ean is not informed, but can be used alongside Ean as well.

Eanstring

EAN code. Required only if RefId is not informed, but can be used alongside RefId as well.

PackagedHeightnumber

Height used for shipping calculation.

PackagedLengthnumber

Length used for shipping calculation.

PackagedWidthnumber

Width used for shipping calculation.

PackagedWeightKginteger

Weight used for shipping calculation, in the measurement unit configured in the store, which by default is in grams.

Heightnumber

SKU real height.

Lengthnumber

SKU real length.

Widthnumber

SKU real width.

WeightKgnumber

Weight of the SKU in the measurement configured in the store, which by default is in grams.

CubicWeightnumber

Cubic weight.

IsKitboolean

Defines whether the SKU is made up of one or more SKUs (part of a kit) (true) or not (false). Must be enabled if you are adding a kit. Once activated, this definition cannot be reverted.

CreationDatestring

Date and time of the SKU's creation.

RewardValuenumber nullable

Credit that the customer receives when finalizing an order that includes the SKU. By filling this field out with 1, the customer receives credit on the site in the selected currency, e.g. U$ 1.

EstimatedDateArrivalstring nullable

SKU estimated arrival date in ISO-8601 format, when the product is on pre-sale. You must take into consideration both the launch date and the freight calculation for the arrival date.

ManufacturerCodestring

Identifier provided by the manufacturers to identify their product. This field should be filled in if the product has a specific manufacturer's code.

CommercialConditionIdinteger

Commercial condition ID, used to define SKU specific promotions or installment rules. In case of no specific condition, use 1 (default value). This field does not accept 0. Learn more at Registering a commercial condition.

MeasurementUnitstring

Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. For example, if a product is sold in boxes, but customers want to buy per square meter (m²). In common cases, use "un".

UnitMultipliernumber

Multiple number of SKU. If the multiplier is 5.0000, the product can be added in multiple quantities of 5, 10, 15, 20, onward.

ModalTypestring nullable

Links an unusual type of SKU that needs special transportation, such as meat, glass, or a mattress, to a carrier specialized in delivering it. This field should be filled in with the name of the modal (e.g. "Chemicals" or "Refrigerated products"). To learn more about this feature, read our articles How the modal works and Setting up modal for carriers.

KitItensSellApartboolean

Defines if kit components can be sold apart.

Videosstring[]

Videos URLs.

Changes