VTEX · Schema

SKUServiceTypeRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
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

vtex-skuservicetyperequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SKUServiceTypeRequest",
  "title": "SKUServiceTypeRequest",
  "type": "object",
  "required": [
    "Name",
    "IsActive",
    "ShowOnProductFront",
    "ShowOnCartFront",
    "ShowOnAttachmentFront",
    "ShowOnFileUpload",
    "IsGiftCard",
    "IsRequired"
  ],
  "properties": {
    "Name": {
      "type": "string",
      "description": "SKU service type name. Maximum of 100 characters.",
      "default": "Test API Sku Services"
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the SKU service type is active or not.",
      "default": 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.",
      "example": false
    },
    "ShowOnFileUpload": {
      "type": "boolean",
      "description": "Defines if the SKU service type can be associated with an attachment or not.",
      "example": false
    },
    "IsGiftCard": {
      "type": "boolean",
      "description": "Defines if the SKU service type is displayed as a Gift Card.",
      "example": false
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Defines if the SKU service type is mandatory.",
      "example": false
    }
  }
}