VTEX · Example Payload

Vtex Notifycarrierwithapp Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Notifycarrierwithapp Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "NotifyCarrierwithApp",
  "method": "POST",
  "path": "/{app_name}/v{app_version}/{account}/{workspace}/notify",
  "summary": "VTex Notify carrier with app",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "account": {
          "name": "Ltda",
          "accountName": "{{account}}",
          "isOperating": true,
          "defaultUrl": null,
          "district": null,
          "country": "Brasil",
          "complement": null,
          "companyName": "LTDA",
          "cnpj": "00000000000000",
          "city": null,
          "address": null,
          "number": null,
          "postalCode": null,
          "state": null,
          "telephone": null,
          "tradingName": "tradingName"
        },
        "email": "email",
        "dispatchOrder": {
          "id": "653560c2-7965-4614-a730-8e45c89bf284",
          "packageIds": [
            "6529cd28-6fd1-4b95-8397-5fad0a79d41c"
          ],
          "sender": {
            "cnpj": "00000000000000",
            "fantasyName": null,
            "stateRegistration": null,
            "id": null,
            "name": "LTDA",
            "address": {
              "postalCode": "03475015",
              "country": {
                "code": "BRA",
                "name": "Brasil"
              },
              "subregion1": {
                "code": "SP",
                "name": "S\u00e3o Paulo"
              },
              "subregion2": {
                "code": "S\u00e3o Paulo",
                "name": "S\u00e3o Paulo"
              },
              "subregion3": {
                "code": "Vila Antonieta",
                "name": "Vila Antonieta"
              },
              "street": "Rua Exemplo",
              "number": "01",
              "complement": "",
              "location": null
            },
            "email": null,
            "phone": "999999999"
          },
          "carrier": {
            "cnpj": "00000000000000",
            "fantasyName": "carrier",
            "stateRegistration": "096/3624636",
            "id": "vtexlog_exemplo",
            "name": "Carrier LTDA.",
            "address": {
              "postalCode": "90200001",
              "country": {
                "code": "BRA",
                "name": "Brasil"
              },
              "subregion1": {
                "code": "RS",
                "name": "Rio Grande do Sul"
              },
              "subregion2": {
                "code": "Porto_Alegre",
                "name": "Porto Alegre"
              },
              "subregion3": {
                "code": "Anchieta",
                "name": "Anchieta"
              },
              "street": "Rua Exemplo",
              "number": "01",
              "complement": "Pavilh\u00e3o 6",
              "location": null
            },
            "email": "email",
            "phone": "+5511111111111"
          }
        }
      }
    }
  ],
  "responseExamples": []
}