VTEX · Schema

SKUServiceTypeResponse

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
Id	integer	SKU service type ID.
Name	string	SKU service type name. Maximum of 100 characters.
IsActive	boolean	Defines if the SKU service type is active or not.
ShowOnProductFront	boolean	Deprecated field.
ShowOnCartFront	boolean	Defines if the SKU service type is displayed on the cart screen.
ShowOnAttachmentFront	boolean	Defines if the SKU service type has an attachment.
ShowOnFileUpload	boolean	Defines if the SKU service type can be associated with an attachment or not.
IsGiftCard	boolean	Defines if the SKU service type is displayed as a Gift Card.
IsRequired	boolean	Defines if the SKU service type is mandatory.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SKUServiceTypeResponse",
  "title": "SKUServiceTypeResponse",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "description": "SKU service type ID.",
      "example": 2
    },
    "Name": {
      "type": "string",
      "description": "SKU service type name. Maximum of 100 characters.",
      "example": "Test API Sku Services"
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the SKU service type is active or not.",
      "example": true
    },
    "ShowOnProductFront": {
      "type": "boolean",
      "description": "Deprecated field.",
      "example": false,
      "deprecated": true
    },
    "ShowOnCartFront": {
      "type": "boolean",
      "description": "Defines if the SKU service type is displayed on the cart screen.",
      "example": false
    },
    "ShowOnAttachmentFront": {
      "type": "boolean",
      "description": "Defines if the SKU service type has an attachment.",
      "default": false
    },
    "ShowOnFileUpload": {
      "type": "boolean",
      "description": "Defines if the SKU service type can be associated with an attachment or not.",
      "default": false
    },
    "IsGiftCard": {
      "type": "boolean",
      "description": "Defines if the SKU service type is displayed as a Gift Card.",
      "default": false
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Defines if the SKU service type is mandatory.",
      "default": false
    }
  },
  "example": {
    "Id": 2,
    "Name": "Test API SKU services",
    "IsActive": true,
    "ShowOnProductFront": true,
    "ShowOnCartFront": true,
    "ShowOnAttachmentFront": true,
    "ShowOnFileUpload": true,
    "IsGiftCard": true,
    "IsRequired": true
  }
}