GET v1/ads/{adid}

Returns an ad using the id code.

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:

  1. O nome de usuário e a senha são combinadas em uma string "usuário:senha"
  2. A seqüência resultante literal é então codificado em Base64
  3. 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

  • OK (200)
  • 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.

NomeDescriçãoTipoInformações adicionais
adIdId code of an published ad.integerRequired

Parâmetros do corpo da requisição

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

Descrição não disponível.

Informações da Resposta

Descrição do recurso

AdResponse Returns an Ad

NomeDescriçãoTipoInformações adicionais
AdIdID code generated by the systeminteger
ReferenceCodeReference code provided by the advertiserstringRequired
TypeOffer type (Venda/Locação/Serviço)stringRequired
ContractIdAdvertiser current Contract IDintegerRequired
CategoryMachine/Equipment CategorystringRequired
MakeMachine/Equipment ManufacturerstringRequired
ModelMachine/Equipment ModelstringRequired
SerialNumberMachine/Equipment Serial Numberstring
YearYear of manufacture of the machine/equipment (ex. 1998)integer
PricePrice of Ad in Reais (ex. R$ 100.000,00 -> 100000). Only numbers.integer
StateState or Province of location (ex. SP)stringRequired
CityCity of location (ex. Jundiaí)stringRequired
DescriptionAd description (Ex.: pintura nova, pneus bons, cabinada, motor novo). It is forbidden to enter addresses of other sites, telephones and email.string
IsPrivateIndicates wheter the Ad is private (published only in EmEstoque)booleanRequired
SyncToMarketplacesIndicar se o anúncio deve ser Sincronizado com os Marketplaces disponíveis através do EmEstoqueboolean
PhotosList with photos links. Maximum of 4 photos.string arrayMax. Length: 4
SpecificationsList of the Ad SpecificationsNameValueItem array
LinksAd links listLink 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"}]}