Order placement

This request is sent by VTEX to the external seller once the customer finishes their checkout, to let the seller know there is a newly placed order. It does that by calling the Order Placement endpoint, which needs to be implemented by the seller.

The marketplace will send information such as the items contained in the cart, the client’s profile data, the shipping data, and the payment data. With all that, the seller will be able to create the order in their own store.

Request body example

[
      {
        "marketplaceOrderId": "959311095",
        "marketplaceServicesEndpoint": "https://marketplaceservicesendpoint/",
        "marketplacePaymentValue": 11080,
        "items": [
            {
            "id": "2002495",
            "quantity": 1,
            "Seller": "1",
            "commission": 0,
            "freightCommission": 0,
            "price": 9990,
            "bundleItems": [],
            "itemAttachment": {
                "name": null,
                "content": {}
            },
            "attachments": [],
            "priceTags": [],
            "measurementUnit": null,
            "unitMultiplier": 0,
            "isGift": false
            }
        ],
        "clientProfileData": {
            "email": "[email protected]",
            "firstName": "John",
            "lastName": "Smith",
            "documentType": null,
            "document": "3244239851",
            "phone": "399271258",
            "corporateName": null,
            "tradeName": null,
            "corporateDocument": null,
            "stateInscription": null,
            "corporatePhone": null,
            "isCorporate": false,
            "userProfileId": null
        },
        "shippingData": {
            "address": {
            "addressType": "Residencial",
            "receiverName": "John Smith",
            "addressId": "Home",
            "postalCode": "13476103",
            "city": "Americana",
            "state": "SP",
            "country": "BRA",
            "street": "JOÃO DAMÁZIO GOMES",
            "number": "311",
            "neighborhood": "SÃO JOSÉ",
            "complement": null,
            "reference": "Bairro Praia Azul / Posto de Saúde 17",
            "geoCoordinates": []
            },
            "logisticsInfo": [
            {
                "itemIndex": 0,
                "selectedSla": "Regular",
                "lockTTL": "8d",
                "shippingEstimate": "7d",
                "price": 1090,
                "deliveryWindow": null
            }
            ]
        },
        "openTextField": null,
        "marketingData": {
            "utmSource": "buscape",
            "utmMedium": "",
            "utmCampaign": "freeshipping",
            "utmiPage": "_",
            "utmiPart": "BuscaFullText",
            "utmiCampaign": "artscase for iphone 5"
        },
        "paymentData": null
    }
]

Response body fields

The Order Placement response, sent by the seller to the marketplace, should contain the same fields that come in the request, plus two extra fields:

Name Type Mandatory Description
orderId string Yes A string that identifies the order inserted into the Seller.
followUpEmail string Yes Email for sending order updates.

Response body example

[
    {
      "marketplaceOrderId": "959311095",
      "orderId": "123543123",
      "followUpEmail": "[email protected]",
      "items": [
        {
          "id": "2002495",
          "quantity": 1,
          "Seller": "1",
          "commission": 0,
          "freightCommission": 0,
          "price": 9990,
          "bundleItems": [],
          "priceTags": [],
          "measurementUnit": "un",
          "unitMultiplier": 1,
          "isGift": false
        }
      ],
      "clientProfileData": {
        "email": "[email protected]",
        "firstName": "JONAS",
        "lastName": "ALVES DE OLIVEIRA",
        "documentType": "cpf",
        "document": "32133239851",
        "phone": "1592712979",
        "corporateName": null,
        "tradeName": null,
        "corporateDocument": null,
        "stateInscription": null,
        "corporatePhone": null,
        "isCorporate": false,
        "userProfileId": null
      },
      "shippingData": {
        "address": {
          "addressType": "Residencial",
          "receiverName": "JONAS ALVES DE OLIVEIRA",
          "addressId": "Casa",
          "postalCode": "13476103",
          "city": "Americana",
          "state": "SP",
          "country": "BRA",
          "street": "JOÃO DAMÁZIO GOMES",
          "number": "121",
          "neighborhood": "SÃO JOSÉ",
          "complement": null,
          "reference": "Bairro Praia Azul / Posto de Saúde 17",
          "geoCoordinates": []
        },
        "logisticsInfo": [
          {
            "itemIndex": 0,
            "selectedSla": "Normal",
            "lockTTL": "8d",
            "shippingEstimate": "5d",
            "price": 1090,
            "deliveryWindow": null
          }
        ]
      },
      "paymentData": null
    }
]
Language
Authentication
Click Try It! to start a request and see the response here!