VTEX · Schema

shippingAddress

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
addressId	string	Shipping address ID.
addressType	string	Type of the address. Possible values are `residential` or `pickup`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/shippingAddress",
  "title": "shippingAddress",
  "required": [
    "addressId",
    "addressType"
  ],
  "type": "object",
  "properties": {
    "addressId": {
      "type": "string",
      "nullable": true,
      "description": "Shipping address ID.",
      "example": "8109266555005"
    },
    "addressType": {
      "type": "string",
      "nullable": true,
      "description": "Type of the address. Possible values are `residential` or `pickup`.",
      "example": "residential"
    }
  },
  "additionalProperties": false
}