Fulfillment simulation - External Seller

This endpoint may be called upon by VTEX for fulfillment simulation in the external seller different contexts. See examples below.

When a price or inventory notification request returns a response with status 200 OK, it means that the SKU already exists in the marketplace. Whenever this happens, the marketplace will call the seller to get two updated information about the SKU: Price and Inventory.

The seller needs to have an endpoint implemented in order to receive this call and send a response containing the requested information to the marketplace. We call it the Fulfillment Simulation endpoint.

If the seller wishes to include other parameters in this call (like account name, or sales channel ID), this should be done within their {fulfillmentEndpoint}. This path is then inserted in the marketplace's VTEX admin when configuring a seller.

The marketplace will send an object containing an array of items. The seller must use this list to get the updated information about the referred SKUs and send them back to the marketplace, following the response format explained in the API Reference.

This call is also applied in the Storefront simulation scenario, in which case the request from VTEX does not send the paramenters country and postalCode. The call's payload can be adapted into two scenarios:

• Displaying items in the storefront: the address information can be nulled in the request, since they are not mandatory data for this context.
• Making a shopping cart simulation during checkout: address information must be sent, since this data is needed to calculate freight values. If the address information (including postalCode and country) is not sent through the call, VTEX interprets the stock balance as zero. Without a valid stock balance, the seller will not be shown as an option during checkout.

Request body example - Indexing simulation

{
    "items": [
      {
        "id": "7908010136043",
        "quantity": 1,
        "seller": "1",
      }
    ],
    "isCheckedIn": false,
  }

Request body example - Checkout simulation

{
    "items": [
      {
        "id": "7908010136043",
        "quantity": 1,
        "seller": "1",
      }
    ],
    "postalCode": "22270-030",
    "country": "BRA",
  }