Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Marketplace

Authorize dispatch for fulfillment order

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.

For 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.

post/{accountName}.{environment}.com.br/api/fulfillment/pvt/orders/{orderId}/fulfill

Path parameters

accountNamestring required

Name of the VTEX account. Used as part of the URL.

environmentstring required

Environment to be used. It is passed as part of the URL.

orderIdstring required

ID of the order that is to be authorized. It is composed of the afilliateId and the marketplaceOrderId joined with a -. For instance, an order with an ID "123" coming from the marketplace "MKP" has an orderId of "MKP-123".

Query parameters

scstring
Example:1

Sales channel.

affiliateIdstring required
Example:MKP

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.

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

marketplaceOrderIdstring

ID of the order in the marketplace. It is the same as the orderId without the afilliateId at the beginning. For instance, if the orderId is "MKP-123", the marketplaceOrderId is "123".

Response

OK