VTEX · Schema

CreateDocumentResponse

Response body object.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
Id string ID of the document that was created, with data entity prefix.
Href string Document reference URL.
DocumentId string ID of the document that was created.
View JSON Schema on GitHub

JSON Schema

vtex-createdocumentresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateDocumentResponse",
  "title": "CreateDocumentResponse",
  "required": [
    "Id",
    "Href",
    "DocumentId"
  ],
  "type": "object",
  "description": "Response body object.",
  "properties": {
    "Id": {
      "type": "string",
      "description": "ID of the document that was created, with data entity prefix."
    },
    "Href": {
      "type": "string",
      "description": "Document reference URL."
    },
    "DocumentId": {
      "type": "string",
      "description": "ID of the document that was created."
    }
  }
}