VTEX · Schema

MetaData1

Metadata about the Carrier.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
integrationResponse object Carrier integration information.
carrier object
View JSON Schema on GitHub

JSON Schema

vtex-metadata1-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetaData1",
  "title": "MetaData1",
  "required": [
    "integrationResponse",
    "carrier"
  ],
  "type": "object",
  "description": "Metadata about the Carrier.",
  "properties": {
    "integrationResponse": {
      "type": "object",
      "description": "Carrier integration information."
    },
    "carrier": {
      "$ref": "#/components/schemas/Carrier"
    }
  },
  "example": {
    "integrationResponse": {},
    "carrier": {
      "name": "[FedEx] Postmen Testing Account",
      "image": null,
      "metaData": {},
      "id": "fedex",
      "type": {
        "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": "FedEx",
        "id": "fedex_first_overnight",
        "international": false
      }
    }
  }
}