VTEX · Schema

Type

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
metaData	object	Carrier metadata.
terms	string	Carrier terms.
rate	object	Carrier rate.
name	string	Carrier name.
transitTime	integer	Carrier transit time.
shippingEstimatedDate	string	Carrier Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
description	string	Carrier description.
id	string	Carrier ID.
international	boolean	Defines if the carrier is international (`true`) or not (`false`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Type",
  "title": "Type",
  "required": [
    "metaData",
    "terms",
    "rate",
    "name",
    "transitTime",
    "shippingEstimatedDate",
    "description",
    "id",
    "international"
  ],
  "type": "object",
  "properties": {
    "metaData": {
      "type": "object",
      "description": "Carrier metadata."
    },
    "terms": {
      "type": "string",
      "description": "Carrier terms."
    },
    "rate": {
      "$ref": "#/components/schemas/Rate1",
      "description": "Carrier rate."
    },
    "name": {
      "type": "string",
      "description": "Carrier name."
    },
    "transitTime": {
      "type": "integer",
      "format": "int32",
      "description": "Carrier transit time."
    },
    "shippingEstimatedDate": {
      "type": "string",
      "nullable": true,
      "description": "Carrier Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "description": {
      "type": "string",
      "description": "Carrier description."
    },
    "id": {
      "type": "string",
      "description": "Carrier ID."
    },
    "international": {
      "type": "boolean",
      "description": "Defines if the carrier is international (`true`) or not (`false`)."
    }
  },
  "example": {
    "metaData": {},
    "terms": "",
    "rate": {
      "shippingPrice": {
        "value": 284.02,
        "currency": "USD"
      },
      "insurancePrice": {
        "value": 0,
        "currency": "USD"
      }
    },
    "name": "FedEx First Overnight\u00ae",
    "transitTime": 0,
    "shippingEstimatedDate": "2024-01-05T11:11:11.000Z",
    "description": "",
    "id": "fedex_first_overnight",
    "international": false
  }
}