Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Marketplace

Fulfillment simulation - External Marketplace

This endpoint can be triggered by marketplaces to simulate the fulfillment of an item in the cart.

The fulfillment information is useful whenever you need to know the availability of fulfilling an order for a specific cart setting, since the API response will let you know the updated price, inventory and shipping data.

post/api/checkout/pub/orderForms/simulation

Query parameters

affiliateIdstring

The affiliate ID code created by the seller.

scinteger
Example:1

Trade Policy (Sales Channel) identification.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

countrystring

Three letter ISO code of the country of the shipping address. This value must be sent along with the postalCode or geoCoordinates values.

geoCoordinatesnumber[]

Array containing two floats with geocoordinates, first longitude, then latitude.

isCheckedInboolean

Indicates whether order is checked in.

postalCodestring

Postal code.

selectedSlastring

SLA selected by the customer.

storeIdstring nullable

ID of the store.

Example request

{
  "clientProfileData": {
    "document": "12345678900",
    "documentType": "cpf",
    "email": "clark.kent@example.com",
    "firstName": "Clark",
    "lastName": "Kent",
    "phone": "+552199999999"
  },
  "country": "BRA",
  "geoCoordinates": [
    -47.924747467041016
  ],
  "items": [
    {
      "id": "1",
      "quantity": 1,
      "seller": "1"
    }
  ],
  "postalCode": "12345-000",
  "selectedSla": "Normal"
}

Response

OK

countrystring

Three letter ISO code of the country of the shipping address.

marketingDataobject nullable

Object containing promotion data such as coupon tracking information and internal or external UTMs.

postalCodestring nullable

Postal Code.

All 15 operations