-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
780 lines (629 loc) · 27.1 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
FORMAT: 1A
HOST: https://test.tuyoanalytics.com/
# Documentación Tuyo API
El presente documento explica y muestra ejemplos para la correcta utilización de la API de integración de Tuyo.
Para poder agregar productos a través de integración deberá consultar los endpoints que se mostrarán en esta referencia.
Antes de poder crear un producto debe de obtener el listado de categorías y subcategorías (ver la sección Obtener categorías y subcategorías).
A continuación mostramos los conceptos necesarios para poder efectuar una integración exitosa.
### API Key
Esto nos servirá de llave para obtener los insumos necesarios para efectuar la creación de Productos.
Los clientes pueden solicitar que se les brinde un API Key para producción y otra para testing.
### Timestamp
El timestamp como URI Param en cada petición nos servirá a verificar que el request se esta haciendo justo en el momento en que se consulta la API.
En JS se puede obtener:
```js
const timestamp = new Date().getTime();
// Ejemplo de uso en la construcción de la url del request
const request = `https://${API_URL}?timestamp=${timestamp}`;
```
> Si `timestamp` no se envía correctamente, se retorna el error `"Request is expired"`
### Tipos de Transporte
Ayudan a identificar que tipo de transporte debe utilizarse con los paquetes. Es importante especificarlos al crear el Producto con su repectivo tipo. A continuación se muestran los posibles tipos:
| Tipo | Descripción |
| ----------- | ---------------------------------------------------------------------------------- |
| Motocicleta | Productos con peso máximo de 50 lbs y dimensiones máximas de 50 cm x 50 cm x 50 cm |
| Liviano | Productos con peso máximo de 1700 lbs |
| Pesado | Productos con peso mayor a 1700 lbs |
### Tipo de Producto
Ayudan a clasificar el producto. Es importante especificarlos al crear el Producto con su respectivo tipo. A continuación se muestran los posibles tipos:
| ID | Tipo | Descripción |
|:--- | --------- | ---------------------------------- |
| 1 | Retail | Productos varios |
| 2 | Alimentos | Productos de consumo no preparados |
| 4 | Farmacia | Productos farmacéuticos |
### Códigos de Respuesta
Ayudan a clasificar las peticiones en exitosos o con error. A continuación se muestran los posibles tipos:
| Código | Tipo | Descripción |
|:--- | --------- | ---------------------------------- |
| 200 | Exitosa | La petición fue realizada exitosamente |
| 400 | Error | Error realizar la acción en el servidor |
| 401 | Error | Error al autorizar la petición |
| 403 | Error | La acción no está permitida |
| 404 | Error | El recurso o el endpoint no esta disponible |
| 409 | Error | Error en el envío de datos |
| 500 | Error | Error interno del servidor |
## Categorías y subcategorías [/api/get_categories{?timestamp}]
### Obtener categorías y subcategorías [GET]
Estructura de la respuesta
| Campo | Tipo de Dato | Descripción |
| :------------------------------------ | :----------- | :------------------------- |
| productsCategoriesId | Integer | ID |
| name | String | Nombre |
| fk_productsTypesId | Integer | ID tipo de producto |
| subcategories | Object[] | Colección de subcategorias |
| subcategories.productsSubcategoriesId | Integer | ID de subcategoría |
| subcategories.name | Integer | Nombre de subcategoría |
+ Parameters
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request
+ Headers
x-api-token: {API_KEY}
+ Response 200 (application/json)
[
{
"productsCategoriesId": 1,
"name": "Ropa",
"fk_productsTypesId": 1,
"subcategories": [
"productsSubcategoriesId": 1,
"name": "Dama"
]
},
{
"productsCategoriesId": 2,
"name": "Zapatos",
"fk_productsTypesId": 1,
"subcategories": [
"productsSubcategoriesId": 3,
"name": "Deportivos"
]
}
]
## Ordenes [/api/update_order/{sku}{?timestamp}]
### Actualizar estados (Sólo para productos únicos*) [PATCH]
Listado de estados de la orden
| Estado | Descripción |
| ------- | --------------------------- |
| Empaque | Proceso de picking (feedback como Orden Aceptada) |
| Ruta | En proceso de entrega (feedback como Listo de Recolección) |
| Cancelada | Orden Cancelada |
> *Productos únicos: Productos con una unidad en stock que nunca se vuelven a vender
+ Parameters
+ sku: `L01936657` (required, string) - SKU del producto
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request
+ Headers
x-api-token: {API_KEY}
+ Body
{
"status": "Empaque"
}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": " Order updated!",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
### Actualizar estados (Sólo para productos con variantes) [PATCH /api/change_order/{code}{?timestamp}]
Listado de estados de la orden
| Estado | Descripción |
| ------- | --------------------------- |
| Empaque | Proceso de picking (feedback como Orden Aceptada) |
| Ruta | En proceso de entrega (feedback como Listo de Recolección) |
| Cancelada | Orden Cancelada |
+ Parameters
+ code: `E08833` (required, string) - codigo de la orden
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request
+ Headers
x-api-token: {API_KEY}
+ Body
{
"status": "Empaque"
}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": " Order updated!",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
## Productos [/api]
### Crear productos [POST /api/create_products{?timestamp}]
Tomar en cuenta que deberá especificar los siguientes datos:
- Tipo de transporte
- ID de tipo de producto
- ID de categoría obtenido en el endpoint de categorías.
- ID de subcategorías obtenido en el endpoint de categorías.
- ID de tienda proporcionado por Tuyo
- ID de sucursal proporcionado por Tuyo
- ID de usuario proporcionado por Tuyo
- Tiempo de preparación
Estructura del body
| Requerido | Campo | Tipo de Dato | Descripción |
|:----: | ------------------------- |:------------ |:------------------------------------------------ |
| si | sku | String | SKU del producto (max 20 caracteres) |
| si | name | String | Nombre del producto |
| si | preparationTime | Number | Tiempo en que se tardará el producto en ser recogido en milisegundos (86400000 = 1 dia) |
| si | description | String | Descripción breve |
| si | regularPrice | Double | Precio sin descuento |
| si | hasVariant | Boolean | Tiene variante? (true/false) |
| si | freeShipping | Boolean | Tiene envio gratis? (true/false) |
| si | cargoType | String | Tipo Transaporte (Motocicleta, Liviano y Pesado) |
| si | isFragile | Boolean | Producto Fragil? (true/false) |
| no | discount | Integer | Descuento (40% = 40) |
| si | fk_usersId | Integer | ID de usuario |
| si | fk_storesId | Integer | ID de tienda |
| si | fk_categoriesId | Integer | ID de Categoría |
| si | fk_subcategoriesId | Integer | ID de Subcategoría |
| si | fk_productsTypesId | Integer | ID de Tipo de Producto |
| si | createdBy | Integer | ID de creador (ID de usuario) |
| no | tags | String | Etiquetas o Palabras Claves (separadas por coma) |
| si | active | String | Producto activo? (0 = No, 1 = Si) |
| si | images | Object[] | Colección de Imágenes |
| si | images.url | String | URL de Imagen |
| si | images.createdBy | Integer | ID de creador (ID de usuario) |
| si | variants | Object[] | Colección de Variantes |
| si | variants.sku | String | SKU de Variante |
| no | variants.image | String | URL de Imagen de Variante |
| si | variants.price | Double | Precio de Variante |
| no | variants.discount | Integer | Descuento de Variante |
| si | variants.attributes | String | Atributos de Variante |
| si | variants.values | String | Valores de atributos de Variante |
| si | variants.createdBy | Integer | ID de creador (ID de usuario) |
| si | variants.stock | Object[] | Colección de Stock |
| si | variants.stock.stock | Integer | Valor del Stock |
| si | variants.stock.fk_storesBranchesId | Integer | ID de sucursal |
| si | variants.stock.createdBy | Integer | ID de creador (ID de usuario) |
+ Parameters
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request (application/json)
+ Body
[
{
"preparationTime": 86400000,
"name": "Nike AIR Ultra comfort",
"hasVariant": false,
"fk_categoriesId": 10,
"fk_subcategoriesId": 81,
"sku": "32G4HJ32G4",
"regularPrice": 85.99,
"discount": 0,
"cargoType": "Motocicleta",
"freeShipping": false,
"isFragile": false,
"description": "Description ultra comfortable shoes",
"fk_usersId": 16890,
"tags": "Tag01,Tag02,Tag03",
"active": "1",
"createdBy": 16890,
"fk_storesId": 362,
"fk_productsTypesId": 1,
"images": [
{
"url": "https://tuyomedia.s3.us-east-2.amazonaws.com/misc/empty.jpg",
"createdBy": 16890
}
],
"variants": [
{
"attributes": "Tipo",
"values": "Unico",
"sku": "32G4HJ32G4",
"price": 85.99,
"discount": 0,
"image": "https://tuyomedia.s3.us-east-2.amazonaws.com/misc/empty.jpg",
"createdBy": 16890,
"stock": [
{
"stock": 1,
"fk_storesBranchesId": 428,
"createdBy": 16890
}
]
}
]
}
]
+ Headers
x-api-token: {API_KEY}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": "Productos creados satisfactoriamente",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
+ Request (application/json)
+ Body
[
{
"preparationTime": 86400000,
"name": "Nike AIR Ultra comfort",
"hasVariant": false,
"fk_categoriesId": 10,
"fk_subcategoriesId": 81,
"sku": "32G4HJ32G4",
"regularPrice": 85.99,
"discount": 0,
"cargoType": "Motocicleta",
"freeShipping": false,
"isFragile": false,
"description": "Description ultra comfortable shoes",
"fk_usersId": 16890,
"tags": "Tag01,Tag02,Tag03",
"active": "1",
"createdBy": 16890,
"fk_storesId": 362,
"fk_productsTypesId": 1,
"images": [
{
"url": "https://tuyomedia.s3.us-east-2.amazonaws.com/misc/empty.jpg",
"createdBy": 16890
}
],
"variants": [
{
"attributes": "Talla,Color",
"values": "8,Negro",
"sku": "32G4HJ32G4N",
"price": 85.99,
"discount": 0,
"image": "https://tuyomedia.s3.us-east-2.amazonaws.com/misc/empty.jpg",
"createdBy": 16890,
"stock": [
{
"stock": 5,
"fk_storesBranchesId": 428,
"createdBy": 16890
}
]
},
{
"attributes": "Talla,Color",
"values": "8,Blanco",
"sku": "32G4HJ32G4B",
"price": 85.99,
"discount": 0,
"image": "https://tuyomedia.s3.us-east-2.amazonaws.com/misc/empty.jpg",
"createdBy": 16890,
"stock": [
{
"stock": 3,
"fk_storesBranchesId": 428,
"createdBy": 16890
}
]
}
]
}
]
+ Headers
x-api-token: {API_KEY}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": "Productos creados satisfactoriamente",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
### Actualizar un producto [PATCH /api/update_product/{sku}{?timestamp}]
Método para actualizar el estado o stock del producto o variante
Estructura del body
| Campo | Tipo de Dato | Descripción |
|--------|---------|----------------------------|
| active | Boolean | Estado que se actualizara (true = activo) |
| stock | Number | Cantidad de inventario disponible |
| values | String | Valores de la variante |
> * Si no se envía `stock` ni `values`, el producto se desactiva/activa
> * Si no se envía `stock`, se desactiva/activa la variante específica
> * Si no se envía `active` ni `values`, el stock se aplica a **todas** las variantes
> * Si no se envía `active`, el stock se aplica a sóla a la variante específica
+ Parameters
+ sku: `L01936657` (required, string) - SKU del producto
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request (application/json)
+ Headers
x-api-token: {API_KEY}
+ Body
{
"active": true
}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": "Product & Stock updated!",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
+ Response 404 (application/json)
+ Body
{
"status": 404,
"response": "Product not found",
}
+ Response 409 (application/json)
+ Body
{
"status": 409,
"response": "Status is missing",
}
### Actualizar varios productos [PATCH /api/bulk_update{?timestamp}]
Estructura del body
| Requerido | Campo | Tipo de Dato | Descripción |
|:----: | ------------------------- |:------------ |:------------------------------------------------ |
| si | sku | String | SKU del producto (max 20 caracteres) |
| no | name | String | Nombre del producto |
| no | preparationTime | Number | Tiempo en que se tardará el producto en ser recogido en milisegundos (86400000 = 1 dia) |
| no | description | String | Descripción breve |
| no | regularPrice | Double | Precio sin descuento |
| no | cargoType | String | Tipo Transaporte (Motocicleta, Liviano y Pesado) |
| no | discount | Integer | Descuento (40% = 40) |
| no | isFragile | Boolean | Producto Fragil? (true/false) |
| no | fk_categoriesId | Integer | ID de Categoría |
| no | fk_subcategoriesId | Integer | ID de Subcategoría |
| no | fk_productsTypesId | Integer | ID de Tipo de Producto |
| no | tags | String | Etiquetas o Palabras Claves (separadas por coma) |
| no | active | String | Producto activo? (0 = No, 1 = Si) |
| no | stock | Integer | Valor del Stock (no enviarlo si se envian variantes) |
| no | variants | Object[] | Colección de Variantes (no requerido si no hay variantes) |
| no | variants.image | String | URL de Imagen de Variante |
| no | variants.price | Double | Precio de Variante |
| no | variants.discount | Integer | Descuento de Variante |
| no | variants.attributes | String | Atributos de Variante |
| no | variants.values | String | Valores de atributos de Variante |
| no | variants.stock | Integer | Valor del Stock |
+ Parameters
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request (application/json)
+ Body
[
{
"preparationTime": 86400000,
"name": "Nike AIR Ultra comfort",
"fk_categoriesId": 10,
"fk_subcategoriesId": 81,
"sku": "32G4HJ32G4",
"regularPrice": 85.99,
"discount": 0,
"cargoType": "Motocicleta",
"isFragile": false,
"description": "Description ultra comfortable shoes",
"tags": "Tag01,Tag02,Tag03",
"active": "1",
"fk_productsTypesId": 1,
"stock": 1,
}
]
+ Headers
x-api-token: {API_KEY}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": "1 Productos actualizados & 1 Stock actualizado",
"erroredProducts": []
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
+ Response 409 (application/json)
+ Body
{
"status": 409,
"response": "Mensaje del error",
}
### Activar/Desactivar varios productos [POST /api/update_product{?timestamp}]
Estructura del body
| Campo | Tipo de Dato | Descripción |
|--------|---------|----------------------------|
| active | Boolean | Estado que se actualizara |
| sku | Object | Colección de SKUs que serán afectados |
+ Parameters
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request (application/json)
+ Headers
x-api-token: {API_KEY}
+ Body
{
"active": false,
"sku": [
"L01936657",
"L01936656",
"L01936655",
"L01936654"
]
}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": "4 Products updated!",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
+ Response 404 (application/json)
+ Body
{
"status": 404,
"response": "Product not found",
}
+ Response 409 (application/json)
+ Body
{
"status": 409,
"response": "Status is missing",
}
### Actualizar descuentos [POST /api/set_promo{?timestamp}]
Estructura del body
| Requerido | Campo | Tipo de Dato | Descripción |
|--------|--------|---------|----------------------------|
| Sí | discount | Number | Valor del descuento que se aplicará |
| No | subcategories | Number; Number[] | ID o Colección de IDs de Subcategorías |
| No | categories | Number; Number[] | ID o Colección de IDs de Categorías |
> - Si `categories` y `subcategories` no se envían, el descuento es aplicado a todos los productos de la tienda.
> - Si `subcategories` no se envía, el descuento es aplicado a todos los productos de la(s) categoría(s).
> - Si `categories` no se envía, el descuento es aplicado a todos los productos de la(s) subcategoría(s) si ésta(s) existe(n).
+ Parameters
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request (application/json)
+ Headers
x-api-token: {API_KEY}
+ Body
{
"discount": 20,
"categories": 15,
"subcategories": [42, 43]
}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": " 30 Products updated!",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
+ Response 404 (application/json)
+ Body
{
"status": 404,
"response": "Product not found",
}
+ Response 409 (application/json)
+ Body
{
"status": 409,
"response": "Discount is missing",
}
### Eliminar productos (sólo en Testing) [DELETE /api/delete_products/{sku}{?timestamp}]
Estructura del body (opcional)
| Requerido | Campo | Tipo de Dato | Descripción |
|--------|--------|---------|----------------------------|
| No | sku | String; String[] | SKU o Colección de SKU de los productos a eliminar |
> - Si se envía el `sku` como BODY, no es necesario enviar el SKU como parametro de ruta.
> - Si `sku` no se envían, se eliminan todos los productos de la tienda.
+ Parameters
+ sku: `L01936657` (optional, string) - SKU del producto que se desea borrar
+ timestamp: `1656461076` (required, number) - Tiempo actual en que se ejecuta el request
+ Request (application/json)
+ Headers
x-api-token: {API_KEY}
+ Body
{
"sku": "L01936657"
}
+ Response 200 (application/json)
+ Body
{
"status": 200,
"response": " 30 Products deleted!",
}
+ Response 400 (application/json)
+ Body
{
"status": 400,
"response": "Mensaje del error",
}
+ Response 401 (application/json)
+ Body
{
"status": 401,
"response": "Unauthorized",
}
+ Response 404 (application/json)
+ Body
{
"status": 404,
"response": "Product not found",
}
+ Response 409 (application/json)
+ Body
{
"status": 409,
"response": "Discount is missing",
}