VTEX · Schema

DispatchOrder

Information about the dispatched order.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string ID of the dispatched order.
packageIds array Array with package IDs.
sender object
carrier object
View JSON Schema on GitHub

JSON Schema

vtex-dispatchorder-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DispatchOrder",
  "title": "DispatchOrder",
  "description": "Information about the dispatched order.",
  "required": [
    "id",
    "packageIds",
    "sender",
    "carrier"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the dispatched order.",
      "example": "653560c2-7965-4614-a730-8e45c89bf284"
    },
    "packageIds": {
      "type": "array",
      "description": "Array with package IDs.",
      "items": {
        "type": "string",
        "description": "Identification codes of the packages.",
        "example": "6529cd28-6fd1-4b95-8397-5fad0a79d41c"
      }
    },
    "sender": {
      "$ref": "#/components/schemas/Sender"
    },
    "carrier": {
      "$ref": "#/components/schemas/Carrier"
    }
  }
}