Skip to content

Main Navigation Home Guias API Novidades

Portuguese

Portuguese

Appearance

Sidebar Navigation

INTRO

Visão Geral

Eventos de Webhook

GraphQL

SDK

Auth

Auth

Generate a Token POST

Bills API

Accounts Payable

Create accounts payable POST

Update accounts payable PUT

Delete accounts payable DELETE

Delete all accounts payable DELETE

Create accounts payable batch POST

Accounts Receivable

Create accounts receivable POST

Delete accounts receivable DELETE

Update accounts receivable PUT

Business Organization API

Business Organizations

Create a business organization POST

Update a business organization and its associated processes PUT

Get a business organization by Id GET

Delete a business organization from an associated parent entity PUT

Get a list of parent-entities by business organization Id. GET

Delete a business organization from an associated cost center PUT

Get a list of cost centers for the business organization based on the business organization Id. GET

Get a list of child-entities by business organization Id. GET

Get a list of product groups for the business organization based on the business organization Id. GET

Contracts API

Approvers

Get Contract approvers by ContractId GET

Contracts

Get a Contract by Id GET

Update a contract based on the contractId PATCH

Update a contract status based on the contractId PUT

Get the business organizations in a contract by ContractId GET

Create a contract POST

Items

Get Contract items by ContractId GET

Get the business organizations of the items in a contract by ContractId GET

Cost Centers API

Associated Processes

Get the cost center business organizations GET

Get all cost centers x ledger accounts GET

Get all cost centers x service orders GET

Cost Centers

Create a Cost Center POST

Get all cost centers GET

Update a Cost Center based on the cost center Id PUT

Delete the Cost Center relationships based on the cost center Id POST

Cost Centers Relationships

Update the relationships between ledgers and service orders with cost centers. PUT

Get all cost objects relationships by cost center Id GET

Currencies API

Currencies

Create a Currency POST

Get Currencies GET

Get Currency by CurrencyCode GET

Update a Currency based on the CurrencyCode PATCH

Delete a currency based on the CurrencyCode DELETE

Delete a relationship between a list of Business Organizations and a Currency POST

Decision Table API

Decision Table

Create a decision table POST

Delete a decision table DELETE

Update a decision table PUT

Delete a decision table POST

Get the table rows from a decision table GET

Invoices API

Invoices

Get an invoice based on the invoiceId GET

Get a list of invoice items based on the invoiceId GET

Get the Business Organizations based on the invoiceId GET

Get the attachments based on the invoiceId GET

Add an attachment to an invoice POST

Get information from invoice attachment GET

Delete an invoice attachment document DELETE

Redirection link to download the attachment GET

Get the invoice attributes based on the invoice Id. GET

Get the invoice items attributes based on the invoice Id. GET

Update an Invoice status based on the invoiceId PUT

Create an invoice POST

Supplier Invoices

Create an invoice POST

Add an attachment to an invoice POST

Get the attachments based on the invoiceId GET

Redirection link to download the attachment GET

Get information from invoice attachment GET

Delete an invoice attachment document DELETE

Ledgers API

Associated Processes

Get all ledger business organization joins GET

Get all ledger accounts x cost centers GET

Get all ledger accounts x service orders GET

Ledgers

Create a ledger POST

Get all ledger accounts GET

Update a ledger based on the contract Id PUT

Delete the Ledger relationships based on the contract Id POST

Ledgers Relationships

Update the relationships between cost centers and service orders with ledgers. PUT

Get all cost objects relationships by ledger code GET

Locations API

Locations

Create a location POST

Update a location based on the LocationId PUT

Get a location by Id GET

Delete a location DELETE

Delete a location from an associated business organization PUT

Orders API

Deliveries

Create an order delivery POST

Get the deliveries based on its orderId GET

Get an delivery based on the order Id and delivery Id. GET

Orders

Create an order POST

Get orders GET

Get an order based on the order Id. GET

Update an order based on the order Id PUT

Add an attachment to the order POST

Get the order attributes based on the order Id. GET

Get the order business organizations based on the order Id. GET

Delete an attachment from an order DELETE

Redirection link to download the order attachment GET

Get a list of items based on the order Id GET

Get the attributes of an item based on the orderId and itemNumber. GET

Get a delivery based on its orderId and orderItemId GET

Get the business organizations of an item based on the orderId and itemNumber. GET

Delete an attachment from an order item DELETE

Redirection link to download the order item attachment GET

Add an attachment to the order item POST

Supplier Orders

