VTEX · Schema

Data3

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
status	string	Service status.
agent	object	Service agent.
trackingUrl	string	Service tracking URL.
totalDistanceTraveled	integer	Delivery total distance traveled in kilometers.
rating	integer	Rating.
shippingPrice	integer	Shipping price.
shippingEstimatedDate	string	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`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Data3",
  "title": "Data3",
  "required": [
    "status",
    "agent",
    "trackingUrl",
    "totalDistanceTraveled",
    "rating",
    "shippingPrice",
    "shippingEstimatedDate"
  ],
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Service status."
    },
    "agent": {
      "$ref": "#/components/schemas/Agent",
      "description": "Service agent."
    },
    "trackingUrl": {
      "type": "string",
      "description": "Service tracking URL."
    },
    "totalDistanceTraveled": {
      "type": "integer",
      "format": "int32",
      "description": "Delivery total distance traveled in kilometers."
    },
    "rating": {
      "type": "integer",
      "format": "int32",
      "description": "Rating."
    },
    "shippingPrice": {
      "type": "integer",
      "format": "int32",
      "description": "Shipping price."
    },
    "shippingEstimatedDate": {
      "type": "string",
      "description": "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`."
    }
  },
  "example": {
    "status": "PENDING",
    "agent": {
      "id": "27327489234",
      "name": "Pedro",
      "identification": "020323809",
      "phone": "+57314855674",
      "email": "[email protected]",
      "vehicle": "SCOOTER"
    },
    "trackingUrl": "https://localhost.com",
    "totalDistanceTraveled": 2,
    "rating": 5,
    "shippingPrice": 150000,
    "shippingEstimatedDate": "2024-04-27T20:25:45.067Z"
  }
}