VTEX · Schema

Carrier

Object containing information about a carrier.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
name	string	Carrier name.
image	string	Carrier logo.
metaData	object	Carrier metadata.
id	string	Carrier ID.
type	object	Carrier type.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Carrier",
  "title": "Carrier",
  "required": [
    "name",
    "image",
    "metaData",
    "id",
    "type"
  ],
  "type": "object",
  "description": "Object containing information about a carrier.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Carrier name."
    },
    "image": {
      "type": "string",
      "nullable": true,
      "description": "Carrier logo."
    },
    "metaData": {
      "type": "object",
      "description": "Carrier metadata."
    },
    "id": {
      "type": "string",
      "description": "Carrier ID."
    },
    "type": {
      "$ref": "#/components/schemas/Type",
      "description": "Carrier type."
    }
  },
  "example": {
    "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
    }
  }
}