VTEX · Schema

Receipt

Information about the receipt for changed orders.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
date string Date when the receipt was created.
orderId string ID of the order.
receipt string Receipt's unique identifier code.
View JSON Schema on GitHub

JSON Schema

vtex-receipt-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Receipt",
  "title": "Receipt",
  "description": "Information about the receipt for changed orders.",
  "required": [
    "date",
    "orderId",
    "receipt"
  ],
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "description": "Date when the receipt was created."
    },
    "orderId": {
      "type": "string",
      "description": "ID of the order."
    },
    "receipt": {
      "type": "string",
      "description": "Receipt's unique identifier code."
    }
  },
  "example": {
    "date": "2019-02-06T20:46:04.4003606+00:00",
    "orderId": "v5195004lux-01",
    "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
  }
}