GetChangeDetail

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetChangeDetail",
  "title": "GetChangeDetail",
  "required": [
    "requestId",
    "workflowId",
    "status",
    "inProgress",
    "reason",
    "manualDiscountValue",
    "manualIncrementValue",
    "totalChangeValue",
    "totals",
    "add",
    "remove",
    "replace",
    "date",
    "origin",
    "settings"
  ],
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "Unique code that identifies a change order request.",
      "example": "e8532a32-7f7e-434a-88ec-29609f0ede46"
    },
    "workflowId": {
      "type": "string",
      "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).",
      "example": "74f40e7a-68c6-4699-b874-a8a297fb3f6a"
    },
    "status": {
      "type": "string",
      "description": "Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).",
      "example": "handling"
    },
    "inProgress": {
      "type": "boolean",
      "description": "When set as `true`, the order is still progressing in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196), when set as `false`, it is complete, whether by cancellation or because the shopper received it.",
      "example": true
    },
    "reason": {
      "type": "string",
      "description": "Reason that motivated the order change.",
      "example": "The client wants to change the items weight."
    },
    "manualDiscountValue": {
      "type": "integer",
      "description": "This field shows if a manual price was applied to the total order amount. The value is in cents.",
      "example": 0
    },
    "manualIncrementValue": {
      "type": "integer",
      "description": "This field shows if an increment value was applied to the total order amount. The value is in cents.",
      "example": 0
    },
    "totalChangeValue": {
      "type": "integer",
      "description": "This field shows how much is the order total price considering that price changes might have been made. The value is in cents.",
      "example": 0
    },
    "totals": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array containing information about change prices per item.",
      "example": null
    },
    "add": {
      "type": "array",
      "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.",
      "example": null,
      "items": {
        "type": "string"
      }
    },
    "remove": {
      "type": "array",
      "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.",
      "example": null,
      "items": {
        "type": "string"
      }
    },
    "replace": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Replace1"
      },
      "description": "Array with information about the `replace` operation, when applicable."
    },
    "date": {
      "type": "string",
      "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.",
      "example": "2023-07-27T17:52:18.6483116Z"
    },
    "origin": {
      "$ref": "#/components/schemas/OriginV2"
    },
    "settings": {
      "$ref": "#/components/schemas/Settings"
    }
  }
}