Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

source
string
requerido

El origen de etiquetas al que corresponde la plantilla: receipt, build o stock.

Cuerpo

application/json

Lo que una organización define en una plantilla de etiqueta. Las zonas, su orden y significado, el sigilo, el formato de fecha y el ID de pieza no son configuraciones.

header
enum<string>
requerido

Lo que dice la línea de encabezado: organization para el nombre de la organización, u organization_site para agregar el sitio para el que se imprimen las etiquetas.

Opciones disponibles:
organization,
organization_site
tile_fallback
enum<string>
requerido

Lo que muestra el mosaico de familia para un artículo sin familia: sku muestra el primer segmento de su SKU, name las primeras letras de su nombre y text el tile_text.

Opciones disponibles:
sku,
name,
text
source_detail
enum<string>
requerido

Qué muestra la zona de origen debajo del proveedor o la línea: record para lo que da el registro, supplier_lot, routing_revision o custom_field.

Opciones disponibles:
record,
supplier_lot,
routing_revision,
custom_field
dpi
enum<integer>
requerido

La resolución de la impresora en puntos por pulgada: 203 o 300.

Opciones disponibles:
203,
300
tile_text
string | null

El texto del mosaico, de hasta 6 caracteres. Es obligatorio cuando tile_fallback es text.

Maximum string length: 6
date_kind
enum<string> | null

La fecha fija que llena la franja de fechas: expires, use_by, made, received o released. Con null se imprime la fecha que da el registro. Cuando el registro no tiene la fecha elegida, se imprime la fecha propia del registro.

Opciones disponibles:
expires,
use_by,
made,
received,
released
source_detail_field
string | null

La clave del campo personalizado que se muestra, de hasta 64 caracteres. Es obligatoria cuando source_detail es custom_field.

Maximum string length: 64
orientation
enum<string>

Solo para vistas previas, cómo se diseña la etiqueta: portrait (el valor predeterminado) o landscape.

Opciones disponibles:
portrait,
landscape

Respuesta

La etiqueta como SVG.

The response is of type string.