# Objects (https://docs.loybox.com.ar/en/api-reference/objetos) This page is the API's dictionary: every object that shows up in a response, with all of its fields. Endpoint pages link here instead of repeating the lists. ## The three codes First of all, this: the API handles three similar-looking identifiers, and mixing them up is the most common mistake when integrating. | Code | What it identifies | Where it is used | | --------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `client_code` | A **member**. It is the number every person registered in Loybox has. | [Recording a consumption](https://docs.loybox.com.ar/api-reference/consumos/crear-por-codigo), [looking up a client](https://docs.loybox.com.ar/api-reference/clientes/obtener) | | `benefit_id` | A **catalog benefit**, the one the commerce created. | [Looking up a benefit](https://docs.loybox.com.ar/api-reference/beneficios/obtener), [buying it](https://docs.loybox.com.ar/api-reference/mi-cuenta/comprar-beneficio) | | `client_benefit_code` | A benefit **already bought** by a specific member. | [Looking up the code](https://docs.loybox.com.ar/api-reference/beneficios/consultar-codigo), [redeeming it](https://docs.loybox.com.ar/api-reference/beneficios/canjear) | The commerce creates **benefits**, and each one has a `benefit_id`. When a member buys one with their points they receive a **redeemable benefit** with its own `client_benefit_code`. The `benefit_id` is only good for looking up information. The `client_benefit_code` is good for looking up **and for redeeming**: it is the code the member presents in the store, or pastes at the online store's checkout. ## Client Appears in [listing clients](https://docs.loybox.com.ar/api-reference/clientes/listar) and [looking up a client](https://docs.loybox.com.ar/api-reference/clientes/obtener). The member's code. The member's name. The member's email. Points they hold at the commerce. ## Benefit The catalog benefit. Appears in almost every response of [Benefits](https://docs.loybox.com.ar/api-reference/beneficios), [Clients](https://docs.loybox.com.ar/api-reference/clientes), [My account](https://docs.loybox.com.ar/api-reference/mi-cuenta) and [Public](https://docs.loybox.com.ar/api-reference/publico). The `benefit_id`. What kind of reward it is: `percentage_discount`, `absolute_discount` or `free_product`. Description of the benefit. How many points it costs to buy. How long it stays valid. `null` if it does not expire. `normal` for catalog ones; `welcome`, `birthday`, `monthly_top` or `level` for the automatic rewards. Defaults to `normal`. The commerce's brand color, in hexadecimal. Total number of redemptions allowed for this benefit. `0` means no limit. The reward's detail. See [Prize](#premio). The coupon, if the benefit applies in a Tiendanube store. See [Tiendanube coupon](#cupón-de-tiendanube). ### Benefit (v2) [`GET /v2/benefits/preview/{client_benefit_code}`](https://docs.loybox.com.ar/api-reference/beneficios/consultar-codigo-v2) returns a version with three extra fields, which save you from digging into `prize` for the basics: The benefit's title. In v1 it only lived inside `prize`. The discount's value: the percentage if it is `percentage_discount`, the amount if it is `absolute_discount`. The product, if it is `free_product`. See [Product](#producto). Every other field is the same as in [Benefit](#beneficio). ## Redeemable benefit A benefit a member already bought. Appears in [purchased benefits](https://docs.loybox.com.ar/api-reference/clientes/beneficios-comprados), [my benefits](https://docs.loybox.com.ar/api-reference/mi-cuenta/mis-beneficios) and as the response of [buying a benefit](https://docs.loybox.com.ar/api-reference/mi-cuenta/comprar-beneficio). The redemption code. It is what the member presents at the commerce, and also the coupon code in an online store. When they bought it. How long they have to redeem it. `null` if it does not expire. Whether it was already redeemed. Defaults to `false`. The benefit bought. See [Benefit](#beneficio). ## Prize The detail of what the member wins. It lives inside `prize`. `percentage_discount`, `absolute_discount` or `free_product`. The reward's title. The reward's description. The discount's percentage or amount, depending on the `type`. The gift product. See [Product](#producto). The reward's expiration. URL of the reward's image. ## Product The product's id in Loybox. The product's name. The product's id in the commerce's own system. ## Commerce The program's branding data. Appears in [commerce data](https://docs.loybox.com.ar/api-reference/publico/comercio) and inside [my account](https://docs.loybox.com.ar/api-reference/mi-cuenta/obtener). The `commerce_id`, the same one that goes in the `X-Commerce-Id` header. The commerce's name. URL of the logo. Brand color in hexadecimal, for the program's UI. The commerce's category, for example `Tienda de comics`. The commerce's currency. ## My account The response of [`GET /v1/me`](https://docs.loybox.com.ar/api-reference/mi-cuenta/obtener). The user's name. The user's email. The user's phone. The user's points at this commerce. Defaults to `0`. Whether the user is subscribed to this commerce's program. Defaults to `false`. The commerce's data, to paint the program's branding. See [Commerce](#comercio). Points about to expire. See [Points expiration](#vencimiento-de-puntos). ## Points expiration Points about to expire. Defaults to `0`. When they expire. Days remaining. Months remaining. How points expire at this commerce: `none`, `rolling` or `accumulated`. `none` means they do not expire. If the commerce does not expire points, the object comes back with `mode: "none"` and `points: 0`, not as `null`. See [Point expiration](https://docs.loybox.com.ar/puntos-y-premios/expiracion) for the detail of the modes. ## Tier The response of [`GET /v1/me/level`](https://docs.loybox.com.ar/api-reference/mi-cuenta/nivel). The endpoint and its fields say `level`; this documentation says "tier", which is the product's term in English. It is the same thing. The tier's name. The tier's position in the ladder. The points multiplier the tier grants. URL of the tier's icon. When they reached the tier. When the tier expires. Whether the tier already expired. The next tier and what is missing to reach it. See [Next tier](#próximo-nivel). Points earned in total, the lifetime accumulated figure. Amount spent in total. Number of consumptions recorded. ### Next tier The next tier's name. The next tier's position. What the threshold is measured in: accumulated points or amount spent. The threshold value to reach. ## Activity item Each item of [my history](https://docs.loybox.com.ar/api-reference/mi-cuenta/historial). What happened: `consumption` (a purchase that earned points), `benefit_exchange` (they bought a benefit with points), `benefit_usage` (they redeemed a benefit) or `points_special_reward` (an automatic reward gave them points). When it happened. Points the item added or subtracted. The benefit involved, on benefit items. See [Benefit](#beneficio). The purchase amount, on `consumption` items. The event that triggered the reward, on `points_special_reward` items. Additional note on the item. ## Automatic reward Each item of [program rewards](https://docs.loybox.com.ar/api-reference/mi-cuenta/recompensas). The event that triggers it: `welcome`, `birthday` or `monthly_top`. `benefit` if it delivers a benefit, `points` if it delivers points. The benefit it delivers, when `reward_type` is `benefit`. See [Benefit](#beneficio). The points it delivers, when `reward_type` is `points`. ## Session The response of [verifying the code](https://docs.loybox.com.ar/api-reference/autenticacion/verificar-codigo). Access token. Sent as `Authorization: Bearer {access}` on the My account endpoints. Refresh token, to get a new `access` without asking for another code. Seconds the access token stays valid. The user's id. The user's name. The user's email. The user's phone. ## Tiendanube coupon Lives inside `tiendanube_coupon` when the benefit applies in a [Tiendanube](https://docs.loybox.com.ar/integraciones/tiendanube) store. `percentage`, `absolute` or `shipping`. The coupon's value. Id of the Tiendanube category the coupon applies to. That category's name. How long the coupon is valid for. The product the coupon applies to, if it applies to a single one. See [Tiendanube product](#producto-de-tiendanube). ### Tiendanube product The product's id in Tiendanube. The product's name. URL of the product in the store. Whether it is in stock. Whether it is published in the store. The product's brand. The product's categories, each with `id` and `name`. Empty by default.