VTEX · Schema

NotifyCarrierwithAppRequest

Object containing email, account, and dispatched order information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
account object
email string Fill in this field if you wish to send the generated file for an email besides the ones already involved in the operation, like the carrier and VTEX account's email.
dispatchOrder object
View JSON Schema on GitHub

JSON Schema

vtex-notifycarrierwithapprequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NotifyCarrierwithAppRequest",
  "title": "NotifyCarrierwithAppRequest",
  "description": "Object containing email, account, and dispatched order information.",
  "required": [
    "email",
    "dispatchOrder",
    "account"
  ],
  "type": "object",
  "properties": {
    "account": {
      "$ref": "#/components/schemas/Account"
    },
    "email": {
      "type": "string",
      "description": "Fill in this field if you wish to send the generated file for an email besides the ones already involved in the operation, like the carrier and VTEX account's email.",
      "example": "email"
    },
    "dispatchOrder": {
      "$ref": "#/components/schemas/DispatchOrder"
    }
  }
}