POST v1/ads

Cria um novo anúncio

Requer Autorização

Para realizar a autorização, é necessário enviar as credenciais de autenticação usando o cabeçalho de autorização.
O cabeçalho de autorização é construído como se segue:

O nome de usuário e a senha são combinadas em uma string "usuário:senha"
A seqüência resultante literal é então codificado em Base64
O método de autorização seguido da palavra "Basic" é, então, colocado antes da seqüência codificada.

Por exemplo, se o usuário é 'Aladdin' e a senha é "abra-de-sésamo" então o cabeçalho deve ser:
Authorization: Basic QWxhZGRpbjphYnJhLWRlLXPDqXNhbW8=

Códigos de Resposta

Created (201)
BadRequest (400)
Unauthorized (401)
Forbidden (403)
NotFound (404)

Informações da Requisição

Parâmetros da URL

Os parâmetros devem ser informados na URL da requisição.

Nenhum.

Parâmetros do corpo da requisição

Estes parâmetros devem ser informados no corpo da requisição.

AdNewRequest Modelo de representação de um anúncio.

Nome	Descrição	Tipo	Informações adicionais
ReferenceCode	Código de referência do anúncio fornecido pelo anunciante	string	Obrigatório
OfferType	Tipo de oferta do anúncio (Venda/Locação/Serviço)	string	Obrigatório
ContractId	Código de identificação do Contrato atual do anunciante	integer	Obrigatório
Category	Categoria da Máquina/Equipamento do anúncio	string	Obrigatório
Make	Fabricante da Máquina/Equipamento do anúncio	string
Model	Modelo da Máquina/Equipamento do anúncio	string
SerialNumber	Número de série da Máquina/Equipamento do anúncio	string
Year	Ano de fabricação da Máquina/Equipamento do anúncio (ex. 1998)	integer
Price	Valor do anúncio em Reais (ex. R$ 100.000,00 -> 100000). Somente números.	integer
State	Estado (UF) da localização do anúncio (ex. SP)	string	Obrigatório
City	Cidade da localização do anúncio (ex. Jundiaí)	string	Obrigatório
Description	Descrição do anúncio (Ex.: pintura nova, pneus bons, cabinada, motor novo) É proibido inserir endereços de outros sites, telefones e e-mail.	string
IsPrivate	Indica se o anúncio é particular (publicado somente EmEstoque)	boolean	Obrigatório
SyncToMarketplaces	Indica se o anúncio deve ser Sincronizado com os Marketplaces disponíveis através do EmEstoque	boolean
Photos	Lista com os links das fotos da Máquina do anúncio. Máximo de 4 fotos.	string array

Formatos da Requisição

application/json, text/json

Observações:

No formato Json, os nomes dos parâmetros seguem o padrão camelCase, ou seja, sempre são iniciados com letras minúsculas.

{
  "referenceCode": "XXXX0123456",
  "offerType": "Venda",
  "contractId": 1,
  "category": "Escavadeira",
  "make": "Case",
  "model": "CX220",
  "serialNumber": "ABC123456",
  "year": 2012,
  "price": 100000,
  "state": "SP",
  "city": "Jundiaí",
  "description": "NONONON NONONON NONONON",
  "isPrivate": false,
  "syncToMarketplaces": false,
  "photos": [
    "http://www.yourdomain.com/photo1.jpg",
    "http://www.yourdomain.com/photo2.jpg",
    "http://www.yourdomain.com/photo3.jpg",
    "http://www.yourdomain.com/photo4.jpg"
  ]
}

text/html

{"referenceCode":"XXXX0123456","offerType":"Venda","contractId":1,"category":"Escavadeira","make":"Case","model":"CX220","serialNumber":"ABC123456","year":2012,"price":100000,"state":"SP","city":"Jundiaí","description":"NONONON NONONON NONONON","isPrivate":false,"syncToMarketplaces":false,"photos":["http://www.yourdomain.com/photo1.jpg","http://www.yourdomain.com/photo2.jpg","http://www.yourdomain.com/photo3.jpg","http://www.yourdomain.com/photo4.jpg"]}

application/xml, text/xml

<AdNewRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ReferenceCode>XXXX0123456</ReferenceCode>
  <OfferType>Venda</OfferType>
  <ContractId>1</ContractId>
  <Category>Escavadeira</Category>
  <Make>Case</Make>
  <Model>CX220</Model>
  <SerialNumber>ABC123456</SerialNumber>
  <Year>2012</Year>
  <Price>100000</Price>
  <State>SP</State>
  <City>Jundiaí</City>
  <Description>NONONON NONONON NONONON</Description>
  <IsPrivate>false</IsPrivate>
  <SyncToMarketplaces>false</SyncToMarketplaces>
  <Photos>
    <Url>http://www.yourdomain.com/photo1.jpg</Url>
    <Url>http://www.yourdomain.com/photo2.jpg</Url>
    <Url>http://www.yourdomain.com/photo3.jpg</Url>
    <Url>http://www.yourdomain.com/photo4.jpg</Url>
  </Photos>
