openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 159 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://vtex.local"},{"description":"","url":"/"}],"x-hasEquivalentPaths":true,"info":{"contact":{},"description":"\r\nThe _Marketplace Protocol_ is a set of API requests and definitions to help you integrate external sellers into a VTEX marketplace as well as external marketplaces into VTEX sellers.\r\n\r\n## External Seller\r\n\r\nHere you will find the endpoints involved in the integration between a VTEX marketplace and an external seller. Note that some of these requests are typically sent by the seller while others are received.\r\n\r\n| **Request** | **From** | **To** |\r\n|-|-|-|\r\n| [Fulfillment simulation](https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) | Marketplace | Seller |\r\n| [Order placement](https://developers.vtex.com/vtex-rest-api/reference/order-placement) | Marketplace | Seller |\r\n| [Authorize fulfillment](https://developers.vtex.com/vtex-rest-api/reference/authorize-fulfillment) | Marketplace | Seller |\r\n| [Marketplace order cancellation](https://developers.vtex.com/vtex-rest-api/reference/marketplace-order-cancellation) | Marketplace | Seller |\r\n| [Send invoice](https://developers.vtex.com/vtex-rest-api/reference/send-invoice) | Seller | Marketplace |\r\n| [Send tracking information](https://developers.vtex.com/vtex-rest-api/reference/send-tracking-information) | Seller | Marketplace |\r\n| [Update tracking status](https://developers.vtex.com/vtex-rest-api/reference/update-tracking-status) | Seller | Marketplace |\r\n| [Cancel order in marketplace](https://developers.vtex.com/vtex-rest-api/reference/cancel-order-in-marketplace) | Seller | Marketplace |\r\n\r\nFor a detailed explanation of the steps required to develop a custom connector to sell products from an external seller in your storefront, check out our complete [External Seller Integration Guide](https://developers.vtex.com/docs/guides/external-seller-integration-guide).\r\n\r\n\r\n## External Marketplace\r\n\r\nIn this section, you will find the endpoints involved in the VTEX integration between an external marketplace and a VTEX seller.\r\n\r\n\r\n| **Request** | **From** | **To** |\r\n|-|-|-|\r\n| [VTEX Mapper Registration](https://developers.vtex.com/vtex-rest-api/reference/vtex-mapper-registration) | External marketplace | VTEX system |\r\n| [Send Category Mapping to VTEX Mapper](https://developers.vtex.com/vtex-rest-api/reference/send-category-mapping-to-vtex-mapper) | External marketplace | VTEX system |\r\n| [Authorize fulfillment](https://developers.vtex.com/vtex-rest-api/reference/authorize-fulfillment) | Marketplace | Seller |\r\n| [Place fulfillment order](https://developers.vtex.com/vtex-rest-api/reference/place-fulfillment-order) | External marketplace | VTEX Seller |\r\n| [Authorize dispatch for fulfillment order](https://developers.vtex.com/vtex-rest-api/reference/authorize-dispatch-for-fulfillment-order) | External marketplace | VTEX Seller |\r\n\r\n\r\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide).","title":"Marketplace Protocol","version":"1.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Marketplace Protocol.json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Marketplace-Protocol"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"External Seller"},{"name":"External Marketplace"}],"paths":{"/api/checkout/pub/orderForms/simulation":{"post":{"deprecated":false,"description":"This endpoint can be triggered by marketplaces to simulate the fulfillment of an item in the cart.\r\n\r\nThe 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.","operationId":"fulfillment-simulation-external-marketplace","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The affiliate ID code created by the seller.","in":"query","name":"affiliateId","required":false,"schema":{"default":"MNF","type":"string"},"style":"form"},{"description":"Trade Policy (Sales Channel) identification.","in":"query","name":"sc","required":false,"schema":{"example":1,"type":"integer"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"clientProfileData":{"description":"Customer's profile information.","properties":{"corporateDocument":{"description":"Corporate document, if the customer is a legal entity.","nullable":true,"type":"string"},"corporateName":{"description":"Company name, if the customer is a legal entity.","nullable":true,"type":"string"},"corporatePhone":{"description":"Corporate phone number, if the customer is a legal entity.","nullable":true,"type":"string"},"customerClass":{"description":"Customer class.","nullable":true,"type":"string"},"document":{"description":"Document informed by the customer.","example":"12345678900","type":"string"},"documentType":{"description":"Type of the document informed by the customer.","example":"cpf","type":"string"},"email":{"description":"Email address.","example":"clark.kent@example.com","type":"string"},"firstName":{"description":"First name.","example":"Clark","type":"string"},"isCorporate":{"description":"Indicates whether the customer is a legal entity.","type":"boolean"},"lastName":{"description":"Last name.","example":"Kent","type":"string"},"phone":{"description":"Phone number.","example":"+552199999999","type":"string"},"profileCompleteOnLoading":{"description":"Indicates whether profile is complete on loading.","type":"boolean"},"profileErrorOnLoading":{"description":"Indicates whether profile presents error on loading.","nullable":true,"type":"boolean"},"stateInscription":{"description":"State inscription, if the customer is a legal entity.","nullable":true,"type":"string"},"tradeName":{"description":"Trade name, if the customer is a legal entity.","nullable":true,"type":"string"}},"type":"object"},"country":{"description":"Three letter ISO code of the country of the shipping address. This value must be sent along with the `postalCode` or `geoCoordinates` values.","example":"BRA","type":"string"},"geoCoordinates":{"default":[-47.924747467041016,-15.832582473754883],"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"example":-47.924747467041016,"type":"number"},"type":"array"},"isCheckedIn":{"default":false,"description":"Indicates whether order is checked in.","type":"boolean"},"items":{"description":"Array containing information about the SKUs inside the cart to be simulated.","items":{"properties":{"id":{"description":"The SKU ID.","example":"1","type":"string"},"quantity":{"description":"The quantity of items of this specific SKU in the cart to be simulated.","example":1,"format":"int32","type":"integer"},"seller":{"description":"The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.","example":"1","type":"string"}},"type":"object"},"type":"array"},"marketingData":{"description":"Object containing promotion data such as coupon tracking information and internal or external UTMs.","properties":{"coupon":{"default":"free-shipping","description":"Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.","type":"string"},"utmCampaign":{"default":"Black friday","description":"UTM campaign","type":"string"},"utmMedium":{"default":"CPC","description":"UTM medium.","type":"string"},"utmSource":{"default":"Facebook","description":"UTM source.","type":"string"},"utmiCampaign":{"default":"utmi_campaign-example","description":"utmi_campaign (internal utm).","type":"string"},"utmiPage":{"default":"utmi_page-example","description":"utmi_page (internal utm).","type":"string"},"utmiPart":{"default":"utmi_part-example","description":"utmi_part (internal utm).","type":"string"}},"type":"object"},"postalCode":{"description":"Postal code.","example":"12345-000","type":"string"},"selectedSla":{"description":"SLA selected by the customer.","example":"Normal","type":"string"},"storeId":{"description":"ID of the store.","nullable":true,"type":"string"}},"required":["id","quantity","seller"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"itemMetadata":{"items":[{"assemblyOptions":[{"composition":null,"id":"T-Shirt Customization","inputValues":{"T-Shirt Name":{"domain":["[]"],"maximumNumberOfCharacters":2}},"name":"T-Shirt Customization","required":false}],"id":"1","seller":"1"}]},"items":[{"availability":"available","id":"1","listPrice":9999,"measurementUnit":"un","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"price":9999,"priceDefinition":{"calculatedSellingPrice":2999700,"sellingPrices":[{"quantity":1,"value":2999700}],"total":2999700},"priceTags":[{"identifier":"1234abc-5678b-1234c","isPercentual":false,"name":"DISCOUNT@MANUALPRICE","rawValue":-50,"value":-5000}],"priceValidUntil":"2025-04-15T13:51:56.040Z","quantity":1,"requestIndex":0,"rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":2999700,"tax":0,"unitMultiplier":300}],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemIndex":0,"quantity":1,"selectedDeliveryChannel":null,"selectedSla":null,"shipsTo":["BRA"],"slas":[{"availableDeliveryWindows":{"endDateUtc":"2025-04-15T13:51:56.040Z","lisPrice":0,"price":0,"startDateUtc":"2025-04-15T13:51:56.040Z","tax":0},"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":{"endDateUtc":"2025-04-15T13:51:56.040Z","listprice":1000,"price":0,"startDateUtc":"2025-04-15T13:51:56.040Z","tax":0},"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"marketingData":{"coupon":null,"marketingTags":["tag1","tag2"],"utmCampaign":"Black friday","utmMedium":"CPC","utmSource":"app","utmiCampaign":"true","utmiPart":"true","utmipage":"true"},"messages":[],"paymentData":{"availableAccounts":[],"availableAssociations":{},"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"creditCardPaymentGroup","paymentName":"Visa","paymentSystem":"2","value":2999700},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"bankInvoicePaymentGroup","paymentName":"Boleto Bancário","paymentSystem":"6","value":2999700},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"MercadoPagoProPaymentGroup","paymentName":"MercadoPagoPro","paymentSystem":"127","value":2999700},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"custom202PaymentGroupPaymentGroup","paymentName":"Dinheiro","paymentSystem":"202","value":2999700}],"paymentSystems":[{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:51:56.041Z","groupName":"custom202PaymentGroupPaymentGroup","id":202,"isCustom":true,"name":"Dinheiro","requiresAuthentication":false,"requiresDocument":false,"stringId":"202","template":"custom202PaymentGroupPaymentGroup-template","validator":null},{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:51:56.041Z","groupName":"bankInvoicePaymentGroup","id":6,"isCustom":false,"name":"Boleto Bancário","requiresAuthentication":false,"requiresDocument":false,"stringId":"6","template":"bankInvoicePaymentGroup-template","validator":null},{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:51:56.041Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":null},{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:51:56.041Z","groupName":"MercadoPagoProPaymentGroup","id":127,"isCustom":false,"name":"MercadoPagoPro","requiresAuthentication":false,"requiresDocument":false,"stringId":"127","template":"MercadoPagoProPaymentGroup-template","validator":null}],"payments":[]},"pickupPoints":[],"postalCode":"12345-000","purchaseConditions":{"itemPurchaseConditions":[{"id":"1","listPrice":9999,"price":9999,"seller":"1","sellerChain":["1"],"slas":[{"availableDeliveryWindows":{"endDateUtc":"2025-04-15T13:51:56.041Z","lisPrice":0,"price":0,"startDateUtc":"2025-04-15T13:51:56.041Z","tax":0},"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":{"endDateUtc":"2025-04-15T13:51:56.041Z","listprice":1000,"price":0,"startDateUtc":"2025-04-15T13:51:56.041Z","tax":0},"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"selectableGifts":[],"subscriptionData":null,"totals":[{"id":"Items","name":"Total dos Itens","value":2999700}]},"schema":{"properties":{"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"items":{"description":"Information on each item in the cart.","items":{"properties":{"availability":{"description":"Availability.","type":"string"},"id":{"description":"ID of the item.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"measurementUnit":{"description":"Measurement unit.","type":"string"},"offerings":{"description":"Array containing offering information.","items":{},"type":"array"},"parentAssemblyBinding":{"description":"Parent assembly binding.","nullable":true,"type":"string"},"parentItemIndex":{"description":"Parent item index.","nullable":true,"type":"integer"},"price":{"description":"Price in cents.","type":"integer"},"priceDefinition":{"description":"Price information for all units of a specific item.","properties":{"calculatedSellingPrice":{"description":"Item's calculated unitary selling price in cents.","type":"integer"},"sellingPrices":{"description":"Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.","items":{"properties":{"quantity":{"description":"Rounding quantity, meaning how many items are rounded to this value.","type":"integer"},"value":{"description":"Value in cents for that specific rounding.","type":"integer"}},"type":"object"},"type":"array"},"total":{"description":"Total value for all units of the item in cents.","type":"integer"}},"type":"object"},"priceTags":{"description":"Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.","items":{"properties":{"identifier":{"description":"Price tag identifier.","type":"string"},"isPercentual":{"description":"Indicates whether price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","type":"string"},"owner":{"description":"Identification of the responsible for the price tag.","type":"string"},"rawValue":{"description":"Price tag raw value.","type":"integer"},"value":{"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"priceValidUntil":{"description":"Price expiration date and time.","type":"string"},"quantity":{"description":"The quantity of the item the cart.","type":"integer"},"requestIndex":{"description":"Request index information.","type":"integer"},"rewardValue":{"description":"Reward value in cents.","type":"integer"},"seller":{"description":"The seller responsible for the SKU.","type":"string"},"sellerChain":{"description":"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.","items":{"description":"Seller.","type":"string"},"type":"array"},"sellingPrice":{"description":"Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.","type":"integer"},"tax":{"description":"Tax value in cents.","type":"integer"},"unitMultiplier":{"description":"Unit multiplier.","type":"integer"}},"type":"object"},"type":"array"},"logisticsInfo":{"description":"Array with logistics information on each item of the `items` array in the `orderForm`.","items":{"properties":{"addressId":{"description":"Address ID.","nullable":true,"type":"string"},"deliveryChannels":{"description":"List of available delivery channels.","items":{"properties":{"id":{"description":"Delivery channel ID.","type":"string"}},"type":"object"},"type":"array"},"itemIndex":{"description":"Index of item in items array.","type":"integer"},"itemMetadata":{"description":"Item metadata.","properties":{"items":{"description":"List of objects containing metadata on each item in the order.","items":{"properties":{"assemblyOptions":{"description":"Assembly options information.","items":{},"properties":{"composition":{"description":"Composition information.","nullable":true,"type":"string"},"id":{"description":"Item ID.","type":"string"},"inputValues":{"description":"Input values information.","type":"object"},"name":{"description":"Item name.","type":"string"},"required":{"description":"Indicates whether the item is required.","type":"boolean"}},"type":"array"},"id":{"description":"Item ID.","type":"string"},"seller":{"description":"Seller.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"messages":{"description":"Array containing an object for each message generated by our servers while processing the request.","items":{},"type":"array"},"pickupPoints":{"description":"Array containing pickup points information.","items":{},"type":"array"},"purchaseConditions":{"description":"Purchase conditions information.","properties":{"itemPurchaseConditions":{"description":"List of objects containing purchase condition information on each item in the order.","items":{"properties":{"id":{"description":"Item ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"price":{"description":"Price in cents.","type":"integer"},"seller":{"description":"Seller.","type":"string"},"sellerChain":{"description":"Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.","items":{},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"availableDeliveryWindows":{"description":"This object contains information about the delivery window available to the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"deliveryWindow":{"description":"In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, \"three business days\" will be represented as `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented as `3bd`.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"quantity":{"description":"Quantity.","type":"integer"},"selectedDeliveryChannel":{"description":"Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.","nullable":true,"type":"string"},"selectedSla":{"description":"Selected SLA. For example, `\"normal\"` or `\"express\"`.","nullable":true,"type":"string"},"shipsTo":{"description":"List of countries that the item may be shipped to.","items":{},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"availableDeliveryWindows":{"description":"This object contains information about the delivery window available to the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"deliveryWindow":{"description":"In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, \"three business days\" will be represented as `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented as `3bd`.","type":"string"}},"type":"object"},"type":"array"},"subscriptionData":{"description":"Subscription information.","nullable":true,"type":"object"},"totals":{"description":"Information on order totals.","items":{"properties":{"id":{"description":"Total ID.","type":"string"},"name":{"description":"Total name.","type":"string"},"value":{"description":"Total value.","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"marketingData":{"description":"Object containing promotion data such as coupon tracking information and internal or external UTMs.","nullable":true,"type":"object"},"paymentData":{"description":"Payment data information.","properties":{"availableAccounts":{"description":"Available accounts.","items":{},"type":"array"},"availableAssociations":{"description":"Available associations.","type":"object"},"availableTokens":{"description":"Available tokens.","items":{},"type":"array"},"giftCardMessages":{"description":"Array of gift card messages.","items":{},"type":"array"},"giftCards":{"description":"Gift card information, if it applies to the order.","items":{},"type":"array"},"installmentOptions":{"description":"Installment options information.","items":{},"properties":{"bin":{"description":"Bin.","nullable":true,"type":"string"},"installments":{"description":"Installments information.","items":{},"properties":{"count":{"description":"Count information.","type":"integer"},"hasInterestRate":{"description":"Indicates whether the payment has interest.","type":"boolean"},"interestRate":{"description":"Interest rate value.","type":"integer"},"sellerMerchantInstallments":{"description":"Seller merchant installments information.","items":{},"type":"array"},"total":{"description":"Total value of the order without separating cents. For example, $24.99 is represented `2499`.","type":"integer"},"value":{"description":"Value of the order without the interest rate. The value is shown without separating cents.","type":"integer"}},"type":"array"},"paymentGroupName":{"description":"Payment group name.","type":"string"},"paymentName":{"description":"Payment name.","type":"string"},"paymentSystem":{"description":"Payment system identification.","type":"integer"},"value":{"description":"Total value assigned to this payment.","type":"integer"}},"type":"array"},"paymentSystems":{"description":"Information on payment systems.","items":{"properties":{"availablePayments":{"description":"Availability of payment.","nullable":true,"type":"string"},"description":{"description":"Description.","type":"string"},"displayDocument":{"description":"Indicates whether a document is shown.","type":"boolean"},"dueDate":{"description":"Payment due date.","type":"string"},"groupName":{"description":"Payment group name.","type":"string"},"id":{"description":"Payment system ID.","type":"integer"},"isCustom":{"description":"Indicates whether it is custom.","type":"boolean"},"name":{"description":"Payment system name.","type":"string"},"requiresAuthentication":{"description":"Indicates whether a authentication is required.","type":"boolean"},"requiresDocument":{"description":"Indicates whether a document is required.","type":"boolean"},"stringId":{"description":"String ID.","type":"string"},"template":{"description":"Template.","type":"string"},"validator":{"description":"Payment system validator.","nullable":true,"type":"object"}},"type":"object"},"type":"array"},"payments":{"description":"Information on each payment.","items":{},"type":"array"}},"type":"object"},"postalCode":{"description":"Postal Code.","nullable":true,"type":"string"},"ratesAndBenefitsData":{"description":"Information on rates and benefits that apply to the order.","properties":{"rateAndBenefitsIdentifiers":{"description":"List with rates and benefits identifiers.","items":{},"type":"array"},"teaser":{"description":"List with rates and benefits teasers.","items":{},"type":"array"}},"type":"object"},"selectableGifts":{"description":"Array containing the data of the item selected as a gift.","items":{},"type":"array"}},"type":"object"}}},"description":"OK","headers":{}}},"summary":"Fulfillment simulation - External Marketplace","tags":["External Marketplace"]}},"/portal.vtexcommercestable.com.br/api/mkp-category-mapper/categories/marketplace/{id}":{"post":{"deprecated":false,"description":"Mapping categories guarantees that the VTEX category tree has a correct association with the marketplace’s category tree. \n\nTo perform this association, VTEX made VTEX Mapper available. It is a tool integrated to the VTEX platform that allows the user to relate categories created in VTEX to categories from the marketplace. \n\nThis endpoint allows connectors to send the marketplace's category tree mapped in the integration. \n\nConnectors should send the payload compacted in .gzip format. \n\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide).","operationId":"send-category-mapping-vtex-mapper","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Code identifying returned in the *VTEX Mapper Registration* endpoint.","in":"path","name":"id","required":true,"schema":{"default":"123456789","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sendCategoryMappingToVtexMapper"}}},"description":"","required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"Send Category Mapping to VTEX Mapper","tags":["External Marketplace"]}},"/portal.vtexcommercestable.com.br/api/mkp-category-mapper/connector/register":{"post":{"deprecated":false,"description":"Mapping categories guarantees that the VTEX category tree has a correct association with the marketplace’s category tree. \n\nTo perform this association, VTEX made VTEX Mapper available. It is a tool integrated to the VTEX platform that allows the user to relate categories created in VTEX to categories from the marketplace. \n\nThis endpoint allows connectors to register the external marketplace integration in VTEX Mapper. \n\nIn case VTEX Mapper detects an error and the call fails, the connector should check if mandatory information was sent correctly. Ex. are URLs correctly registered in the properties categoryTreeEndPoint and mappingEndPoint? \n\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide).","operationId":"vtex-mapper-registration","parameters":[{"description":"Name of the VTEX account. Used as part of the URL.","in":"query","name":"an","required":true,"schema":{"example":"accountName","type":"string"},"style":"form"},{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VtexMapperRegistration"}}},"description":"","required":true},"responses":{"200":{"description":"OK","headers":{}}},"summary":"VTEX Mapper Registration","tags":["External Marketplace"]}},"/{accountName}.vtexcommercestable.com.br/api/order-integration/orders":{"post":{"deprecated":false,"description":"API to integrate an external channel's order into the VTEX plataform.\n\nThis process is asynchronous and a notification with the order's integration results will be sent to the endpoint specified in the **connectorEndpoint** field in [App Template](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-app-template), if the connector uses our App template. The field **connectorName** is also optional for connectors that use our App Template and authenticate using the app's auth cookie. If the account is not informed in the URL host, it should also be defined as a query string parameter in the route: `an={account}`. \n\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide).","operationId":"EnqueueNewOrder","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Parameter should indicate the name of the VTEX account where the order is being integrated or updated, meaning the seller responsible for the order.","explode":true,"in":"query","name":"an","required":false,"schema":{"example":"apiexamples","type":"string"},"style":"form"},{"description":"Parameter should indicate the name of the VTEX account where the order is being integrated or updated, meaning the seller responsible for the order.","in":"path","name":"accountName","required":true,"schema":{"default":"apiexamples","type":"string"}},{"description":"ID identifying the marketplace where the order originates. This ID is configured in the seller's VTEX account, and should be informed to the marketplace.","explode":true,"in":"query","name":"affiliateId","required":true,"schema":{"example":"MKP","type":"string"},"style":"form"}],"requestBody":{"content":{"application/json":{"example":{"allowFranchises":false,"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"document":"99999999999","email":"email@email.com.br","firstName":"John","lastName":"Doe","phone":"99999999999","stateInscription":null,"tradeName":null},"connectorEndpoint":"https://connector-endpoint.com/api/vtex","connectorName":"SkyHub","customData":{"customApps":[{"fields":{"marketplacePaymentMethod":"credit card"},"id":"marketplace-integration","major":1}]},"invoiceData":{"userPaymentInfo":{"paymentMethods":["creditCardPaymentGroup"]}},"items":[{"id":"1","price":975,"quantity":1}],"marketplaceOrderId":"{{$guid}}","marketplaceOrderStatus":"NEW","marketplacePaymentValue":3025,"pickupAccountName":"","shippingData":{"isFob":true,"isMarketplaceFulfillment":true,"logisticsInfo":[{"deliveryIds":{"warehouseId":"AR1"},"lockTTL":"1d","price":2050,"selectedDeliveryChannel":"delivery","selectedSla":"Express","shippingEstimate":"2d"}],"selectedAddresses":[{"addressId":"1","addressType":"Residential","city":"Curitiba","complement":"101","country":"BRA","geoCoordinates":{"latitude":"-29.5","longitude":"-45.8"},"neighborhood":"Portão","number":"4125","postalCode":"81020-235","receiverName":"John Doe","state":"PR","street":"Rua Eduardo Carlos Pereira"}]}},"schema":{"$ref":"#/components/schemas/EnqueueNewOrderRequest"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"accountName":"grocery1","code":"SOI003","errors":null,"fields":null,"flow":"PlaceOrder","marketplaceOrderId":null,"message":"Order successfully enqueued","operationId":null,"success":true},"schema":{"$ref":"#/components/schemas/Deliverybyseller"}}},"description":"OK","headers":{}},"default":{"content":{"application/json":{"example":{"accountName":"grocery1","code":"SOI003","errors":null,"fields":null,"flow":"PlaceOrder","marketplaceOrderId":null,"message":"Order successfully enqueued","operationId":null,"success":true},"schema":{"$ref":"#/components/schemas/Deliverybyfranchiseseller"}}},"description":"","headers":{}}},"summary":"New Order Integration","tags":["External Marketplace"]}},"/{accountName}.vtexcommercestable.com.br/api/order-integration/orders/status":{"put":{"deprecated":false,"description":"API request used to update an order status in VTEX.\n\nThis process is asynchronous and a notification with the order's integration results will be sent to the endpoint specified in the **connectiorEndpoint** field or the **connectiorEndpoint** [App Template](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-app-template), if the connector uses our App template. The field **connectorName** is also optional for connectors that use our App Template and authenticate using the app's auth cookie. \n\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide).","operationId":"UpdateOrderStatus","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Parameter should indicate the name of the VTEX account where the order is being integrated or updated, meaning the seller responsible for the order.","explode":true,"in":"query","name":"an","required":false,"schema":{"example":"apiexamples","type":"string"},"style":"form"},{"description":"Parameter should indicate the name of the VTEX account where the order is being integrated or updated, meaning the seller responsible for the order.","in":"path","name":"accountName","required":true,"schema":{"default":"apiexamples","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"connectorEndpoint":"https://connector-endpoint.com/api/vtex","connectorName":"Skyhub","marketplaceOrderId":"{{$guid}}","marketplaceOrderStatus":"APPROVED"},"schema":{"$ref":"#/components/schemas/UpdateOrderStatusRequest"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"accountName":null,"code":"SOI003","errors":null,"fields":null,"flow":"ApproveOrder","marketplaceOrderId":"7e62fcd3-827b-400d-be8a-f050a79c4976","message":"Order successfully enqueued","operationId":null,"success":true},"schema":{"$ref":"#/components/schemas/Approveorder"}}},"description":"OK","headers":{}}},"summary":"Update Order Status","tags":["External Marketplace"]}},"/{accountName}.{environment}.com.br/api/fulfillment/pvt/orders":{"post":{"deprecated":false,"description":"Creates fulfillment order, meaning that it is an order for the seller's side in a sale made through a marketplace. This order assumes the transaction itself has already happened on the marketplace's side and, therfore, cares only about the fulfillment side.\n\r\n\r> If you plan to integrate external orders with possible [Price divergence](https://help.vtex.com/en/tutorial/price-divergence-rule--6RlFLhD1rIRRshl83KnCjW#) be mindful of the `isCreatedAsync` request body field. \n\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide).","operationId":"PlaceFulfillmentOrder","parameters":[{"description":"Name of the VTEX account. Used as part of the URL.","in":"path","name":"accountName","required":true,"schema":{"default":"apiexamples","type":"string"}},{"description":"Environment to be used. It is passed as part of the URL.","in":"path","name":"environment","required":true,"schema":{"default":"vtexcommercestable","type":"string"}},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Sales channel.","in":"query","name":"sc","required":false,"schema":{"example":"1","type":"string"},"style":"form"},{"description":"ID identifying the marketplace where the order originates. This ID is configured in the seller's VTEX account, and should be informed to the marketplace.","in":"query","name":"affiliateId","required":true,"schema":{"example":"MKP","type":"string"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"clientProfileData":{"description":"Customer's profile information.","properties":{"corporateDocument":{"description":"Corporate document, if the customer is a legal entity.","example":"12345678000100","nullable":true,"type":"string"},"corporateName":{"description":"Company name, if the customer is a legal entity.","example":"company-name","nullable":true,"type":"string"},"corporatePhone":{"description":"Corporate phone number, if the customer is a legal entity.","example":"+551100988887777","nullable":true,"type":"string"},"document":{"description":"Document informed by the customer. Validation depends on the country.","example":"123456789","type":"string"},"documentType":{"description":"Type of the document informed by the customer.","example":"cpf","type":"string"},"email":{"description":"Customer's email address.","example":"customer@examplemail.com","type":"string"},"firstName":{"description":"Customer's first name.","example":"first-name","type":"string"},"isCorporate":{"description":"`true` if the customer is a legal entity.","example":false,"nullable":true,"type":"boolean"},"lastName":{"description":"Customer's last name.","example":"last-name","type":"string"},"phone":{"description":"Customer's phone number.","example":"+55110988887777","type":"string"},"stateInscription":{"description":"State inscription, if the customer is a legal entity.","example":"12345678","nullable":true,"type":"string"},"tradeName":{"description":"Trade name, if the customer is a legal entity.","example":"trade-name","nullable":true,"type":"string"}},"required":["email","firstName","lastName","documentType","document"],"type":"object"},"isCreatedAsync":{"description":"Indicates whether an order is created. It must be `true` if an order is being placed with [Price divergence](https://help.vtex.com/en/tutorial/price-divergence-rule--6RlFLhD1rIRRshl83KnCjW#), otherwise the request will not work.","example":false,"type":"boolean"},"items":{"description":"Array of objects containing information on each of the order's items.","items":{"example":{"id":"123456789","quantity":1,"seller":"1"},"properties":{"attachments":{"description":"Array containing information on attachments.","items":{"type":"string"},"type":"array"},"bundleItems":{"description":"Information on services sold along with the SKU. Example: a gift package.","items":{"properties":{"id":{"description":"Service identifier.","example":1034,"type":"integer"},"name":{"description":"Service name.","example":"name-example","type":"string"},"price":{"description":"Service price. The last two digits are the cents.","example":199,"type":"integer"},"type":{"description":"Service type.","example":"type-example","type":"string"}},"type":"object"},"type":"array"},"commission":{"description":"Comission.","example":10,"type":"integer"},"freightCommission":{"description":"Freight comission","example":10,"type":"integer"},"id":{"description":"The SKU ID.","example":"123","type":"string"},"isGift":{"default":false,"description":"Indicates whether the order is a gift.","type":"boolean"},"itemAttachment":{"description":"Item attachment.","properties":{"content":{"description":"Content referring to the customization requested by the customer.","example":"content-example","type":"string"},"name":{"description":"Attachment name.","example":"name-example","type":"string"}},"type":"object"},"measurementUnit":{"description":"SKU measurement unit.","example":"g","type":"string"},"price":{"description":"Item price within the context of the order without separating cents. For example, $24.99 is represented `2499`.","example":2499,"type":"integer"},"priceTags":{"description":"Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.","items":{"properties":{"identifier":{"description":"Price tag identifier.","example":"1234abc-5678b-1234c","type":"string"},"isPercentual":{"default":false,"description":"`true` if price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","example":"discount@name-1234abc-5678b-1234c","type":"string"},"rawValue":{"description":"Price tag value.","example":-12,"type":"integer"},"value":{"description":"Price tag raw value.","example":-1200,"type":"integer"}},"type":"object"},"type":"array"},"quantity":{"description":"The quantity of items of this specific SKU in the cart to be simulated.","example":1,"format":"int32","type":"integer"},"seller":{"description":"The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.","example":"1","type":"string"},"unitMultiplier":{"description":"SKU unit multiplier.","example":1,"t