Deliverybyseller

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Deliverybyseller",
  "title": "Deliverybyseller",
  "required": [
    "marketplaceOrderId",
    "accountName",
    "code",
    "flow",
    "success",
    "operationId",
    "errors",
    "fields",
    "message"
  ],
  "type": "object",
  "properties": {
    "marketplaceOrderId": {
      "type": "string",
      "nullable": true,
      "description": "String that indicates the order's ID in the marketplace.",
      "example": "7e62fcd3-827b-400d-be8a-f050a79c4976"
    },
    "accountName": {
      "type": "string",
      "description": "String that indicates which account made the request.",
      "example": "accountName"
    },
    "code": {
      "type": "string",
      "description": "String with a internal Channel Order API code that classifies the response. The possible values returned in this field are described in the [Response Codes]() section.",
      "example": "SOI001"
    },
    "flow": {
      "type": "string",
      "description": "String containing the name of the flow responsible for the response. This field can contain the following values: \n\n`PlaceOrder`: when integrating new orders \n\n`ApproveOrder`: when approving existing orders \n\n`Unknown`: when we\u2019re not able to identify the flow",
      "example": "ApproveOrder"
    },
    "success": {
      "type": "boolean",
      "description": "Boolean that indicates if the response is successful or not.",
      "example": true
    },
    "operationId": {
      "type": "string",
      "nullable": true,
      "description": "String GUID that identifies the operation in our service. This field can be used to help us analyze unexpected errors or behaviors.",
      "example": "1234567"
    },
    "errors": {
      "type": "array",
      "nullable": true,
      "description": "List with errors related to the response, if there's any.",
      "items": {
        "type": "object",
        "title": "errors",
        "required": [
          "source",
          "code",
          "description"
        ],
        "properties": {
          "source": {
            "type": "string",
            "title": "Checkout",
            "description": "Includes the following fields pointing out the context of the error: \n\n`Fulfillment` \n\n`Checkout` \n\n`Order Integration`",
            "example": "Fulfillment"
          },
          "code": {
            "type": "string",
            "title": "code",
            "description": "String containing the code returned by the source. Example value: If the source is `Fulfillment`, the code can be FMT005 to indicate that the item(s) in the order are not available.",
            "example": "FMT005"
          },
          "description": {
            "type": "string",
            "title": "description",
            "description": "String containing the error message/description returned by the source.",
            "example": "Message describing the error."
          }
        },
        "example": {
          "source": "Fulfillment",
          "code": "FMT005",
          "description": "Message describing the error."
        }
      }
    },
    "fields": {
      "type": "object",
      "nullable": true,
      "description": "Structure with important fields for the connector. This structure is only returned if the response is successful. Includes the following fields: \n\n`mainOrderId`: String with the order's ID inside the main seller account in VTEX. \n\n`franchiseOrderId`: - String with the order's ID inside the franchise seller account in VTEX. Only returned if the order was integrated using the [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) feature, that is: \n\n- `allowFranchises` field set to `true` when integrating the order \n\n- `SLA` chosen for the order is from a franchise account.",
      "properties": {
        "fields": {
          "type": "object",
          "title": "fields",
          "required": [
            "mainOrderId"
          ],
          "properties": {
            "mainOrderId": {
              "type": "string",
              "title": "mainOrderId",
              "description": "String with the order\u2019s ID inside the main seller account in VTEX.",
              "example": "MKP-123456789"
            },
            "franchiseOrderId": {
              "type": "string",
              "title": "franchiseOrderId",
              "description": "String with the order's ID inside the franchise seller account in VTEX. Only returned if the order was integrated using the [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) feature, that is: \n\n- `allowFranchises` field set to `true` when integrating the order \r\n- SLA chosen for the order is from a franchise account",
              "example": "432874921387409182347"
            }
          },
          "example": {
            "mainOrderId": "MKP-123456789",
            "franchiseOrderId": "432874921387409182347"
          }
        }
      },
      "example": {
        "franchiseOrderId": "38475934875"
      }
    },
    "message": {
      "type": "string",
      "description": "String with a message explaining the code returned in the response. ",
      "example": "The order was integrated into VTEX successfully"
    }
  },
  "example": {
    "marketplaceOrderId": null,
    "accountName": "grocery1",
    "code": "SOI003",
    "flow": "PlaceOrder",
    "success": true,
    "operationId": null,
    "errors": null,
    "fields": null,
    "message": "Order successfully enqueued"
  }
}