vtex.local – Marketplace-APIs

Tools (25)

Extracted live via the executor SDK.

• matchedOffers.getofferslist

  Offers are seller's products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.

  This endpoint retrieves the available offers in a marketplace. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace, and are currently in its catalog.

  It is possible to filter the search through the following parameters:

  • rows

  • sort

  • start

  • fq

• matchedOffers.getProductoffers

  Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.

  This endpoint retrieves the available offers for a speciic Product ID in the marketplace's catalog. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog.

  The call returns a list of offers for that ID, that contain the following data:

  • Seller that sells the SKU

  • Correspondent SKU ID

  • SKU's price value

  • Inventory level

  • Sales channel (or trade policy) that it is available at.

• matchedOffers.getSkUoffers

  Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.

  This endpoint retrieves the available offers for a speciic SKU ID in the marketplace's catalog. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog.

  The call returns a list of offers for that ID, that contain the following data:

  • Seller that sells the SKU

  • Correspondent SKU ID

  • SKU's price value

  • Inventory level

  • Sales channel (or trade policy) that it is available at.

• notification.inventoryNotification

  This endpoint is used by sellers to notify marketplaces that the inventory level has changed for one of their SKUs.

  There is no request body in this call, indicating the new inventory level, for instance. It only notifies a specific marketplace (accountName) that a seller (sellerId) has changed the inventory level of an SKU (skuId).

  Marketplaces will then call the fulfillment endpoint provided in the seller registration form to get the updated inventory information.

• notification.priceNotification

  This endpoint is used by sellers to notify marketplaces that the price has changed for one of their SKUs.

  There is no request body in this call, indicating the new price value, for instance. It only notifies a specific marketplace (accountName) that a seller (sellerId) has changed the price of an SKU (skuId).

  Marketplaces will then call the fulfillment endpoint provided in the seller registration form to get the updated price information.

• salesChannelMapping.retrieveMapping

  Retrieves information about the mapping between marketplace's sales channels and a specific seller.

• salesChannelMapping.upsertMapping

  This endpoint allows the marketplace to map its sales channels with a seller's affiliate. The seller can have multiple sales channels associated with the same marketplace, by creating different affiliates. The mapping enables the seller to segment catalog, prices, inventory, logistics, and payments in the marketplace.

• sellerCommissions.bulkUpsertSellerCommissions

  This endpoint is used by marketplace operators to define comissions for multiple categories.

• sellerCommissions.listSellerCommissions

  This endpoint retrieves all comissions configured for a specific seller.

• sellerCommissions.removeSellerCommissions

  This endpoint removes a seller comission on the selected category.

• sellerCommissions.retrieveSellerCommissions

  This endpoint retrieves seller comissions applied to the selected category.

• sellerCommissions.upsertSellerCommissions

  This endpoint is used by marketplace operators to define comissions for a single category, by ID.

• sellerInvite.acceptSellerLead

  This endpoint is triggered by the seller onboarding wizard, once the seller confirms their invitation. It can be used by marketplace operators to manually accept seller leads, and carry on with their onboarding process.

  Note that there's no specific API call that allows status changes. The operations only allow the seller lead to move forward:

  From invite > to Accept > closing on Create Seller.

  If you want to change the status, you can start the process again, by deleting that lead through the Delete Seller Lead endpoint, and resending the invite through the Resend Seller Lead's Invite endpoint.

• sellerInvite.createSellerFromSellerLead

  This endpoint is used by marketplace operators to create seller accounts. The request will only accept Seller Leads whose status is accepted. If they are already connected or invited, the call will not be fulfilled.

  The creation of the account at VTEX is done by an internal Billing service. There is no seller account and marketplace affiliation if you do not go through this step.

  Note that there's no specific API call that allows status changes. The operations only allow the seller lead to move forward:

  From invite > to Accept > closing on Create Seller.

  If you want to change the status, you can start the process again, by deleting that lead through the Delete Seller Lead endpoint, and resending the invite through the Resend Seller Lead's Invite endpoint.

• sellerInvite.createSellerLead

  This API is used by marketplace operators to invite sellers to join their marketplace. The request sends an email to the seller, inviting sellers to activate their store. The invitation's link in the email is unique per user, and available for only seven days for the seller to click and begin activating their store.

  The email template is completely customizable. All email templates that VTEX sends to seller leads can be found and edited in the marketplace's VTEX Admin, on the Message Center section.

• sellerInvite.listSellerLeads

  This call's response includes a list of all sellers invited by the marketplace operator to join them. Retrieved results can be filtered by adding optional query fields to the request. Each seller listed includes the following information:

  • id

  • createdAt

  • status

  • isConnected

  • sellerEmail

  • sellerName

  • salesChannel

  • email

• sellerInvite.removeSellerLead

  This endpoint permanently deletes a seller previously invited to the marketplace, if the seller has not already accepted the invitation.

• sellerInvite.resendSellerLeadRequest

  This endpoint allows marketplace operators to resend an invitation to a seller lead, previously invited to join their marketplace. The request will only accept Seller Leads whose status is invited. If they are already connected or accepted, the call will not be fulfilled.

• sellerInvite.retrieveSellerLead

  Marketplace operators may call this endpoint to retrieve information about a specific seller invited to the Seller Portal, by searching through their Seller Lead Id. To know the chosen seller's sellerLeadId, marketplace operators can count on the List Sellers endpoint's response as well. Each seller listed includes the following information:

  • id

  • createdAt

  • status

  • isConnected

  • sellerEmail

  • sellerName

  • salesChannel

  • email

• sellers.getListSellers

  This endpoint lists all Sellers. This call's results can be filtered by trade policies through the sc query param.

• sellers.getRetrieveSeller

  Marketplace operator may call this endpoint to retrieve information about a specific seller by filtering by ID. It is also possible to filter results by sales channel (or trade policy) through the sc query param.

• sellers.updateSeller

  This endpoint allows marketplace operators to update the information of sellers connected to their account. You can replace a path's value with another value in order to update that single information. There is no need to fill all the body params available, only the one you wish to update.

• sellers.upsertSellerRequest

  This endpoint is used by marketplace operators to configure the accounts of sellers that have already accepted the invitation to join their marketplaces.

  For marketplaces to add sellers without the Seller Invite feature, call this endpoint directly.

  This call includes all the information a seller needs to activate their account.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools