Crear promoción
Crea una promoción con código: un código que envías tú o que Yuno construye a partir de tu prefijo, un descuento, un rango de fechas, las condiciones que debe cumplir un pago y, opcionalmente, el máximo de usos.
Qué necesita la solicitud
- La cuenta se toma del encabezado
X-Account-Code. La promoción pertenece a esa cuenta. Un cuerpo que incluyaaccount_idse rechaza con400 INVALID_PARAMETERS, y también un cuerpo que repitaredemptiono alguno de sus miembros (los nombres se comparan sin distinguir mayúsculas de minúsculas). X-Idempotency-Keyes obligatorio. Es cualquier texto de 1 a 64 caracteres. La misma clave en la misma cuenta devuelve la primera promoción con201, y Yuno no compara el cuerpo. Una solicitud sin una clave válida se rechaza con400antes de leer el cuerpo.redemption.modeesCODEy envías exactamente uno deredemption.codeyredemption.prefix. Si no envías ninguno, la respuesta es400 INVALID_REQUESTconredemption: CODE_OR_PREFIX_REQUIRED, y si envías ambos, la respuesta esredemption: CODE_AND_PREFIX_EXCLUSIVE. Cada respuesta agrega el mensajeSend exactly one of redemption.code or redemption.prefix.. Unnull, un texto vacío y un texto con solo espacios cuentan como no enviados. Unredemption.codeque no es válido, enviado junto con un prefijo, cuenta como ambos.- Un código que envías tiene de 3 a 32 caracteres: letras, dígitos,
_y-, en mayúsculas o minúsculas. Yuno recorta los espacios alrededor y lo guarda en mayúsculas. Un código con un carácter fuera de ese conjunto responderedemption.code: CODE_CHARACTERS, y uno de longitud incorrecta responderedemption.code: CODE_LENGTH. - Un prefijo construye el código. El prefijo tiene de 1 a 8 letras o dígitos (
A-Z,a-z,0-9). Yuno lo convierte a mayúsculas y construye el código con el prefijo y un sufijo aleatorio de 5 caracteres deA-Zy2-9, sin0,O,1,IyL. Por ejemplo, el prefijoSUMMERpuede darSUMMERK7P2X. El201muestra el código enredemption.code. Un carácter fuera deA-Z,a-zy0-9responderedemption.prefix: FORMAT, y más de 8 caracteres responderedemption.prefix: LENGTH. Yuno nunca construye un código que ya tenga otra promoción de tu cuenta, sin importar su estado. Una creación con prefijo nunca responde409 CODE_ALREADY_EXISTS. La mismaX-Idempotency-Keydevuelve la misma promoción con el mismo código. Si Yuno no puede construir un código, la creación falla con500 INTERNAL_ERRORy Yuno no guarda nada: reintenta la solicitud. - Un código es único por cuenta. Otra promoción de la cuenta que no esté deshabilitada, con un calendario que se superponga al de la nueva, no puede tener el mismo código, y ningún código de lote de la cuenta puede tenerlo tampoco: la solicitud responde
409 CODE_ALREADY_EXISTS. Un código vuelve a estar libre cuando la promoción anterior se deshabilita, o cuando su calendario termina en el momento de inicio de la nueva o antes. - Las condiciones son
countriesyamounts. Un código se aplica a todo el pago, sin importar el método de pago. Una condiciónbins,payment_methodsocard_typesresponde400 INVALID_REQUESTconconditions.bins: FORBIDDEN,conditions.payment_methods: FORBIDDENoconditions.card_types: FORBIDDEN. limits.totales opcional. Es el máximo de usos que acepta el código, un número entero de 1 a 2147483647. Una promoción sinlimitsno tiene tope, y su respuesta muestralimits: null. Yuno cuenta un uso cuando un pago toma el código. Consulta Usos y límites.- El cuerpo pesa como máximo 256 KiB. Un cuerpo más grande responde
413 REQUEST_ENTITY_TOO_LARGE.
Qué contiene la respuesta
201 devuelve la promoción, tal como la describe El objeto Promotion, con status calculado a partir de schedule y con limits.used en 0. Todos los miembros están presentes, con null para un valor ausente. redemption.code contiene el código, ya sea el que enviaste o el que Yuno construyó a partir de tu prefijo.
Existen dos tipos de 400. INVALID_PARAMETERS proviene de las comprobaciones que Yuno hace antes de leer la promoción: los encabezados, account_id, redemption.mode. INVALID_REQUEST proviene de las reglas de la promoción en sí, con un mensaje path: RULE por cada ruta que falla, en el orden de las comprobaciones. Códigos de error de Promotion los enumera.Authorizations
Headers
The account_id found in your Yuno Dashboard (UUID). Required. A promotion belongs to one account, and this header names it. Omitting it returns 400 INVALID_PARAMETERS ("x-account-code header is required.").
Body
The conditions a payment must meet. AND across keys, OR inside each key's values list. A code applies to the whole payment, whatever the payment method, so only countries and amounts are accepted. A bins, payment_methods or card_types condition returns 400 INVALID_REQUEST with the messages conditions.bins: FORBIDDEN, conditions.payment_methods: FORBIDDEN or conditions.card_types: FORBIDDEN.
Response
- The promotion. The same answer returns when the account repeats the
X-Idempotency-Key.
A promotion. Every member is present, with null for an absent value.