</AdNewRequest>

application/x-www-form-urlencoded

Exemplo não disponível.

Informações da Resposta

Descrição do recurso

AdResponse Retorna a representação do anúncio cadastrado.

Nome	Descrição	Tipo	Informações adicionais
AdId	Código de identificação do anúncio gerado pelo sistema	integer
ReferenceCode	Código de referência do anúncio fornecido pelo anunciante	string	Obrigatório
Type	Tipo de oferta do anúncio (Venda/Locação/Serviço)	string	Obrigatório
ContractId	Código de identificação do Contrato atual do anunciante	integer	Obrigatório
Category	Categoria da Máquina/Equipamento do anúncio	string	Obrigatório
Make	Fabricante da Máquina/Equipamento do anúncio	string	Obrigatório
Model	Modelo da Máquina/Equipamento do anúncio	string	Obrigatório
SerialNumber	Número de série da Máquina/Equipamento do anúncio	string
Year	Ano de fabricação da Máquina/Equipamento do anúncio (ex. 1998)	integer
Price	Valor do anúncio em Reais (ex. R$ 100.000,00 -> 100000). Somente números.	integer
State	Estado (UF) da localização do anúncio (ex. SP)	string	Obrigatório
City	Cidade da localização do anúncio (ex. Jundiaí)	string	Obrigatório
Description	Descrição do anúncio (Ex.: pintura nova, pneus bons, cabinada, motor novo) É proibido inserir endereços de outros sites, telefones e e-mail.	string
IsPrivate	Indica se o anúncio é particular (publicado somente EmEstoque)	boolean	Obrigatório
SyncToMarketplaces	Indicar se o anúncio deve ser Sincronizado com os Marketplaces disponíveis através do EmEstoque	boolean
Photos	Lista com os links das fotos da Máquina do anúncio. Máximo de 4 fotos.	string array	Tam. Máx.: 4
Specifications	Lista das especificações do anúncio	NameValueItem array
Links	Lista de links do anúncio	Link array

Formatos da Resposta

application/json, text/json

Observações:

No formato Json, os nomes dos parâmetros seguem o padrão camelCase, ou seja, sempre são iniciados com letras minúsculas.

{
  "adId": 1,
  "referenceCode": "XXXX0123456",
  "type": "Venda",
  "contractId": 1,
  "category": "Escavadeira",
  "make": "Case",
  "model": "CX220",
  "serialNumber": "ABC123456",
  "year": 2012,
  "price": 100000,
  "state": "SP",
  "city": "Jundiaí",
  "description": "NONONON NONONON NONONON",
  "isPrivate": false,
  "syncToMarketplaces": false,
  "photos": [
    "http://www.yourdomain.com/photo1.jpg",
    "http://www.yourdomain.com/photo2.jpg",
    "http://www.yourdomain.com/photo3.jpg",
    "http://www.yourdomain.com/photo4.jpg"
  ],
  "specifications": [
    {
      "name": "numero-de-serie",
      "value": "ABC1234"
    },
    {
      "name": "ano-fabricacao",
      "value": "2012"
    }
  ],
  "links": [
    {
      "href": "https://www.mercadomaquinas.com.br/anuncio/1-test-ad-permalink-slug",
      "rel": "ad",
      "type": "GET"
    },
    {
      "href": "https://api.mercadomaquinas.com.br/v1/ads/1",
      "rel": "ad api",
      "type": "GET"
    }
  ]
}

text/html

{"adId":1,"referenceCode":"XXXX0123456","type":"Venda","contractId":1,"category":"Escavadeira","make":"Case","model":"CX220","serialNumber":"ABC123456","year":2012,"price":100000,"state":"SP","city":"Jundiaí","description":"NONONON NONONON NONONON","isPrivate":false,"syncToMarketplaces":false,"photos":["http://www.yourdomain.com/photo1.jpg","http://www.yourdomain.com/photo2.jpg","http://www.yourdomain.com/photo3.jpg","http://www.yourdomain.com/photo4.jpg"],"specifications":[{"name":"numero-de-serie","value":"ABC1234"},{"name":"ano-fabricacao","value":"2012"}],"links":[{"href":"https://www.mercadomaquinas.com.br/anuncio/1-test-ad-permalink-slug","rel":"ad","type":"GET"},{"href":"https://api.mercadomaquinas.com.br/v1/ads/1","rel":"ad api","type":"GET"}]}