VTEX · Schema

HookConfiguration

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
Domain string
OrderId string
State string
LastState string
LastChange string
CurrentChange string
Origin object
View JSON Schema on GitHub

JSON Schema

vtex-hookconfiguration-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HookConfiguration",
  "title": "HookConfiguration",
  "required": [
    "Domain",
    "OrderId",
    "State",
    "LastState",
    "LastChange",
    "CurrentChange",
    "Origin"
  ],
  "type": "object",
  "properties": {
    "Domain": {
      "type": "string"
    },
    "OrderId": {
      "type": "string"
    },
    "State": {
      "type": "string"
    },
    "LastState": {
      "type": "string"
    },
    "LastChange": {
      "type": "string"
    },
    "CurrentChange": {
      "type": "string"
    },
    "Origin": {
      "$ref": "#/components/schemas/Origin2"
    }
  },
  "example": {
    "Domain": "Fulfillment",
    "OrderId": "v52277740atmc-01",
    "State": "ready-for-handling",
    "LastState": "window-to-cancel",
    "LastChange": "2019-08-14T17:11:39.2550122Z",
    "CurrentChange": "2019-08-14T17:12:48.0965893Z",
    "Origin": {
      "Account": "automacaoqa",
      "Key": "vtexappkey-appvtex"
    }
  }
}