# marketapi documentation

> marketapi is a B2B API that puts many marketplaces (Mercado Livre, Magalu, Amazon, TikTok Shop, Shopee) behind one API. Your company (the account) integrates once; each of your sellers connects their marketplace accounts through a hosted page.

- Every page in Markdown, in one file: https://marketapi.shop/llms-full.txt?lang=en
- Every field of every endpoint (OpenAPI 3): https://api.marketapi.shop/openapi.json
- Esta documentação em português: https://marketapi.shop/llms.txt?lang=pt

## Guide

- [Overview](https://marketapi.shop/docs): What marketapi does, the phases of an integration and what each part of the API covers.
- [Getting started](https://marketapi.shop/docs/getting-started): From API key to your first seller.
- How it works
  - [How it works](https://marketapi.shop/docs/how-it-works): The whole journey, from the first seller to the delivered order, and what each part does.
  - [Set up and connect](https://marketapi.shop/docs/how-it-works/setup-and-connect): Account, API key, webhooks, the seller and their marketplace account.
  - [Catalog and stock](https://marketapi.shop/docs/how-it-works/catalog-and-stock): Products, variants, kits, media, warehouses and who owns the balance.
  - [Publish listings](https://marketapi.shop/docs/how-it-works/publishing): From the catalog to the published listing, or from the existing listing to the catalog.
  - [Stay in sync](https://marketapi.shop/docs/how-it-works/staying-in-sync): Stock that goes out on its own, changes that come back from the marketplace and how to settle differences.
  - [Sell: the order lifecycle](https://marketapi.shop/docs/how-it-works/order-lifecycle): From the incoming order to the delivered package, with stock, NF-e, shipping, returns and disputes.
  - [Serve buyers](https://marketapi.shop/docs/how-it-works/customer-service): Questions before the purchase, messages after it, reviews and account health.
  - [Grow and track](https://marketapi.shop/docs/how-it-works/commerce): Promotions, price, fees, Ads, metrics and finance.
  - [Capabilities](https://marketapi.shop/docs/how-it-works/capabilities): How to know what each Connection can do, and what happens when it cannot.
- Data model
  - [Data model](https://marketapi.shop/docs/data-model): Every resource in the API, how they connect and the rules that apply to all of them.
  - [Catalog and inventory](https://marketapi.shop/docs/data-model/catalog-and-inventory): Product, Variant, kit and how each Variant's balance is computed.
  - [Connections and listings](https://marketapi.shop/docs/data-model/connections-and-listings): Connection, Listing, variant binding and where each published field comes from.
  - [States and events](https://marketapi.shop/docs/data-model/states-and-events): The lifecycle of each resource, what changes each state and the webhook for each change.
- [Authentication](https://marketapi.shop/docs/authentication): API key in the Authorization header.
- [Connecting a seller](https://marketapi.shop/docs/connecting-a-seller): From a created seller to a connected marketplace account, and how you find out.
- BYOK (your own app)
  - [BYOK (your own app)](https://marketapi.shop/docs/own-apps): Bring Your Own Key. The seller authorizes your business's app, not marketapi's.
  - [Mercado Livre](https://marketapi.shop/docs/own-apps/mercadolivre): Step by step to create the app in the DevCenter and use it in marketapi.
- [Marketplace support](https://marketapi.shop/docs/marketplace-support): What every integration offers today and what is still planned.
- [Receiving webhooks](https://marketapi.shop/docs/receiving-webhooks): Signed events, how to verify the signature, retries and deduplication.
- [Tracking jobs](https://marketapi.shop/docs/tracking-jobs): Background operations — track them with GET or through the webhook (job.completed, job.partially_completed, job.failed).
- [Idempotency and limits](https://marketapi.shop/docs/idempotency-and-limits): Retry POSTs safely and handle the rate limit.
- [Billing](https://marketapi.shop/docs/billing): One plan in dollars, up to 5 sellers free, what counts toward the bill and what happens without a payment in good standing.
- [Errors](https://marketapi.shop/docs/errors): One format, with a stable code for your code to handle.

## API

- Sellers
  - [Overview](https://marketapi.shop/docs/sellers/overview): What a seller is and the rules that apply to all of its endpoints.
  - [Metadata](https://marketapi.shop/docs/sellers/metadata): Store your own data on a seller (plan, region, CRM id, tags) and filter the list by it.
  - [Create a seller](https://marketapi.shop/docs/sellers/create) `POST /v1/sellers`: Registers a merchant in your account.
  - [List sellers](https://marketapi.shop/docs/sellers/list) `GET /v1/sellers`: Lists the sellers of your account, one page at a time.
  - [Get a seller](https://marketapi.shop/docs/sellers/get) `GET /v1/sellers/{id}`: Reads a seller by id.
  - [Update a seller](https://marketapi.shop/docs/sellers/update) `PATCH /v1/sellers/{id}`: Changes the name or the externalId of a seller.
  - [Delete a seller](https://marketapi.shop/docs/sellers/delete) `DELETE /v1/sellers/{id}`: Removes a seller from your account, for good.
- Link sessions
  - [Overview](https://marketapi.shop/docs/link-sessions/overview): What a link session is and the rules that apply to all of its endpoints.
  - [Create a link session](https://marketapi.shop/docs/link-sessions/create) `POST /v1/sellers/{id}/link-sessions`: Generates the links for the seller to connect marketplaces, through our page or a button in your app.
  - [Get a link session](https://marketapi.shop/docs/link-sessions/get) `GET /v1/link-sessions/{id}`: Reads the state of a link session and the connections made through it.
  - [Revoke](https://marketapi.shop/docs/link-sessions/revoke) `DELETE /v1/link-sessions/{id}`: Cancels a pending link session.
- Connections
  - [Overview](https://marketapi.shop/docs/connections/overview): A connected marketplace account and the control point for its operations.
  - [List connections](https://marketapi.shop/docs/connections/list) `GET /v1/connections`: Lists the connections of a seller, one page at a time.
  - [Get a connection](https://marketapi.shop/docs/connections/get) `GET /v1/connections/{id}`: Reads a connection by id.
  - [Listing import policy](https://marketapi.shop/docs/connections/listing-import-policy) `GET /v1/connections/{id}/listing-import-policy`: Gets how this Connection links imported listings.
  - [Update listing import policy](https://marketapi.shop/docs/connections/update-listing-import-policy) `PATCH /v1/connections/{id}/listing-import-policy`: Sets the linking policy for future imports of this Connection.
  - [Import listings](https://marketapi.shop/docs/connections/import-listings) `POST /v1/connections/{id}/listing-imports`: Queues a complete read of a Connection's external offers.
  - [Reconcile listings](https://marketapi.shop/docs/connections/reconcile-listings) `POST /v1/connections/{id}/listing-reconciliations`: Queues a new external read to check observed state.
  - [Import orders](https://marketapi.shop/docs/connections/import-orders) `POST /v1/connections/{id}/order-imports`: Brings in the marketplace orders of a period.
  - [Reconcile orders](https://marketapi.shop/docs/connections/reconcile-orders) `POST /v1/connections/{id}/order-reconciliations`: Brings in the orders that changed on the marketplace since the last pass.
  - [Get order policy](https://marketapi.shop/docs/connections/order-policy) `GET /v1/connections/{id}/order-policy` (coming soon): Shows how the Connection's orders move stock.
  - [Update order policy](https://marketapi.shop/docs/connections/update-order-policy) `PATCH /v1/connections/{id}/order-policy` (coming soon): Turns the order policy on or off, or changes its warehouse.
  - [Synchronization state](https://marketapi.shop/docs/connections/sync-state) `GET /v1/connections/{id}/sync-state`: Shows how each Connection resource is kept current.
  - [Connection capabilities](https://marketapi.shop/docs/connections/capabilities) `GET /v1/connections/{id}/capabilities`: Tells, operation by operation, what this Connection can do at its marketplace.
  - [List categories](https://marketapi.shop/docs/connections/listing-categories) `GET /v1/connections/{id}/listing-categories`: Browses the marketplace category tree.
  - [Listing requirements](https://marketapi.shop/docs/connections/listing-requirements) `GET /v1/connections/{id}/listing-requirements`: Lists the fields a category or product type requires.
  - [List brands](https://marketapi.shop/docs/connections/brands) `GET /v1/connections/{id}/brands`: Lists the brands the marketplace accepts.
  - [List product types](https://marketapi.shop/docs/connections/product-types) `GET /v1/connections/{id}/product-types`: Lists the marketplace product types.
  - [Size chart requirements](https://marketapi.shop/docs/connections/size-chart-requirements) `GET /v1/connections/{id}/size-chart-requirements`: Tells whether a category asks for a size chart.
  - [Get fulfillment options](https://marketapi.shop/docs/connections/fulfillment-options) `GET /v1/connections/{id}/fulfillment-options`: Shows the delivery modes the marketplace account has.
  - [Search catalog products](https://marketapi.shop/docs/connections/catalog-products) `GET /v1/connections/{id}/catalog-products`: Searches products in the marketplace catalog.
  - [Get catalog product](https://marketapi.shop/docs/connections/get-catalog-product) `GET /v1/connections/{id}/catalog-products/{catalogProductId}`: Gets one product from the marketplace catalog.
  - [List stock locations](https://marketapi.shop/docs/connections/stock-locations) `GET /v1/connections/{id}/stock-locations` (coming soon): Lists the account's stock locations in the marketplace.
  - [Get fulfillment mapping](https://marketapi.shop/docs/connections/fulfillment-mapping) `GET /v1/connections/{id}/fulfillment-mapping` (coming soon): Shows which warehouse feeds each external location.
  - [Update fulfillment mapping](https://marketapi.shop/docs/connections/update-fulfillment-mapping) `PATCH /v1/connections/{id}/fulfillment-mapping` (coming soon): Replaces the warehouses that feed the external locations.
  - [Get account health](https://marketapi.shop/docs/connections/health) `GET /v1/connections/{id}/health` (coming soon): Shows the account's reputation in the marketplace.
  - [List native operations](https://marketapi.shop/docs/connections/list-operations) `GET /v1/connections/{id}/operations` (coming soon): Lists the marketplace's own operations for the Connection.
  - [Get native operation](https://marketapi.shop/docs/connections/get-operation) `GET /v1/connections/{id}/operations/{operationKey}` (coming soon): Describes an operation, effect, target and input and output format.
  - [Run native operation](https://marketapi.shop/docs/connections/run-operation) `POST /v1/connections/{id}/operations/{operationKey}` (coming soon): Runs a marketplace's own operation, as a Job.
  - [Get marketplace options](https://marketapi.shop/docs/connections/marketplace-options) `GET /v1/connections/{id}/marketplace-options` (coming soon): Shows the marketplace's own options on the Connection.
  - [Update marketplace options](https://marketapi.shop/docs/connections/update-marketplace-options) `PATCH /v1/connections/{id}/marketplace-options` (coming soon): Changes the marketplace's own options on the Connection.
  - [Disconnect](https://marketapi.shop/docs/connections/disconnect) `DELETE /v1/connections/{id}`: Revokes a connection and deletes the credential on our side.
- Products
  - [Products and variants](https://marketapi.shop/docs/products/overview): Reusable base records, sellable variants, and kits.
  - [Create product](https://marketapi.shop/docs/products/create) `POST /v1/sellers/{sellerId}/products`: Creates the base record and its standard variant.
  - [List products](https://marketapi.shop/docs/products/list) `GET /v1/products`: Lists the account's reusable base catalog.
  - [Get product](https://marketapi.shop/docs/products/get) `GET /v1/products/{productId}`: Gets a reusable base record by id.
  - [Update product](https://marketapi.shop/docs/products/update) `PATCH /v1/products/{productId}`: Updates local reusable base data.
  - [Archive product](https://marketapi.shop/docs/products/archive) `DELETE /v1/products/{productId}`: Archives, without deleting, the reusable base record.
  - [List variants](https://marketapi.shop/docs/products/list-variants) `GET /v1/products/{productId}/variants`: Lists a product's sellable combinations.
  - [Get variant](https://marketapi.shop/docs/products/get-variant) `GET /v1/products/{productId}/variants/{variantId}`: Gets one product Variant by id.
  - [Create variant](https://marketapi.shop/docs/products/create-variant) `POST /v1/products/{productId}/variants`: Creates a sellable combination, such as color and storage.
  - [Update variant](https://marketapi.shop/docs/products/update-variant) `PATCH /v1/products/{productId}/variants/{variantId}`: Updates local data for a sellable unit.
  - [Archive variant](https://marketapi.shop/docs/products/archive-variant) `DELETE /v1/products/{productId}/variants/{variantId}`: Archives a sellable unit without deleting its history.
  - [List kit components](https://marketapi.shop/docs/products/list-components) `GET /v1/products/{productId}/components`: Gets the complete product BOM.
  - [Replace kit components](https://marketapi.shop/docs/products/replace-components) `PUT /v1/products/{productId}/components`: Atomically replaces a product's BOM.
  - [Get product media](https://marketapi.shop/docs/products/get-media) `GET /v1/products/{productId}/media` (coming soon): Returns the media of the Product and of each Variant.
  - [Replace product media](https://marketapi.shop/docs/products/replace-media) `PUT /v1/products/{productId}/media` (coming soon): Replaces the media of the Product and its Variants at once.
  - [Propagate changes](https://marketapi.shop/docs/products/propagate) `POST /v1/products/{productId}/propagations` (coming soon): Takes a change from the Product to the listings that use it.
- Assets and media
  - [Overview](https://marketapi.shop/docs/assets/overview): How the API stores pictures, videos and documents.
  - [Create upload](https://marketapi.shop/docs/assets/create-upload) `POST /v1/sellers/{sellerId}/assets/uploads`: Creates the asset and returns the signed URL to upload the file.
  - [Complete upload](https://marketapi.shop/docs/assets/complete-upload) `POST /v1/assets/uploads/{uploadId}/complete`: Checks the uploaded file and makes the asset ready.
  - [Ingest from URL](https://marketapi.shop/docs/assets/ingest) `POST /v1/assets/ingestions` (coming soon): Downloads a file from a public URL and creates the Asset.
  - [Copy media](https://marketapi.shop/docs/assets/copy-media) `POST /v1/sellers/{sellerId}/media-copies`: Copies ready assets of the account to another seller.
  - [Get asset](https://marketapi.shop/docs/assets/get) `GET /v1/assets/{assetId}`: Returns the asset, with a signed URL if it is ready media.
  - [Delete asset](https://marketapi.shop/docs/assets/delete) `DELETE /v1/assets/{assetId}`: Removes the asset and its file.
  - [Read content](https://marketapi.shop/docs/assets/content) `GET /v1/assets/{assetId}/content`: Relays the asset bytes through the API.
- Inventory
  - [Variant inventory](https://marketapi.shop/docs/inventory/overview): Auditable ledger, balance per warehouse and selective quantity publication.
  - [Get variant balance](https://marketapi.shop/docs/inventory/balance) `GET /v1/variants/{variantId}/inventory`: Gets on-hand, reserved, and available inventory for a Variant, in total and per warehouse.
  - [Record inventory movement](https://marketapi.shop/docs/inventory/create-movement) `POST /v1/sellers/{sellerId}/inventory-movements`: Writes an immutable movement in a warehouse, or a transfer between two, and can publish selected quantity.
  - [Republish inventory](https://marketapi.shop/docs/inventory/publish) `POST /v1/sellers/{sellerId}/inventory-publications`: Queues current quantity publication without a movement.
  - [List inventory movements](https://marketapi.shop/docs/inventory/list-movements) `GET /v1/inventory-movements`: Gets a seller's immutable inventory ledger.
  - [List stock discrepancies](https://marketapi.shop/docs/inventory/list-discrepancies) `GET /v1/inventory-discrepancies` (coming soon): Lists where the published stock and the marketplace stock do not match.
  - [Resolve discrepancy](https://marketapi.shop/docs/inventory/resolve-discrepancy) `POST /v1/inventory-discrepancies/{id}/resolve` (coming soon): Closes a stock discrepancy with one of three actions.
- Warehouses
  - [Overview](https://marketapi.shop/docs/warehouses/overview): What a warehouse is and how it fits into stock.
  - [Create warehouse](https://marketapi.shop/docs/warehouses/create) `POST /v1/sellers/{sellerId}/warehouses`: Creates a warehouse for a seller.
  - [List warehouses](https://marketapi.shop/docs/warehouses/list) `GET /v1/warehouses`: Lists the account warehouses, paginated.
  - [Get warehouse](https://marketapi.shop/docs/warehouses/get) `GET /v1/warehouses/{warehouseId}`: Returns a warehouse by id.
  - [Update warehouse](https://marketapi.shop/docs/warehouses/update) `PATCH /v1/warehouses/{warehouseId}`: Changes the name, the external id or the default warehouse.
  - [Archive warehouse](https://marketapi.shop/docs/warehouses/archive) `DELETE /v1/warehouses/{warehouseId}`: Archives a warehouse without deleting it.
- Fulfillment inbound shipments
  - [Overview](https://marketapi.shop/docs/fulfillment-inbound-shipments/overview): How to send seller stock to the marketplace warehouse (Full, FBA).
  - [List shipments](https://marketapi.shop/docs/fulfillment-inbound-shipments/list) `GET /v1/fulfillment-inbound-shipments` (coming soon): Lists the account fulfillment inbound shipments, paginated and filtered.
  - [Create shipment](https://marketapi.shop/docs/fulfillment-inbound-shipments/create) `POST /v1/fulfillment-inbound-shipments` (coming soon): Registers a stock shipment to the marketplace warehouse.
  - [Get shipment](https://marketapi.shop/docs/fulfillment-inbound-shipments/get) `GET /v1/fulfillment-inbound-shipments/{id}` (coming soon): Returns one shipment with items and received quantities.
  - [Update shipment](https://marketapi.shop/docs/fulfillment-inbound-shipments/update) `PATCH /v1/fulfillment-inbound-shipments/{id}` (coming soon): Changes items, schedule, or marks the shipment as dispatched.
  - [Cancel shipment](https://marketapi.shop/docs/fulfillment-inbound-shipments/cancel) `DELETE /v1/fulfillment-inbound-shipments/{id}` (coming soon): Cancels the shipment and releases the stock reservation.
- Marketplace products
  - [Marketplace products](https://marketapi.shop/docs/marketplace-products/overview): The content a marketplace shares across offers.
  - [List marketplace products](https://marketapi.shop/docs/marketplace-products/list) `GET /v1/marketplace-products`: Lists the account's marketplace content, paginated.
  - [Get marketplace product](https://marketapi.shop/docs/marketplace-products/get) `GET /v1/marketplace-products/{marketplaceProductId}`: Gets a marketplace product by id.
  - [Update marketplace product content](https://marketapi.shop/docs/marketplace-products/update) `PATCH /v1/marketplace-products/{marketplaceProductId}`: Updates only the local content, with merge.
  - [Get resolved marketplace product content](https://marketapi.shop/docs/marketplace-products/resolved) `GET /v1/marketplace-products/{marketplaceProductId}/resolved`: Gets content inheritance and the source of each field.
  - [List marketplace product variations](https://marketapi.shop/docs/marketplace-products/list-variants) `GET /v1/marketplace-products/{marketplaceProductId}/variants`: Gets the complete variation map.
  - [Replace marketplace product variations](https://marketapi.shop/docs/marketplace-products/replace-variants) `PUT /v1/marketplace-products/{marketplaceProductId}/variants`: Atomically replaces the complete variation map.
  - [Publish marketplace product content](https://marketapi.shop/docs/marketplace-products/publish) `POST /v1/marketplace-products/{marketplaceProductId}/publish`: Queues the publication of the content alone, with no offer.
  - [Get the catalog link](https://marketapi.shop/docs/marketplace-products/catalog-reference) `GET /v1/marketplace-products/{marketplaceProductId}/catalog-reference` (coming soon): The requested link, the confirmed one and the eligibility.
  - [Set the catalog link](https://marketapi.shop/docs/marketplace-products/replace-catalog-reference) `PUT /v1/marketplace-products/{marketplaceProductId}/catalog-reference` (coming soon): Links the content to a catalog product, locally only.
  - [Remove the catalog link](https://marketapi.shop/docs/marketplace-products/delete-catalog-reference) `DELETE /v1/marketplace-products/{marketplaceProductId}/catalog-reference` (coming soon): Clears the requested link, locally only.
  - [Find catalog candidates](https://marketapi.shop/docs/marketplace-products/catalog-candidates) `GET /v1/marketplace-products/{marketplaceProductId}/catalog-candidates` (coming soon): Catalog products that match the content.
  - [Check catalog eligibility](https://marketapi.shop/docs/marketplace-products/check-catalog-eligibility) `POST /v1/marketplace-products/{marketplaceProductId}/catalog-eligibility-checks` (coming soon): Asks the marketplace if the content can use the catalog product.
- Listings
  - [Listings](https://marketapi.shop/docs/listings/overview): The offer in a Connection: price, inventory, and commercial rules.
  - [Create local listing](https://marketapi.shop/docs/listings/create) `POST /v1/sellers/{sellerId}/listings`: Creates a listing draft in an active Connection.
  - [List listings](https://marketapi.shop/docs/listings/list) `GET /v1/listings`: Lists local and imported listings.
  - [Get listing](https://marketapi.shop/docs/listings/get) `GET /v1/listings/{listingId}`: Gets a local listing by id.
  - [Update listing intent](https://marketapi.shop/docs/listings/update) `PATCH /v1/listings/{listingId}`: Updates only the listing's desired local data.
  - [Remove listing](https://marketapi.shop/docs/listings/remove) `DELETE /v1/listings/{listingId}`: Removes local data or explicitly requests remote removal.
  - [Clone listing for A/B](https://marketapi.shop/docs/listings/clone) `POST /v1/listings/{listingId}/clone`: Creates a local draft with no external identity.
  - [Publish listing](https://marketapi.shop/docs/listings/publish) `POST /v1/listings/{listingId}/publish`: Queues an explicit marketplace publication.
  - [Validate the offer](https://marketapi.shop/docs/listings/validate) `POST /v1/listings/{listingId}/validate` (coming soon): Checks the offer before publishing, without publishing.
  - [Run a marketplace action](https://marketapi.shop/docs/listings/marketplace-actions) `POST /v1/listings/{listingId}/marketplace-actions` (coming soon): Pause, activate, close or relist the listing.
  - [Refresh the offer from the marketplace](https://marketapi.shop/docs/listings/refresh) `POST /v1/listings/{listingId}/marketplace-refreshes` (coming soon): Reads the listing again from the marketplace.
  - [Publish listings in batch](https://marketapi.shop/docs/listings/publish-batch) `POST /v1/sellers/{sellerId}/listing-publications` (coming soon): Publishes 1 to 100 seller listings in one Job.
  - [Get resolved data](https://marketapi.shop/docs/listings/resolved) `GET /v1/listings/{listingId}/resolved`: Gets publishable inheritance and field provenance.
  - [Get observed state](https://marketapi.shop/docs/listings/observed) `GET /v1/listings/{listingId}/observed`: Gets the last marketplace-confirmed representation.
  - [Compare desired and observed](https://marketapi.shop/docs/listings/diff) `GET /v1/listings/{listingId}/diff`: Shows, per group, what changed here and what changed on the marketplace.
  - [List offer issues](https://marketapi.shop/docs/listings/issues) `GET /v1/listings/{listingId}/issues`: Lists what blocks the offer from being published or sold.
  - [View offer activity](https://marketapi.shop/docs/listings/activity) `GET /v1/listings/{listingId}/activity`: Timeline of everything that happened to the offer.
  - [List offer relations](https://marketapi.shop/docs/listings/relations) `GET /v1/listings/{listingId}/relations`: Catalog twin, relisting and migration.
  - [List publish attempts](https://marketapi.shop/docs/listings/publish-attempts) `GET /v1/listings/{listingId}/publish-attempts`: Every attempt to publish or remove the offer.
  - [List conflicts](https://marketapi.shop/docs/listings/conflicts) `GET /v1/listings/{listingId}/conflicts`: Outside changes that clash with a pending local change.
  - [Resolve conflict](https://marketapi.shop/docs/listings/resolve-conflict) `POST /v1/listings/{listingId}/conflicts/{conflictId}/resolve`: Pick the side that wins, local or marketplace.
  - [List variant bindings](https://marketapi.shop/docs/listings/list-bindings) `GET /v1/listings/{listingId}/variant-bindings`: Gets the mapping from external variations to local Variants.
  - [Replace variant bindings](https://marketapi.shop/docs/listings/replace-bindings) `PUT /v1/listings/{listingId}/variant-bindings`: Atomically replaces the complete binding map.
  - [Update variant binding](https://marketapi.shop/docs/listings/update-binding) `PATCH /v1/listings/{listingId}/variant-bindings/{bindingId}`: Adjusts one offer line without replacing the whole map.
  - [Remove variant binding](https://marketapi.shop/docs/listings/remove-binding) `DELETE /v1/listings/{listingId}/variant-bindings/{bindingId}`: Removes one offer line, local record only.
  - [Get synchronization policy](https://marketapi.shop/docs/listings/sync-policy) `GET /v1/listings/{listingId}/sync-policy`: Gets listing inbound, outbound, and inventory synchronization.
  - [Update synchronization policy](https://marketapi.shop/docs/listings/update-sync-policy) `PATCH /v1/listings/{listingId}/sync-policy`: Replaces a listing's effective policy.
  - [Get marketplace options](https://marketapi.shop/docs/listings/get-marketplace-options) `GET /v1/listings/{listingId}/marketplace-options`: Returns the marketplace-specific options saved on the listing.
  - [Update marketplace options](https://marketapi.shop/docs/listings/update-marketplace-options) `PATCH /v1/listings/{listingId}/marketplace-options`: Merges the listing's marketplace-specific options.
- Orders
  - [Overview](https://marketapi.shop/docs/orders/overview): Orders imported from marketplaces: status, totals and buyer data.
  - [List orders](https://marketapi.shop/docs/orders/list) `GET /v1/orders`: Lists the account orders, newest first.
  - [Get order](https://marketapi.shop/docs/orders/get) `GET /v1/orders/{orderId}`: Returns an order with its lines, payments and totals.
  - [Get buyer](https://marketapi.shop/docs/orders/buyer) `GET /v1/orders/{orderId}/buyer`: Returns the personal data of an order's buyer.
  - [Run order action](https://marketapi.shop/docs/orders/actions) `POST /v1/orders/{orderId}/actions` (coming soon): Cancels the order or blocks the buyer, in a job.
- Invoices (NF-e)
  - [Overview](https://marketapi.shop/docs/invoices/overview): 'Invoices (NF-e): you send the XML, marketapi validates it and sends it to the marketplace.'
  - [List order invoices](https://marketapi.shop/docs/invoices/list) `GET /v1/orders/{orderId}/invoices` (coming soon): Lists the invoices sent for an order.
  - [Send invoice](https://marketapi.shop/docs/invoices/create) `POST /v1/orders/{orderId}/invoices` (coming soon): Sends the XML of an already authorized invoice for the order.
  - [Get invoice](https://marketapi.shop/docs/invoices/get) `GET /v1/invoices/{invoiceId}` (coming soon): Returns an invoice by id.
  - [Download invoice XML](https://marketapi.shop/docs/invoices/xml) `GET /v1/invoices/{invoiceId}/xml` (coming soon): Returns the invoice XML file.
- Shipments
  - [Overview](https://marketapi.shop/docs/shipments/overview): Shipments: N:N items with the order, tracking, label and dispatch.
  - [List shipments](https://marketapi.shop/docs/shipments/list) `GET /v1/shipments` (coming soon): Lists the account shipments, paginated and filtered.
  - [Get shipment](https://marketapi.shop/docs/shipments/get) `GET /v1/shipments/{shipmentId}` (coming soon): Returns a shipment with items, costs and labels.
  - [Get tracking](https://marketapi.shop/docs/shipments/tracking) `GET /v1/shipments/{shipmentId}/tracking` (coming soon): Returns the tracking events of a shipment.
  - [Get dispatch options](https://marketapi.shop/docs/shipments/dispatch-options) `GET /v1/shipments/{shipmentId}/dispatch-options` (coming soon): Lists how the shipment can be dispatched.
  - [Request label](https://marketapi.shop/docs/shipments/request-label) `POST /v1/shipments/{shipmentId}/label-requests` (coming soon): Requests the shipment label, as pdf or zpl, in a job.
  - [Dispatch shipment](https://marketapi.shop/docs/shipments/dispatch) `POST /v1/shipments/{shipmentId}/dispatches` (coming soon): Records the shipment dispatch, in a job.
  - [Run shipment action](https://marketapi.shop/docs/shipments/actions) `POST /v1/shipments/{shipmentId}/actions` (coming soon): Marks ready, updates tracking or records delivery, in a job.
- Returns
  - [Overview](https://marketapi.shop/docs/returns/overview): What a return is and the rules that apply to all its endpoints.
  - [List returns](https://marketapi.shop/docs/returns/list) `GET /v1/returns` (coming soon): Lists the account returns, paginated and filtered.
  - [Get return](https://marketapi.shop/docs/returns/get) `GET /v1/returns/{returnId}` (coming soon): Returns one return with lines, tracking and allowed actions.
  - [Act on a return](https://marketapi.shop/docs/returns/actions) `POST /v1/returns/{returnId}/actions` (coming soon): Approves, refunds or records the review of a return.
- Disputes
  - [Overview](https://marketapi.shop/docs/disputes/overview): What a dispute is and the rules that apply to all its endpoints.
  - [List disputes](https://marketapi.shop/docs/disputes/list) `GET /v1/disputes` (coming soon): Lists the account disputes, paginated and filtered.
  - [Get dispute](https://marketapi.shop/docs/disputes/get) `GET /v1/disputes/{disputeId}` (coming soon): Returns one dispute with deadline, allowed actions and resolution.
  - [List dispute messages](https://marketapi.shop/docs/disputes/list-messages) `GET /v1/disputes/{disputeId}/messages` (coming soon): Lists the messages exchanged in the dispute.
  - [Send dispute message](https://marketapi.shop/docs/disputes/send-message) `POST /v1/disputes/{disputeId}/messages` (coming soon): Sends a seller message to the buyer or the marketplace.
  - [Act on a dispute](https://marketapi.shop/docs/disputes/actions) `POST /v1/disputes/{disputeId}/actions` (coming soon): Refunds, allows a return, escalates or submits evidence on a dispute.
- Questions
  - [Overview](https://marketapi.shop/docs/questions/overview): What a question is and the rules that apply to all its endpoints.
  - [List questions](https://marketapi.shop/docs/questions/list) `GET /v1/questions` (coming soon): Lists the buyer questions of the account, paginated and filtered.
  - [Get question](https://marketapi.shop/docs/questions/get) `GET /v1/questions/{questionId}` (coming soon): Returns one question with its text and answer.
  - [Answer question](https://marketapi.shop/docs/questions/answer) `POST /v1/questions/{questionId}/answers` (coming soon): Publishes the seller answer to a question.
  - [Run a question action](https://marketapi.shop/docs/questions/actions) `POST /v1/questions/{questionId}/actions` (coming soon): Deletes the question or blocks its author.
- Conversations
  - [Overview](https://marketapi.shop/docs/conversations/overview): What a conversation is, how to send messages and which limits apply.
  - [List conversations](https://marketapi.shop/docs/conversations/list) `GET /v1/conversations` (coming soon): Lists the account post-sale conversations, paginated and filtered.
  - [Get conversation](https://marketapi.shop/docs/conversations/get) `GET /v1/conversations/{conversationId}` (coming soon): Returns one conversation with its state and what you can send.
  - [List messages](https://marketapi.shop/docs/conversations/list-messages) `GET /v1/conversations/{conversationId}/messages` (coming soon): Lists the messages of a conversation, oldest first.
  - [Send message](https://marketapi.shop/docs/conversations/send-message) `POST /v1/conversations/{conversationId}/messages` (coming soon): Sends a seller message to the buyer.
- Reviews
  - [Overview](https://marketapi.shop/docs/reviews/overview): What a review is, how to read the rating and when a reply is refused.
  - [List reviews](https://marketapi.shop/docs/reviews/list) `GET /v1/reviews` (coming soon): Lists the received reviews, paginated and filtered.
  - [Get review](https://marketapi.shop/docs/reviews/get) `GET /v1/reviews/{reviewId}` (coming soon): Returns one review with its rating, text and reply.
  - [Reply to a review](https://marketapi.shop/docs/reviews/reply) `POST /v1/reviews/{reviewId}/replies` (coming soon): Publishes the seller reply to a review.
- Promotions
  - [Overview](https://marketapi.shop/docs/promotions/overview): What a promotion is, where it comes from and how to join one.
  - [List promotions](https://marketapi.shop/docs/promotions/list) `GET /v1/promotions` (coming soon): Lists the account's promotions, paginated and filtered.
  - [Create promotion](https://marketapi.shop/docs/promotions/create) `POST /v1/promotions` (coming soon): Creates a promotion on a Connection.
  - [Get promotion](https://marketapi.shop/docs/promotions/get) `GET /v1/promotions/{promotionId}` (coming soon): Gets a promotion by id.
  - [Update promotion](https://marketapi.shop/docs/promotions/update) `PATCH /v1/promotions/{promotionId}` (coming soon): Changes the name, period or rules of your own promotion.
  - [Cancel promotion](https://marketapi.shop/docs/promotions/delete) `DELETE /v1/promotions/{promotionId}` (coming soon): Ends one of your promotions.
  - [List promotion entries](https://marketapi.shop/docs/promotions/list-entries) `GET /v1/promotions/{promotionId}/listing-entries` (coming soon): Lists the listings that take part in the promotion.
  - [Replace promotion entries](https://marketapi.shop/docs/promotions/replace-entries) `PUT /v1/promotions/{promotionId}/listing-entries` (coming soon): Replaces the set of listings in the promotion.
  - [List listing promotions](https://marketapi.shop/docs/promotions/list-for-listing) `GET /v1/listings/{listingId}/promotions` (coming soon): Lists the promotions a listing takes part in.
  - [List listing eligibilities](https://marketapi.shop/docs/promotions/list-eligibilities) `GET /v1/listings/{listingId}/promotion-eligibilities` (coming soon): Lists the promotions a listing can still join.
  - [Create promotion for a listing](https://marketapi.shop/docs/promotions/create-for-listing) `POST /v1/listings/{listingId}/promotions` (coming soon): Creates a direct discount on a listing.
- Promotion renewals
  - [Overview](https://marketapi.shop/docs/promotion-renewals/overview): How renewal recreates a promotion before it ends.
  - [List renewals](https://marketapi.shop/docs/promotion-renewals/list) `GET /v1/promotion-renewals` (coming soon): Lists the promotion renewal rules.
  - [Create renewal](https://marketapi.shop/docs/promotion-renewals/create) `POST /v1/promotion-renewals` (coming soon): Turns on renewal for a promotion.
  - [Update renewal](https://marketapi.shop/docs/promotion-renewals/update) `PATCH /v1/promotion-renewals/{renewalId}` (coming soon): Turns a renewal rule on or off, or changes it.
  - [Delete renewal](https://marketapi.shop/docs/promotion-renewals/delete) `DELETE /v1/promotion-renewals/{renewalId}` (coming soon): Deletes a renewal rule.
- Pricing and fees
  - [Overview](https://marketapi.shop/docs/pricing/overview): Fee estimate and competitive price of a listing.
  - [Estimate fees](https://marketapi.shop/docs/pricing/fee-estimates) `POST /v1/listings/{listingId}/fee-estimates` (coming soon): Estimates the marketplace fees for a listing.
  - [Get competitive prices](https://marketapi.shop/docs/pricing/competitive-prices) `GET /v1/listings/{listingId}/competitive-prices` (coming soon): Shows the listing price position against competitors.
- Metrics
  - [Overview](https://marketapi.shop/docs/metrics/overview): Visits, units, revenue and conversion for products and listings, as a series over a period.
  - [Product metrics](https://marketapi.shop/docs/metrics/product-metrics) `GET /v1/products/{productId}/metrics` (coming soon): Visits, sales and conversion series for a product.
  - [Listing metrics](https://marketapi.shop/docs/metrics/listing-metrics) `GET /v1/listings/{listingId}/metrics` (coming soon): Visits, sales and conversion series for a Listing.
  - [Listing visits](https://marketapi.shop/docs/metrics/listing-visits) `GET /v1/listings/{listingId}/visits` (coming soon): Visits series for a Listing.
- Ads
  - [Overview](https://marketapi.shop/docs/ad-campaigns/overview): Paid ad campaigns, metrics and actions.
  - [List campaigns](https://marketapi.shop/docs/ad-campaigns/list) `GET /v1/ad-campaigns` (coming soon): Lists the account ad campaigns.
  - [Get campaign](https://marketapi.shop/docs/ad-campaigns/get) `GET /v1/ad-campaigns/{campaignId}` (coming soon): Returns one ad campaign.
  - [Campaign metrics](https://marketapi.shop/docs/ad-campaigns/metrics) `GET /v1/ad-campaigns/{campaignId}/metrics` (coming soon): Performance series for a campaign.
  - [Act on a campaign](https://marketapi.shop/docs/ad-campaigns/actions) `POST /v1/ad-campaigns/{campaignId}/actions` (coming soon): Pauses, activates or changes the budget of a campaign.
  - [Sync metrics](https://marketapi.shop/docs/ad-campaigns/metric-syncs) `POST /v1/connections/{id}/ad-metric-syncs` (coming soon): Requests a refresh of a Connection's campaigns and metrics.
- Finance
  - [Overview](https://marketapi.shop/docs/finance/overview): Transactions, settlements, fee statements and balances of the sellers, for reconciliation.
  - [List transactions](https://marketapi.shop/docs/finance/transactions) `GET /v1/financial-transactions` (coming soon): Lists the sellers' financial transactions.
  - [List settlements](https://marketapi.shop/docs/finance/settlements) `GET /v1/settlements` (coming soon): Lists the payouts made to sellers.
  - [List fee statements](https://marketapi.shop/docs/finance/fee-statements) `GET /v1/fee-statements` (coming soon): Lists the fee statements charged to sellers.
  - [List balances](https://marketapi.shop/docs/finance/balances) `GET /v1/financial-balances` (coming soon): Lists the sellers' balance in each marketplace.
- Webhooks
  - [Overview](https://marketapi.shop/docs/webhooks/overview): Endpoints that receive the account events, and the rules that apply to all of them.

## Events

  - [List event types](https://marketapi.shop/docs/webhooks/list-event-types) `GET /v1/webhooks/event-types`: Every event an endpoint can subscribe to.

## Endpoints

  - [Register an endpoint](https://marketapi.shop/docs/webhooks/create-endpoint) `POST /v1/webhooks/endpoints`: Registers a URL of your system to receive events.
  - [List endpoints](https://marketapi.shop/docs/webhooks/list-endpoints) `GET /v1/webhooks/endpoints`: Lists the webhook endpoints of the account.
  - [Get an endpoint](https://marketapi.shop/docs/webhooks/get-endpoint) `GET /v1/webhooks/endpoints/{id}`: Reads a webhook endpoint by id.
  - [Update an endpoint](https://marketapi.shop/docs/webhooks/update-endpoint) `PATCH /v1/webhooks/endpoints/{id}`: Changes the URL, the events or the description, or pauses the endpoint.
  - [Delete an endpoint](https://marketapi.shop/docs/webhooks/delete-endpoint) `DELETE /v1/webhooks/endpoints/{id}`: Deletes an endpoint and its delivery log.
  - [Rotate secret](https://marketapi.shop/docs/webhooks/rotate-secret) `POST /v1/webhooks/endpoints/{id}/rotate-secret`: Replaces the endpoint's signing secret.

## Deliveries

  - [List deliveries](https://marketapi.shop/docs/webhooks/list-deliveries) `GET /v1/webhooks/deliveries`: The webhook delivery log, newest first.
  - [Get a delivery](https://marketapi.shop/docs/webhooks/get-delivery) `GET /v1/webhooks/deliveries/{id}`: Reads a delivery by id.
  - [Redeliver](https://marketapi.shop/docs/webhooks/redeliver) `POST /v1/webhooks/deliveries/{id}/redeliver`: Sends the event of a delivery again.
- Jobs
  - [Overview](https://marketapi.shop/docs/jobs/overview): What a job is and the rules that apply to all of its endpoints.
  - [List jobs](https://marketapi.shop/docs/jobs/list) `GET /v1/jobs`: Lists the account jobs, one page at a time.
  - [Get a job](https://marketapi.shop/docs/jobs/get) `GET /v1/jobs/{id}`: Reads a job by id.
  - [List items](https://marketapi.shop/docs/jobs/items) `GET /v1/jobs/{id}/items`: Lists the items of a job, in the job order.