[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides deprecated how to collect orders from sales channels in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/updates/release-notes)

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/updates/release-notes)

\[Deprecated\] How to collect orders from sales channels

> We have released a new method for integrating orders from external marketplaces, as a part of our Marketplace Protocol. If you used this previous method for integrating orders, you can still find their documentation in [Order Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/deprecated-order-logs) and [How to collect orders from sales channels](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/deprecated-how-to-collect-orders-from-sales-channels). These previous methods, however, will not be maintained. If you are integrating orders for the first time, we recommend you use the instructions in our [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-collect-orders) guide.

Orders in an integration fit into two different categories:

**Paid orders:** the marketplace only makes orders available for the integration once they are paid by the customer.

![{"base64":"  ","img":{"width":5262,"height":1509,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":183264,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-0.jpg"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-0.jpg)

**Orders to be paid:** the marketplace makes orders that have not been paid by the customer available for the integration.

![{"base64":"  ","img":{"width":5262,"height":1325,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":167947,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-1.jpg"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-1.jpg)

Right after the payment confirmation by the marketplace, the flow goes as the image below describes it:

![{"base64":"  ","img":{"width":5262,"height":1481,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":167558,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-2.jpg"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-2.jpg)

## How orders reach the connector

A marketplace order can reach the connector by either a:

1. **Notification sent by the marketplace:** when the marketplace informs the connector about the existence of an order, and the connector, after receiving the notification, goes to the marketplace to get order details.

![{"base64":"  ","img":{"width":5262,"height":1476,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":168930,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-3.jpg"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-3.jpg)

1. **Polling request made by the connector:** when the connector checks the marketplace from time to time, to collect new orders.
![{"base64":"  ","img":{"width":5262,"height":1136,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":140182,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-4.jpg"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-4.jpg)

## Integrating orders

Follow the steps below, to integrate orders from external marketplaces:

1. Collect order details from the endpoint provided by the marketplace.
2. Create a request on the [Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders) endpoint.
3. [Simulate fulfillment](#fulfillment-simulation), to check if the SKU is available in VTEX.
4. For each SKU retrieved, the connector must call the [Get SKU and Context endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-context) and:
a. Validate if the SKU is active through the `isActive` property.
b. Validate if the SKU is associated to the sales channel used in the integration through the `salesChannel` property.
5. In case step 4 retrieves all SKUs that compose the order with their respective inventory levels and prices, the connector should insert the order through the [Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/order-placement) endpoint.
* In the `marketplaceServicesEndpoint` field, the endpoint will be used by VTEX to inform the connector of the changes in order status, inserting tracking code and invoice. For more information check out [Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-invoice-tracking).
1. In case step 5 returns success and creates the order within the VTEX platform, authorize the dispatch by the seller through the [Authorize dispatch for fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders/-orderId-/fulfill) endpoint.
2. Check the [Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-recommendations) page to follow integration best practices.
3. Check out the [Order logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs) page to create appropriate error messages.

If all validations pass, the order is sent to VTEX and the operation is logged according to information described in the [Order logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs).

After VTEX OMS returns `success`, if the IDs between VTEX and the marketplace differ, the connector should store the mapping of the order (VTEX ID and Marketplace ID). This information will be used for [order status update operations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status%23api-reference-update-order-status).

> Be mindful to make all validations at once. In case there's an error detected, the connector presents the seller a list of actions to correct. This way we can avoid the correct - publish - correct cycle. If orders do not apply to the steps above, an [error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs) must be filed.

## API Reference

Use the endpoints described below to perform this step. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token. The diagram illustrates the endpoints used in the integration:

![{"base64":"  ","img":{"width":5262,"height":3389,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":460342,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-5.jpg"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/deprecated-how-to-collect-orders-from-sales-channels-5.jpg)

> All parameters in the endpoints below must be declared in the request. In case one of the parameters does not have a value, you must still send it as `null`.

### Fulfillment simulation

Use the curl example below to perform the fulfillment Simulation.

`1

curl --location --request POST 'https://{{accountName}}.vtexcommercestable.com.br/api/checkout/pub/orderForms/simulation?affiliateId={{affiliateId}}={{salesChannelId}}' \

2

--header 'Accept: application/vnd.vtex.checkout.debug.v1+json' \

3

--header 'Content-Type: application/json' \

4

--data-raw '{

5

 "items": [

6

 {

7

 "id": "13",

8

 "quantity": 1,

9

 "seller": "1"

10

 }

11

 ],

12

 "marketingData": null,

13

 "postalCode": "04321-100",

14

 "country": "BRA",

15

 "selectedSla": null,

16

 "clientProfileData": null,

17

 "geoCoordinates": [],

18

 "isCheckedIn": false,

19

 "storeId": null

20

}'

`

### Shopping cart simulation

Use the request example below to perform the Shopping Cart Simulation. Check out our [Shopping cart Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/cartsimulation) API Reference to know more details.

`1

{

2

"items":[

3

{...}

4

]

5

"ratesAndBenefitsData":{

6

"rateAndBenefitsIdentifiers":[]

7

"teaser":[]

8

}

9

"paymentData":{

10

"installmentOptions":[...]

11

"paymentSystems":[...]

12

"payments":[]

13

"giftCards":[]

14

"giftCardMessages":[]

15

"availableAccounts":[]

16

"availableTokens":[]

17

}

18

"selectableGifts":[]

19

"marketingData":NULL

20

"postalCode":NULL

21

"country":"BRA"

22

"logisticsInfo":[

23

{...}

24

]

25

"messages":[]

26

"purchaseConditions":{

27

"itemPurchaseConditions":[...]

28

}

29

"pickupPoints":[]

30

"subscriptionData":NULL

31

"totals":[

32

{...}

33

]

34

"itemMetadata":NULL

35

}

`

### Place fulfillment order

Use the request example below to place fulfillment order. Check out our [Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders) API Reference to know more details.

`1

[

2

 {

3

 "items": [

4

 {

5

 "id": "1",

6

 "price": 900,

7

 "quantity": 1,

8

 "seller": "1"

9

 }

10

 ],

11

 "isCreatedAsync": true,

12

 "marketplaceOrderGroup" : "794901324",

13

 "marketplaceOrderId": "2630580124",

14

 "marketplacePaymentValue": 1100,

15

 "marketplacePaymentReferenceValue": 1100,

16

 "marketplaceServicesEndpoint": "http://skyhubintegration.vtexinternal.com/api/skyhubintegration/commercialcondition?an=grocery1",

17

 "clientProfileData": {

18

 "CorporateDocument": null, //Cnpj

19

 "CorporateName": null, //nome da empresa

20

 "CorporatePhone": null, // ddd+telefone

21

 "Document": "14310315771", //cpf

22

 "DocumentType": null, //se pessoa fisica, colocar CPF, senão CNPJ

23

 "Email": "conta@dominio.com.br",

24

 "FirstName": "Nome",

25

 "IsCorporate": false, //caso pessoa juridica o valor deve ser true

26

 "LastName": "Sobrenome",

27

 "Phone": "41998718616",

28

 "StateInscription": null, //inscrição estadual

29

 "TradeName": null,

30

 "UserProfileId": null //utilizado somente com pedidos VTEX

31

 },

32

 "shippingData": {

33

 "address": {

34

 "addressId": "Casa",

35

 "addressType": "Residencial",

36

 "receiverName": "Marcelo",

37

 "city": "Curitiba",

38

 "complement": null,

39

 "country": "BRA",

40

 "geoCoordinates": [],

41

 "neighborhood": "Novo Mundo",

42

 "number": "4000",

43

 "postalCode": "81020230",

44

 "reference": null,

45

 "state": "PR",

46

 "street": "Rua Eduardo Carlos Pereira"

47

 },

48

 "logisticsInfo": [

49

 {

50

 "itemIndex": 0,

51

 "price": 200,

52

 "selectedDeliveryChannel":"delivery",

53

 "selectedSla": null,

54

 "lockTTL": "1d", //tempo para reserva do estoque do pedido

55

 "shippingEstimate":"1d" //tempo de entrega do pedido

56

 }

57

 ],

58

 "selectedAddresses":[

59

 {

60

 "addressType": "Residencial",

61

 "receiverName": "Henrique Vianna",

62

 "addressId": "2",

63

 "postalCode": "81020-235",

64

 "city": "Curitiba",

65

 "state": "PR",

66

 "country": "BRA",

67

 "street": "Rua Eduardo Carlos Pereira",

68

 "number": "4125",

69

 "neighborhood": "Portão",

70

 "complement": "",

71

 "reference": null,

72

 "geoCoordinates": [

73

 -49.2892059,

74

 -25.4826319

75

 ]

76

 }],

77

 "isFob": false //se entrega feita pelo lojista coloque false, senão true

78

 },

79

 "customData": {

80

 "customApps": [{

81

 "fields": {

82

 "orderIdMarketplace": "2630580148",

83

 "paymentIdMarketplace": "8191598627"

84

 },

85

 "id": "marketplace-integration",

86

 "major": 1

87

 }]

88

 },

89

 "openTextField": {

90

 "value": "{\"Phones\":[\"21998718616\"]}"

91

 }

92

 }

93

]

`

### Authorize dispatch

Use the request example below to authorize dispatch. Check out our [Authorize Dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders/-orderId-/fulfill)API Reference to know more details.

`1

[

2

 {

3

 "marketplaceOrderId": "956"

4

 }

5

]

`

## Scenario 1: orders with price divergence in items between marketplace and VTEX

When to perform: after attempting to integrate an order in VTEX platform, the process returns an error `FMT007` \- signaling price divergence.

Connectors should:

1. In case the call is successful (200 OK), signaling the creation of prive divergence rule, the order should be queued in VTEX.
2. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing price divergence rules, file an error log, following the error code x.
3. In case the call returns an unauthorized request (500), signaling that the price divergence rule failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.

## Scenario 2: inventory level divergence

When to perform: after attempting to integrate an order in VTEX platform, the process returns an error `ORDER027` \- signaling inventory error.

Connectors should:

1. Generate an error log, according to the item x.
2. Validate if the order status in the marketplace was altered to `canceled`. If so, generate the error log message x, and remove the order from the retry queue.
3. If the order was not canceled, submit the order to be reprocessed.
4. In case the call is successful (200 OK), signaling the creation of the order, connectors should log the operation according to x.
5. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing stock rules, file an error log, following the error code x.
6. In case the call returns an server error (500), signaling that the order creation failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.

## Scenario 3: SLA errors - no carriers to deliver the order

When to perform: after attempting to integrate an order in VTEX platform, the process returns an error `ORDER027` \- signaling that there are no carriers to attend that order.

Connectors should:

1. Generate an error log, according to the item x.
2. Validate if the order status in the marketplace was altered to `canceled`. If so, generate the error log message x, and remove the order from the retry queue.
3. If the order was not canceled, submit the order to be reprocessed.
4. In case the call is successful (200 OK), signaling the creation of the order, connectors should log the operation according to x.
5. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing carriers’ rules, file an[ error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs), following the error code x.
6. In case the call returns a server error (500), signaling that the order creation failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.

## Scenario 4: SLA errors - no pickup points to attend the order

When to perform: after attempting to integrate an order in VTEX platform, the process returns an error `ORDER027` \- signaling that there are no pickup points for the end customer to retrieve their order.

Connectors should:

1. Generate an error log, according to the item x.
2. Validate if the order status in the marketplace was altered to `canceled`. If so, generate the error log message x, and remove the order from the retry queue.
3. If the order was not canceled, submit the order to be reprocessed.
4. In case the call is successful (200 OK), signaling the creation of the order, connectors should log the operation according to x.
5. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing pickup points’ rules, file an [error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs), following the error code x.
6. In case the call returns an unauthorized request (500), signaling that the order creation failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.

## Scenario 5: order is canceled by the marketplace

When to perform: when the order is canceled by the marketplace.

Connectors should:

1. Verify if the order exists in the VTEX platform, by either: a. Checking the order ID relation between VTEX and the marketplace in their environment. b. Checking if the order exists through the [Get Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorder) endpoint.
2. Validate the order status.
3. If the order exists in VTEX, call the [Cancel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint.
4. If the order exists in VTEX, and the order status is `invoiced`, call the [Order Invoice notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice) endpoint.
5. In case the call is successful (200 OK), signaling the cancelling of the order, connectors should log the operation according to x.
6. In case the call returns a bad request (400), signaling that the order could not be canceled, file an [error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs), following the error code x.
7. In case the call returns an unauthorized request (500), signaling that the order cancelling failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.

> Make sure that all steps are logged as either success or failure, to offer the operation’s full traceability. Check out the [Order logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs) page to learn more.

Contributors

4

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/deprecated-how-to-collect-orders-from-sales-channels.md)

Contributors

4

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[How orders reach the connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23how-orders-reach-the-connector)

[Integrating orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23integrating-orders)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23api-reference)

[Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23fulfillment-simulation)[Shopping cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23shopping-cart-simulation)[Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23place-fulfillment-order)[Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23authorize-dispatch)

[Scenario 1: orders with price divergence in items between marketplace and VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-1-orders-with-price-divergence-in-items-between-marketplace-and-vtex)

[Scenario 2: inventory level divergence](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-2-inventory-level-divergence)

[Scenario 3: SLA errors - no carriers to deliver the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-3-sla-errors-no-carriers-to-deliver-the-order)

[Scenario 4: SLA errors - no pickup points to attend the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-4-sla-errors-no-pickup-points-to-attend-the-order)

[Scenario 5: order is canceled by the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-5-order-is-canceled-by-the-marketplace)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/deprecated-how-to-collect-orders-from-sales-channels.md)

Copy page

On this page

ON THIS PAGE

[How orders reach the connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23how-orders-reach-the-connector)

[Integrating orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23integrating-orders)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23api-reference)

[Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23fulfillment-simulation)[Shopping cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23shopping-cart-simulation)[Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23place-fulfillment-order)[Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23authorize-dispatch)

[Scenario 1: orders with price divergence in items between marketplace and VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-1-orders-with-price-divergence-in-items-between-marketplace-and-vtex)

[Scenario 2: inventory level divergence](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-2-inventory-level-divergence)

[Scenario 3: SLA errors - no carriers to deliver the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-3-sla-errors-no-carriers-to-deliver-the-order)

[Scenario 4: SLA errors - no pickup points to attend the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-4-sla-errors-no-pickup-points-to-attend-the-order)

[Scenario 5: order is canceled by the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-5-order-is-canceled-by-the-marketplace)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides actions orders in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/master-data)

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/actions-orders)

[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/get-marketplace-data-orders-api)

[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/get-payment-data-mercado-libre-orders-api)

[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/formatting-order-invoicing-time)

[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/using-orders-management-filters-in-api)

[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/adding-a-second-address-to-the-order)

Subscriptions

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/master-data)

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/actions-orders)

[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/get-marketplace-data-orders-api)

[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/get-payment-data-mercado-libre-orders-api)

[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/formatting-order-invoicing-time)

[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/using-orders-management-filters-in-api)

[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/adding-a-second-address-to-the-order)

Subscriptions

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides)

Orders

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/actions-orders)

Actions in orders

> Check the new [Orders onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.

This section contains articles about actions that can be performed in orders.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/actions-orders.md)

[Cancel order« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders//docs/guides/order-canceling-improvements)[Fetching marketplace information with the Orders APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders//docs/guides/get-marketplace-data-orders-api)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/actions-orders.md)

Copy page

On this page

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides external seller integration vtex marketplace setup in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-guide)

[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-architecture)

[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup)

[External seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-processing-payments)

[External seller connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-connector)

[Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-operation)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-guide)

[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-architecture)

[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup)

[External seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-processing-payments)

[External seller connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-connector)

[Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-operation)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides)

Integration Guides

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-guide)

[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup)

Store setup for VTEX Marketplace

For a VTEX store to act as a marketplace and sell products from external sellers, it has to do the following for each external seller:

* [Register the seller in the marketplace Admin](#register-the-seller-in-the-marketplace-admin)
* [Activate the seller for a trade policy](#activate-the-seller-for-a-trade-policy)
* [Set up API authentication credentials](#set-up-api-authentication-credentials)

This article explains what must be done to complete each of these configuration steps.

---

## Register the seller in the marketplace Admin

An external seller can only integrate into a VTEX store if it is registered there. The responsibility for creating this seller registration lies with the marketplace.

You can call the [Configure Seller Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/seller-register/pvt/sellers) to add the external seller through API.

The article [Configuring a seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-the-seller--tutorials%5F392) shows the path to create the seller in the Admin and explains the form fields.

> The **Fulfillment Endpoint** field should be filled in with the endpoint that will be implemented for the seller to receive the Fulfillment Simulation requests from the marketplace. This implementation is explained in the next section of this guide.

![{"base64":"  ","img":{"width":3733,"height":2150,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":204205,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/external-seller-integration-vtex-marketplace-setup-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/external-seller-integration-vtex-marketplace-setup-0.png)

> The `seller ID`, created during this step, will be essential for the integration. Most of the API requests explained in the next section of this guide will use it to identify the seller.

## Activate the seller for a trade policy

Trade policies are used in VTEX to group catalog, pricing, promotions, inventory, shipping, and payment settings for different sales channels. In a VTEX marketplace, each trade policy may apply to a different set of sellers. So, after creating a new seller, the marketplace needs to activate this seller for the trade policies that make sense for the business.

To do this, in the marketplace management panel's main menu, click on the option **Trade Policies**, then choose the trade policy you want to edit by clicking on the button **Alter** next to it. Next, select the sellers you want to activate. In the example of the image below, the trade policy "Marketplace" is only enabled for the seller "Store 1".

![{"base64":"  ","img":{"width":1772,"height":735,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":41275,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/external-seller-integration-vtex-marketplace-setup-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/external-seller-integration-vtex-marketplace-setup-1.png)

Check out the Help Center documentation to get the complete explanation on how to [enable the seller for a trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-the-seller--tutorials%5F392%23editing-the-trade-policy).

## Set up API authentication credentials

Every private API request to the VTEX system requires authentication through a pair of appKey and appToken. So you will need to create these credentials before you can start building the integration.

Read the [Authentication guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication%23section-creating-the-appkey-and-apptoken) to learn how to create and use the appKey and appToken.

Once the authentication credentials are created, keep the appKey / appToken pair stored in a safe place until you can securely share it with the external seller.

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-seller-integration-guide/external-seller-integration-vtex-marketplace-setup.md)

[Marketplace / Seller architecture« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup//docs/guides/external-seller-integration-architecture)[External seller processing paymentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup//docs/guides/external-seller-processing-payments)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[Register the seller in the marketplace Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23register-the-seller-in-the-marketplace-admin)

[Activate the seller for a trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23activate-the-seller-for-a-trade-policy)

[Set up API authentication credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23set-up-api-authentication-credentials)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-seller-integration-guide/external-seller-integration-vtex-marketplace-setup.md)

Copy page

On this page

ON THIS PAGE

[Register the seller in the marketplace Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23register-the-seller-in-the-marketplace-admin)

[Activate the seller for a trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23activate-the-seller-for-a-trade-policy)

[Set up API authentication credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23set-up-api-authentication-credentials)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)