BETA

The publication key

The property object describes the real estate. publication describes how you publish it: which account you use on each portal and what you chose for that listing.

They are two different things and that is why they are separate. The square meters of an apartment are the same wherever you publish; the plan you contracted on Zonaprop is not.

It is in beta. This key is where publishing capabilities get enabled, so it will grow: new portals, new fields, new channels. What is already documented here does not change meaning without notice.

Where it goes

Inside the property object, as one more key:

{
  "code": "DEV-V3-909181",
  "title": "…",
  "attributes": [ … ],
  "publication": { "api": { … } }
}

It travels the same way on creation and on verification — it is the same object in both cases.

The shape

{
  "publication": {
    "api": {
      "argenprop": {
        "visible": true,
        "token": "<tu-token-de-argenprop>"
      },
      "zonaprop": {
        "plan": {
          "plan": "SUPERDESTACADO"
        },
        "token": "<tu-token-de-zonaprop>"
      },
      "cabaprop": {
        "token": "<tu-token-de-cabaprop>"
      },
      "mercadolibre": {
        "listingTypeId": "gold_special",
        "condition": "used",
        "token": "<tu-token-de-mercadolibre>"
      }
    }
  }
}

The sample does not carry advertiserId or branchOfficeId, and that is not an omission: they are the id the portal assigned to your client, so any example value would belong to a different account. If you leave them out, we resolve them from your client's connection — which is the right value unless you manage several accounts with one integrator. They are still accepted: see the table below.

The two levels

publication
└── api            ← publishing through the portal's API
    └── <portal>

The api level is not decorative: a portal can be published through more than one channel. Zonaprop, for example, supports publishing through an API and through an XML feed, and each channel has its own contract. Separating it from the start allows adding the other channel without changing the shape of what already works.

Today only api is enabled. Any other key at that level is rejected: it is not "not supported yet", it is unknown.

What each portal accepts

PortalFieldTypeWhat it is
argenpropadvertiserIdnumberYour client's advertiser id on Argenprop👤
visiblebooleanWhether the listing is published visible
zonapropplanobjectThe publishing plan, for example {"plan": "SUPERDESTACADO"}
branchobjectThe branch's contact details: {custId, email, name, phone1}. No longer needed — see below👤
cabapropbranchOfficeIdnumberYour client's branch (licensed agent) on Cabaprop👤
mercadolibrelistingTypeIdstringThe listing type
conditionstringThe property's condition
sellerContactobjectThe seller's contact details. No longer needed — see below👤
manualAttributesobjectMercadoLibre attributes you send by their id, for example {"LAND_ACCESS": "245046"}. They override whatever we derive from the property

👤 = a datum of your client's account on the portal. The rest are publishing choices: their value comes from a catalog and is the same for every account. The difference shows up in two places — in the sample above (the 👤 ones are not there) and in the errors (they do not hand you an example value).

All of them also accept a token (string), which is the one for your account on that portal.

Five MercadoLibre categories require an attribute that does not come from the property. The four short-term rental ones (MLA50278, MLA50279, MLA105180, MLA52745) require GUESTS, which we take from occupancy when the property carries it. And MLA401687 (Land and Lots for sale) requires LAND_ACCESS, which has no equivalent in the object: that one you send yourself.

{
  "mercadolibre": { "manualAttributes": { "LAND_ACCESS": "245046" } }
}

The five LAND_ACCESS values are 245049 Tierra, 245045 Arena, 245046 Asfalto, 245048 Ripio and 245047 Otro.

If an attribute is required in the category and arrives neither from the property nor from manualAttributes, /verify returns it as a blocker with its id — so you know which one to fill in before publishing.

You no longer need to send branch and sellerContact. They are your client's contact details written in each portal's vocabulary, and we now fill them in ourselves from your client's record, which you declare once and does not travel on every property.

If you send them anyway, yours win: the auto-fill has the lowest precedence of all.

Their shape, if you do want to send them:

{
  "zonaprop": { "branch": { "custId": 1, "name": "…", "phone1": "…", "email": "…" } },
  "mercadolibre": { "sellerContact": { "phone": "…", "email": "…" } }
}

advertiserId and branchOfficeId are still needed: they are not your client's details but ids inside the portal — your advertiser on Argenprop, your registered agent on Cabaprop — and only your account there knows them.

You do not need to send every portal. Send the ones you are going to use; what is not there simply is not configured.

About the token

The token is validated for shape and never for validity. Us accepting it does not mean it is correct or that your account exists: only that it is a non-empty string. This endpoint verifies properties, not accounts.

And on the other side: your token's value does not appear in any response. If there is a problem with it, we tell you which key it is (publication.api.zonaprop.token) and never what it contains. It is not stored with the object either, nor forwarded anywhere that does not need it.

What happens if you send something that does not belong

The shape is validated, and whatever does not comply shows up in two ways at once in the verify response:

  1. In object.contract, with the full path, the rule and an example of how to fix it.
  2. As a blocker on the affected portal, which turns to missing_data.
CaseWhat it reportsThe example it gives you
Wrong type, choice fieldse espera boolean"publication": { "api": { "argenprop": { "visible": true } } }
Wrong type, account field (👤)se espera number + where the real value comes fromnone, on purpose — any number would belong to a different account
Portal that does not existportal desconocido. Válidos: …one of the valid ones
Field that portal does not acceptno es un dato de cuenta/publicación reconocido…the list of the ones it does accept
A level other than apisólo admite api"publication": { "api": { … } }
Empty tokense espera un string no vacío"token": "<tu-token-de-argenprop>"
{ "field": "publication.api.argenprop.advertiserId",
  "rule": "type",
  "value": "noventa",
  "detail": "se espera number. el valor de `advertiserId` es el que el portal le asignó a TU CLIENTE: no hay ejemplo que sirva. Si lo omitís lo resolvemos desde su conexión, que es lo correcto salvo que administres varias cuentas." }

And the same error on a choice field, which does carry the fix ready to paste:

{ "field": "publication.api.argenprop.visible",
  "rule": "type",
  "value": "si",
  "detail": "se espera boolean",
  "fix": "\"publication\": { \"api\": { \"argenprop\": { \"visible\": true } } }" }

A broken publication blocks publishing on that portal, even if the property object is flawless. And it blocks only the portal it names: if the problem is in publication.api.argenprop, Zonaprop and Cabaprop carry on. Top-level problems —the whole publication, or a level other than api— affect all of them.

It is on purpose: a mistyped advertiserId is not an incomplete property, it is a broken publishing instruction — and publishing with it is the damage.

Nothing is cleaned up silently and we do not guess what you meant. If it does not comply, we tell you, and we tell you how to fix it.

Declaring a portal is asking us to report it

The verify response brings only the portals you declared here. If you configured Argenprop and nothing else, Zonaprop does not show up — neither with problems nor in the summary.

If you do not send publication, you see all of them: that is the case of someone evaluating the integration.

publication is not a field of the property

It is not stored with the real estate and it does not travel to the portals as listing data. It is consumed to configure the publishing and then discarded.

That is also why you will not see it in the property we return to you: it is not part of it.

See also


Do you need help? Contact Mapaprop technical support