Get the order deliveries based on the order Id. GET

Get an delivery based on the order Id and delivery Id. GET

Get an order based on the order Id GET

Get orders GET

Get the order attributes based on the order Id. GET

Get the order business organizations based on the order Id. GET

Get a list of order items based on the order Id GET

Get the attributes of an item based on the orderId and itemNumber. GET

Get the deliveries of a prorated item based on its orderId and itemNumber GET

Get the business organizations of an item based on the orderId and itemNumber. GET

Supplier Orders - Acceptance and Refusal

Confirm an order based on the order Id PATCH

Confirm an order based on the order Id PUT

Reject an order based on the order Id and the reason for rejection PATCH

Reject an order based on the order Id and the reason for rejection PUT

Mark an order as read based on the order ID PATCH

Mark an order as read based on the order ID PUT

Confirm or Reject order items based on the order Id and item Id PATCH

Payment Conditions API

Payment Conditions

Create a payment condition POST

Get all payment conditions GET

Update a payment condition PUT

Get a payment condition GET

Delete a payment condition DELETE

Get all business organizations related to a payment condition GET

Delete a relationship between a list of business organizations and a payment condition POST

Permanent Assets API

Permanent Assets

Create a Permanent Asset POST

Get Permanent Assets GET

Get a Permanent Asset GET

Update a Permanent Asset PATCH

Delete a Permanent Asset DELETE

Delete a relationship between a list of Business Organizations and a Permanent Asset POST

Pre-Orders Api

Associated Processes

Get the entire list of Attributes for all items (Request Item x Pre-Order Item) GET

Get the entire list of Attributes for a specific item (Request Item x Pre-Order Item) GET

Get the entire list of Cost-Objects (Request Item x Pre-Order Item) GET

Get the entire list of Deliveries (Request Item x Pre-Order Item) GET

Pre-Order Items

Get the attachment ids linked to a pre-order item GET

Get information from pre-order item attachment GET

Redirection link to download the pre-order item attachment GET

Get the entire list of item Attributes GET

Get the list of Attributes GET

Update pre-order item attributes PUT

Get a list of pre-order items based on the pre-order Id GET

Get a list of Requests associated with a specific item GET

Pre-Orders

Get Approvers list GET

Get the attachment ids linked to a pre-order GET

Get information from pre-order attachment GET

Redirection link to download the pre-order attachment GET

Get header Attributes GET

Update pre-order attributes based on the pre-order Id PUT

Get Business Organizations GET

Get a pre-order based on the Id GET

Update a pre-order status based on the pre-order Id PUT

Get a list of pre-order items based on the pre-order item Id and quotation id GET

Products API

Product Taxes

Create a product tax information POST

Get all product tax information GET

Get a product tax information GET

Update a product tax information. PUT

Delete a product tax information. DELETE

Products

Create a product POST

Get All Objects GET

Get a product based on the product Id GET

Update a product PUT

Add an attachment to the product POST

Update a product picture based on the ProductId and PictureId PUT

Get the primary product picture based on the product ID GET

Add a picture to a product POST

Get all pictures associated with a product GET

Delete a picture associated with a product DELETE

Get product picture information GET

Redirection link to download the picture GET

Source Lists

Creates a new source list. POST

Get all source lists GET

Get a source list GET

Update a source list PUT

Delete a source list DELETE

Quotations API

Quotation response by the buyer

Create a quotation response by the buyer based on the quotationId and the supplierId POST

Update a quotation response by the buyer based on the quotationId and the supplierId PUT

Delete a quotation response by the buyer based on the quotationId and the supplierId DELETE

Get a quotation response by the buyer based on the quotationId and the supplierId GET

Quotation response by the supplier

Create a quotation response POST

Update a quotation response based on the quotationId PUT

Delete a quotation response based on the quotationId DELETE

Quotations

Create a quotation POST

Update a quotation based on the quotationId PUT

Get a quotation by Id GET

Get quotation items by Id GET

Get customer payments by Id GET

Get incoterms by Id GET

Supplier Quotations

Get customer payments by QuotationId GET

Get incoterms by QuotationId GET

Get a quotation by Id GET

Get quotation items by Id GET

Requests API

Items

Get request item attributes GET

Get all request items attributes GET

Get request item cost object GET

Get the entire list of cost objects GET

Get request item delivery GET

Get the entire list of approvers GET

Add an attachment to a request item POST

Get the attachment ids linked to a request item GET

Get information from request item attachment GET

