requestOrderId

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/requestOrderId",
  "title": "requestOrderId",
  "description": "Details related to a request for an order ID, which is used to trigger the fulfillment process of the corresponding order.",
  "required": [
    "marketplaceOrderId",
    "marketplaceOrderGroup",
    "cancellationRequestDate",
    "cancellationRequestId",
    "reason",
    "requestedByUser"
  ],
  "type": "object",
  "properties": {
    "marketplaceOrderId": {
      "type": "string",
      "description": "Identifies the order. The seller should use this ID to trigger the fulfillment process of the corresponding order.",
      "example": "1138342255777-01"
    },
    "marketplaceOrderGroup": {
      "type": "string",
      "description": "Identifies the group to which the order belongs. Useful for orders placed on marketplaces that operate with the [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) structure.",
      "example": "group-123"
    },
    "cancellationRequestId": {
      "type": "string",
      "description": "Unique identifier of the cancellation request on the platform.",
      "example": "85838ab408514b52aa139e4236ce0c43"
    },
    "cancellationRequestDate": {
      "type": "string",
      "description": "Date and time the platform processed the cancellation request, in this format: `YYYY-MM-DDThh:mm:ss.SSSSSSS+00:00`.",
      "example": "2024-03-04T15:45:02.1306363+00:00"
    },
    "reason": {
      "type": "string",
      "description": "Brief explanation of why the order is being canceled.",
      "example": "Incorrect product"
    },
    "requestedByUser": {
      "type": "boolean",
      "description": "When set as `true`, the cancellation was requested by the shopper, and when set as `false`, the cancellation was not requested by the shopper.",
      "example": true
    }
  }
}