VTEX · Schema

Shipping

Shipping information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
value number Shipping value with two decimal places.
estimatedDate string Estimated shipping date ISO 8601.
address object
View JSON Schema on GitHub

JSON Schema

vtex-shipping-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Shipping",
  "title": "Shipping",
  "description": "Shipping information.",
  "required": [
    "value",
    "estimatedDate",
    "address"
  ],
  "type": "object",
  "properties": {
    "value": {
      "type": "number",
      "description": "Shipping value with two decimal places.",
      "example": 8.41
    },
    "estimatedDate": {
      "type": "string",
      "description": "Estimated shipping date ISO 8601.",
      "example": "2017-08-02T14:46:47"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    }
  }
}