VTEX · Schema

UpdateserviceRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
status string Delivery status.
agent string Delivery agent.
trackingUrl string Delivery tracking URL.
totalDistanceTraveled string Delivery total distance traveled in kilometers.
rating string Rating.
shippingPrice string Delivery shipping price in cents.
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

vtex-updateservicerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateserviceRequest",
  "title": "UpdateserviceRequest",
  "required": [
    "status",
    "agent",
    "trackingUrl",
    "totalDistanceTraveled",
    "rating",
    "shippingPrice",
    "shippingEstimatedDate"
  ],
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Delivery status."
    },
    "agent": {
      "type": "string",
      "nullable": true,
      "description": "Delivery agent."
    },
    "trackingUrl": {
      "type": "string",
      "description": "Delivery tracking URL."
    },
    "totalDistanceTraveled": {
      "type": "string",
      "nullable": true,
      "description": "Delivery total distance traveled in kilometers."
    },
    "rating": {
      "type": "string",
      "nullable": true,
      "description": "Rating."
    },
    "shippingPrice": {
      "type": "string",
      "nullable": true,
      "description": "Delivery shipping price in cents."
    },
    "shippingEstimatedDate": {
      "type": "string",
      "nullable": true,
      "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": "DELIVERED",
    "agent": null,
    "trackingUrl": "https://localhost.com",
    "totalDistanceTraveled": null,
    "rating": null,
    "shippingPrice": null,
    "shippingEstimatedDate": "2024-01-05T11:11:11.000Z"
  }
}