Redirection link to download the request item attachment GET

Get a list of Item's Business Organizations GET

Get the process follow-up for the request item GET

Pre-Requests

Get a pre-request based on the preRequestId GET

Reject a pre request based on the pre request Id and body information POST

Approves a pre-request POST

Requests

Create a request POST

Get all requests GET

Update a request based on the requestId PUT

Get a request based on the requestId GET

Get a list of request attributes GET

Get a list of request approvers GET

Get a list of request items GET

Get a list of Business Organizations GET

Add an attachment to a request POST

Get the attachment ids linked to a request GET

Get information from request attachment GET

Redirection link to download the request attachment GET

Service Orders Api

Associated Processes

Get all service orders x business organizations GET

Get all service orders x cost centers GET

Get all service orders x ledger accounts GET

Service Orders

Create a service order POST

Get all service orders GET

Update a service order by Id PUT

Delete the Service Order relationships based on the Service order code POST

Service-Sheet API

ServiceSheet

Get a service sheet by Id GET

Update a Service Sheet status based on the serviceSheetId PUT

Cancel a service sheet DELETE

ServiceSheetDocument

Get a service sheet GET

Update a Service Sheet status PUT

Create a service sheet POST

Cancel a service sheet DELETE

Supplier Catalogs API

Price Catalogs

Create a price catalog associated to a `clientId` POST

Update a price catalog associated to a `clientId` based on the priceCatalogId PUT

Get a Price Catalog associated to a `clientId` by Id GET

Cancel a price catalog associated to a `clientId` based on the `priceCatalogId` PUT

Cancel the price catalog items associated to a `clientId` based on the priceCatalogId PUT

Get Price Catalog items associated to a `clientId` by `priceCatalogId` GET

Create new price catalogs associated to a `clientId` using a JSON file POST

Product Categories

Create a product category associated to a `clientId` POST

Get all product categories associated to a `clientId` GET

Get a product category associated to a `clientId` based on the `productCategoryId` GET

Update a product category associated to a `clientId` based on the `productCategoryId` PATCH

Delete a relationship between a list of Permissions and a Product Category POST

Delete a Product Category associated to a `clientId` based on the `productCategoryId` DELETE

Product Pictures

Add a picture to a product POST

Get all pictures associated with a product GET

Update a product picture based on the `productId` and `pictureId` PATCH

Delete a picture associated with a product DELETE

Get product picture information GET

Get the primary product picture based on the `productId` GET

Redirection link to download the picture GET

Products

Create a product associated to a `clientId` POST

Get all products associated to a `clientId` GET

Get a product associated to a `clientId` based on the `productId` GET

Update a product associated to a `clientId` PATCH

Create new products associated to a `clientId` using a JSON file POST

Suppliers API

Suppliers

Create a Supplier POST

Get Suppliers GET

Get a Supplier by supplierId GET

Update a supplier based on the supplierId PUT

Get the supplier attributes based on the supplier Id. GET

Get the supplier accounts based on the supplierId GET

Remove a supplier from one or more associated groups PUT

Get the supplier business organizations based on the supplierId GET

Get payment conditions for business organizations by supplier based on the supplierId GET

Users API

Users

Get user related to business organizations GET

Create a user POST

Get all users GET

Update a user by id PUT

Get user by Id GET

Get user related to cost centers GET

Get user related to purchasing groups GET

WBS Element API

WBS Elements

Create a WBS element POST

Get WBS Elements GET

Update a WBS element PUT

Delete a WBS element DELETE

WBS Elements Relationships

Delete a relationship between a list of Business Organizations and a WBS element POST

Get all business organizations related to a WBS Element GET

Webhooks

Webhooks

Create a new Webhook POST

Retrieves a list of Webhooks GET

Fetch a single Webhook GET

Remove an existing Webhook DELETE

Suspend activity for a Webhook PATCH

Resume activity for a Webhook PATCH

Change Webhook credential PATCH

Webhooks Credentials

Credentials

Create a credential POST

Get all credentials GET

Update a credential based on the id PUT

Get a credential based on the Id GET

Delete a credential based on the Id DELETE

Create a credential

post

https://api.mercadoe.com/v1/credentials

Production Staging

Request

Body

application/json

name

string

type

string

allowed values: BasicAuthOAuth2

basicAuth

object

oAuth2

object

Responses

200

400

OK

Body

application/json

id

string

Open Api Specification

Credentials

cURL

shell

Last updated:

Pager

Next pageVisão Geral