-
Notifications
You must be signed in to change notification settings - Fork 1
/
apiary.apib
16625 lines (15418 loc) · 774 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
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
FORMAT: 1A
HOST: https://sandbox.e-com.plus/v1/
# E-Com Plus Store API
[E-Com Plus](https://www.e-com.plus)
is a robust and flexible cloud commerce software,
totally based on REST APIs, providing a large library of methods and specifications
to deploy any digital commerce operation easly
**Store API** is the hearth of our software, a REST interface to the
[MongoDB](https://www.mongodb.com/) stores database,
given full access to all store data, so be creative, but be careful too
_With great power comes great responsibility_, _may the force be with you_!
## Overview
This API tries to be truly *RESTful*, following Web API Standards, taking as specifications references:
- https://github.com/WhiteHouse/api-standards
- https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
### Host
Should be accessed from `https://api.e-com.plus/{version}/`
Current version: **v1**
https://api.e-com.plus/v1/
Note that every request must be with `https` (SSL)
All endpoints will end with `.json`:
https://api.e-com.plus/v1/example.json
### Sandbox
Sandbox environment is available at `https://sandbox.e-com.plus/{version}/`,
must be used for tests only, after homologation you should migrate to
[production](#introduction/overview/host)
Current version and formats will always be the same of
[production environment](#introduction/overview/host)
**All data in the sandbox environment is deleted after 7 days**
This documentation uses sandbox by reference on the examples
### Format
Both request and response body are formatted as JSON, always an object `{}`
#### Object Modeling
Based on [JSON Schema](http://json-schema.org/) Draft-06 specifications
API uses JSON Schema
[built-in string formats](https://spacetelescope.github.io/understanding-json-schema/reference/string.html#built-in-formats)
and [Regular Expressions](https://regexr.com/) (RegEx) to validate string fields on body
For example purposes, you can generate random objects with the schemas using
[JSON Schema Faker](http://json-schema-faker.js.org/)
#### List Of Documents
At root of a resource or an embedded documents subresource, response body will follow this pattern:
- Always an object with *meta* and *result* properties
- `meta` is an object
- `result` is an array of objects
```json
{
"meta": {
},
"result": [
{}, {}
]
}
```
### URL Params
URL parameters (query string) are used only at endpoints that returns
[lists of documents](#introduction/overview/format),
setting metadata (`meta`) for filtering and pagination purposes, accepted params will vary by each endpoint
#### Common Parameters
- *limit*
- Set the maximum number of documents to return
- Must be an integer > 0
- eg.: `?limit=1000`
- *offset*
- Specifies the first entry to return
- An integer >= 0
- eg.: `?offset=1000`, `?offset=0`
- *sort*
- Specifies rules to order the resultant objects
- Default is ascending order, use - for descending
- eg.: `?sort=-popularity`, `?sort=price,-popularity`
- *fields*
- Specifies the object properties to return
- eg.: `?fields=code`, `?fields=name,code,date`
Other parameters must be valid properties of the objects, will be used to filter results
It's possible to use
[MongoDB dot notation](https://docs.mongodb.com/manual/core/document/#dot-notation)
to filter by embedded arrays and objects
### Headers
All requests must have the header `X-Store-ID` with the unique ID (integer) of respective store
Optionally *X-Cache-Tag* with any value to refuse or update browser cache, *Content-Type*
(*application/json, charset=utf-8*) and *Accept-Encoding*
### Verbs
| Verb | CRUD | Description |
|:--------|----------------|-------------------------|
| GET | Read | View object |
| POST | Create | Create new object |
| PATCH | Update/Modify | Update some properties |
| PUT | Update/Replace | Overwrite entire object |
| DELETE | Delete | Remove object |
| OPTIONS | - | Return allowed methods |
### Authentication
Authentication is not required always, the majority of the resources accept GET requests
without authentication, in some cases, authenticated requests return different body, more complete response
OPTIONS requests are always public
POST, PATCH, PUT and DELETE always require authentication
#### Authentication Headers
You must complete the [steps to authenticate](#reference/authenticate-yourself),
then use the received *access_token* and *my_id* on headers `X-Access-Token` and `X-My-ID` respectively
### Status Codes
Based on HTTP/1.1 Status Code Definitions:
- *2xx* - Successful
- *4xx* - Client error, must check the request
- *5xx* - Server error, report us and try again later
#### Response HTTP Status Code
| Code | Description |
|:------|--------------|
| `200` | OK, successful GET request |
| `201` | Created, successful POST request |
| `202` | Accepted, at root (/) only |
| `204` | No content, successful PATCH, PUT or DELETE request |
| `400` | Bad request, problem in request body or URL params |
| `401` | Unauthorized, need authentication and permission |
| `403` | Forbidden, plan limits reached or client blocked |
| `404` | Not found, resource or ID doesn't exists |
| `405` | Method not allowed, resource doesn't accept used verb |
| `406` | Not acceptable, problem with resource ID or subresource |
| `412` | Precondition failed, no store found with provided ID |
| `417` | Expectation failed, missing some header |
| `500` | Internal server error, please report and try again later |
| `502` | Bad gateway, try again later |
| `503` | Service unavailable, probably blocked by proxy, wait |
| `504` | Gateway timeout, try again later |
## Error Handling
#### App Errors
All *4xx* (client error) and *5xx* (server error) responses from application
will have body following the model below:
- *(object)*
- `status` *(number)* - HTTP status code
- `error_code` *(string, number)* - API error code
- `message` *(string)* - Message to developer
- `user_message` *(object)* - Messages to end user
- `en_us` *(string)*
- `pt_br` *(string)*
- `more_info` *(string, null)* - External link
**Example**
```json
{
"status": 406,
"error_code": 123,
"message": "Invalid value on resource ID",
"user_message": {
"en_us": "The informed ID is invalid",
"pt_br": "O ID informado é inválido"
},
"more_info": null
}
```
To know how to treat this errors, see
[status codes reference](#introduction/overview/status-codes)
#### Web Server Errors
In some cases you can receive an error directly from NGINX web server,
even in this case the response will be a JSON object, almost in the same model
of [App Errors](#introduction/error-handling/app-errors),
but without properties `user_message` and `more_info`,
the `error_code` will be an negative integer
##### NGINX 404
```json
{
"status": 404,
"error_code": -44,
"message": "Page not found"
}
```
Incorrect URL paths, check [API Host](#introduction/overview/host)
##### NGINX 503
```json
{
"status": 503,
"error_code": -53,
"message": "Service unavailable (DDoS?), wait few seconds"
}
```
NGINX is blocking your requests for security reasons, please wait few seconds and try again
## Server Limits
Whenever possible, **avoid using requests with query string**,
then you will be able to consume cache and send up to 30 _GET_ requests per second
with the same IP, to different endpoints
Not cached responses are limited by default to 6 requests per IP per second, but it can vary (to low)
depending of the resource
The same API user (authentication) can make up to 6 authenticated requests per second
In almost all cases you will not receive an error if you go beyond the limits,
the response will only be delayed, but even so,
we recommend that you create treatments in case you receive a *503* status code
## See Also
- [Developers site](https://developers.e-com.plus)
- [GitHub organization](https://github.com/ecomclub)
- [Community](https://community.e-com.plus)
#### Other REST APIs
- [Main](https://ecomplus.docs.apiary.io):
E-Com Plus Main API, with some public data about stores and channels
- [Graphs](https://ecomgraphs.docs.apiary.io):
Recommendations API using Neo4j to define related products by categories, brands and common orders
- [Search](https://ecomsearch.docs.apiary.io):
Powerful text search API using Elasticsearch to find and suggest items (products) and terms
## Getting Help
Feel free to get help or suggest alterations on
[GitHub repo](https://github.com/ecomclub/ecomplus-api-docs) or by e-mail
[[email protected]](mailto:[email protected])
## Group Authenticate Yourself
This authentication method is provided to admin users,
for application authentication you must implement
[Authenticate App](#reference/authenticate-app)
### Step 1 - Login [/_login.json]
This step is not required, if you have your own ID and API key skip to the
[next step](#reference/authenticate-yourself/step-2-authenticate)
#### View User ID And API Key [POST]
+ Request (application/json)
+ Headers
X-Store-ID: 100
+ Attributes (object)
+ email: [email protected] (string, required)
User e-mail address
+ pass_md5_hash: 1a79a4d60de6718e8e5b326e338ae533 (string, required)
User password encoded with MD5
+ Body
{
"email": "[email protected]",
"pass_md5_hash": "1a79a4d60de6718e8e5b326e338ae533"
}
+ Response 200 (application/json)
{
"_id": "5a6757722b66f68dbed44526",
"store_id": 100,
"api_key": "1234567890abcdef"
}
#### With Username Instead Of Email [POST /_login.json?username]
If you don't know the store ID, you can login with username and password only,
passing any positive integer on `X-Store-ID` header
+ Request (application/json)
+ Headers
X-Store-ID: 1
+ Attributes (object)
+ username: my_username (string, required)
Username
+ pass_md5_hash: 1a79a4d60de6718e8e5b326e338ae533 (string, required)
User password encoded with MD5
+ Body
{
"username": "my_username",
"pass_md5_hash": "1a79a4d60de6718e8e5b326e338ae533"
}
+ Response 200 (application/json)
{
"_id": "5a6757722b66f68dbed44526",
"store_id": 100,
"api_key": "1234567890abcdef"
}
### Step 2 - Authenticate [/_authenticate.json]
Use `_id` and `api_key` returned from [login](#reference/authenticate-yourself/step-1-login)
Will return token and ID to be used on further
([authenticated](#introduction/overview/authentication)) requests,
the returned token is valid for one day, as defined by *expires* ISO 8601 date and time,
then you will need to generate another token
#### Generate Access Token [POST]
+ Request (application/json)
+ Headers
X-Store-ID: 100
+ Attributes (object)
+ _id: 5a6757722b66f68dbed44526 (string, required)
User object ID, same returned from login
+ api_key: 1234567890abcdef (string, required)
User API key, 128 bytes hexadecimal string, same returned from login
+ Body
{
"_id": "5a6757722b66f68dbed44526",
"api_key": "1234567890abcdef"
}
+ Response 200 (application/json)
{
"my_id": "5a6757722b66f68dbed44526",
"access_token": "eyJhbGciOi.eyJzdWIi.AFONFh7HgQ",
"expires": "2017-12-01T08:02:17-05:00"
}
## Group Authenticate App
This authentication method is provided to
[E-Com Plus Addons](https://addons.e-com.plus/) registered apps,
for admin users authentication see
[Authenticate Yourself](#reference/authenticate-yourself)
### Authenticate With Callback [/_callback.json]
Will return null response with 204 status code,
token and ID will be sent to application `auth_callback_uri`
with a __POST callback__ request
The callback body will follow the model below:
```json
{
"my_id": "100000000000000000000012",
"access_token": "eyJhbGciOi.eyYzdWIi.ZEONFh7HgQ",
"expires": "2017-12-02T08:02:17-05:00"
}
```
Generated token is valid for one day, as defined by *expires* ISO 8601 date and time,
then you will need to generate another token
#### Request Access Token [POST]
+ Request (application/json)
+ Headers
X-Store-ID: 100
+ Attributes (object)
+ _id: 100000000000000000000012 (string, required)
Authentication object ID
+ Body
{
"_id": "100000000000000000000012"
}
+ Response 204 (application/json)
## Group Products
`.products`
Use the **products** resource to create, read, update and delete items for sale in
a merchant's store, you can edit all product properties and also work with all
product subresources directly at this resource, such as product images, variations, brands and categories
### Product Object [/products/schema.json]
+ Attributes (object)
+ `authorized_stores` (array) - IDs from other stores authorized to sell this product - Max elements: **1000**
+ (number) - Store ID
+ `sku` (string, required) - Product unique reference code - Min length: **2** - Max length: **100** - RegEx pattern: **`^[A-Za-z0-9-_.]+$`**
+ `commodity_type`: physical (enum) - Product type
+ `physical` (string)
+ `digital` (string)
+ `name` (string, required) - Product full name - Max length: **255**
+ `i18n` (object) - Product name translations - Max properties: **10**
+ `^[a-z]{2}(_[a-z]{2})?$` (string) - Translated full product name - Max length: **255**
+ `subtitle` (string) - Optional subtitle intended to be used for SEO or layout purposes - Max length: **255**
+ `slug` (string) - Slug to complete page URL, starting with number or lowercase letter - Max length: **255** - RegEx pattern: **`^[a-z0-9]([a-z0-9-_./]+)?$`**
+ `permalink` (string) - Permanent URL to product page - Max length: **255** - Format: **uri**
+ `mobile_link` (string) - Optional URL specific to mobile devices - Max length: **255** - Format: **uri**
+ `status` (string) - Status defined by seller, such as draft or live - Max length: **50**
+ `available`: true (boolean) - True when product is complete registered and ready to sell
+ `visible`: true (boolean) - Visible on search results, collections and catalogs
+ `ad_relevance`: 0 (number) - Number to define the importance of the ad, the higher should be displayed first - Mininum: **-128** - Maximum: **127**
+ `ad_type` (string) - Option ad type defined by seller, such as gold and silver - Max length: **50**
+ `short_description` (string) - Short product description in plain text - Max length: **255**
+ `body_html` (string) - Full product description, may use HTML tags - Max length: **500000**
+ `body_text` (string) - Full product description, plain text only - Max length: **500000**
+ `meta_title` (string) - Title tag for page SEO - Max length: **255**
+ `meta_description` (string) - Meta description tag for page SEO - Max length: **1000**
+ `keywords` (array) - Tags related with product for internal search - Max elements: **200**
+ (string) - Term (keyword)
+ `price` (number) - Product sale price, when undefined, product could be bought by any price - Mininum: **0** - Maximum: **999999999**
+ `price_effective_date` (object) - How long sale price is valid, out of this range (if defined), `base_price` should be applied
+ `start` (string) - Start date and time in ISO 8601 standard representation - Format: **date-time**
+ `end` (string) - Promotion end date and time in ISO 8601 standard representation - Format: **date-time**
+ `base_price` (number) - Product original sale price, without discounts - Mininum: **0** - Maximum: **999999999**
+ `cost_price` (number) - Product cost price to calculate profit - Mininum: **0** - Maximum: **999999999**
+ `currency_id`: BRL (string) - Designator of currency according to ISO 4217 (3 uppercase letters) - RegEx pattern: **`^[A-Z]{3}$`**
+ `currency_symbol`: R$ (string) - Graphic symbol used as a shorthand for currency's name - Max length: **20**
+ `quantity` (number) - Product quantity available to sell, max to put in cart - Mininum: **0** - Maximum: **9999999**
+ `min_quantity` (number) - Minimum quantity to put in cart - Mininum: **0** - Maximum: **999999**
+ `production_time` (object) - Deadline for production or handling of pre-ordered product
+ `days` (number, required) - Number of days to post the product after purchase, deadline for production or handling - Mininum: **0** - Maximum: **99999**
+ `working_days`: true (boolean) - If the deadline is calculated in working days
+ `cumulative`: false (boolean) - If the production time is cumulative per product unit
+ `max_time` (number) - When cumulative, increase the term proportionally up to this maximum (in days) - Mininum: **0** - Maximum: **99999**
+ `manage_stock`: true (boolean) - Decrease product available quantity automatically after each order
+ `inventory_records` (array) - Recent stock history - Max elements: **180**
+ (object) - Historical record
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `date_of_change` (string, required) - Date and time when stock changed in ISO 8601 standard representation - Format: **date-time**
+ `origin` (string) - Optional note about origin or reason of stock changing - Max length: **50**
+ `quantity` (number, required) - Added or decreased (negative) stock quantity - Mininum: **-9999999** - Maximum: **9999999**
+ `measurement` (object) - Measure and dimension of your product when users might be interested in price per unit
+ `unit` (enum, required) - Unit of measurement
+ `oz` (string)
+ `lb` (string)
+ `mg` (string)
+ `g` (string)
+ `kg` (string)
+ `floz` (string)
+ `pt` (string)
+ `qt` (string)
+ `gal` (string)
+ `ml` (string)
+ `cl` (string)
+ `l` (string)
+ `cbm` (string)
+ `in` (string)
+ `ft` (string)
+ `yd` (string)
+ `cm` (string)
+ `m` (string)
+ `sqft` (string)
+ `sqm` (string)
+ `ct` (string)
+ `precision` (number) - Maximum number of decimal places in the product quantity (in unit of measure) - Mininum: **0** - Maximum: **4**
+ `pricing_base_measure` (number) - Quantity to calculate the price to be shown on ads, such as GMC `unit_pricing_base_measure` - Mininum: **0** - Maximum: **9999999**
+ `multipack` (number) - Indicate that this item is a group of multiple identical products - Mininum: **0** - Maximum: **999999**
+ `dimensions` (object) - Product dimensions with packaging for freight calculation
+ `^width|height|length$` (object) - Package width, height and length
+ `value` (number, required) - Size in specified unit - Mininum: **0** - Maximum: **999999**
+ `unit`: cm (enum) - Unit of measurement
+ `mm` (string)
+ `cm` (string)
+ `m` (string)
+ `ft` (string)
+ `in` (string)
+ `yd` (string)
+ `mi` (string)
+ `weight` (object) - Package weight for freight calculation
+ `value` (number, required) - Size in specified unit - Mininum: **0** - Maximum: **999999**
+ `unit`: g (enum) - Unit of measurement
+ `mg` (string)
+ `g` (string)
+ `kg` (string)
+ `lb` (string)
+ `oz` (string)
+ `condition`: new (enum) - Item condition
+ `new` (string)
+ `refurbished` (string)
+ `used` (string)
+ `not_specified` (string)
+ `adult`: false (boolean) - Product restricted to adults (`18+`)
+ `warranty` (string) - Warranty time and conditions - Max length: **100**
+ `brands` (array) - List of product brands - Max elements: **100**
+ (object) - Product brand (manufacturer)
+ `_id` (string, required) - Brand ID - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `name` (string, required) - Brand name - Max length: **255**
+ `slug` (string) - Brand page slug - Max length: **255** - RegEx pattern: **`^[a-z0-9]([a-z0-9-_./]+)?$`**
+ `logo` (object) - Brand logo
+ `url` (string, required) - Image link - Max length: **255** - Format: **uri**
+ `size` (string) - Image size (width x height) in px, such as 100x50 (100px width, 50px height) - Max length: **11** - RegEx pattern: **`^[1-9]([0-9]+)?x[1-9]([0-9]+)?$`**
+ `alt` (string) - Alternative text, HTML alt tag (important for SEO) - Max length: **255**
+ `categories` (array) - List of product categories - Max elements: **100**
+ (object) - Category object
+ `_id` (string, required) - Category ID - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `name` (string, required) - Category name - Max length: **255**
+ `slug` (string) - Category page slug - Max length: **255** - RegEx pattern: **`^[a-z0-9]([a-z0-9-_./]+)?$`**
+ `ml_category_id` (string) - ID in Mercado Libre Taxonomy - RegEx pattern: **`^ML[A-Z][0-9]{2,9}$`**
+ `google_product_category_id` (number) - ID in Google Taxonomy - Mininum: **1** - Maximum: **999999999999**
+ `category_tree` (string) - Products main category tree, separating by >, such as Women > Dresses - Max length: **750**
+ `ml_category_id` (string) - Preferential category of the product in the Mercado Libre Taxonomy - RegEx pattern: **`^ML[A-Z][0-9]{2,9}$`**
+ `google_product_category_id` (number) - Preferential category of the product in the Google Products Taxonomy - Mininum: **1** - Maximum: **999999999999**
+ `grids` (object) - Grids for specifications and variations, `grid_id` as property name, such as gender or colors - Max properties: **200**
+ `^[a-z0-9_]{2,30}$` (string) - Grid title - Max length: **70**
+ `specifications` (object) - Product attributes and technical specifications - Max properties: **200**
+ `energy_efficiency_class` (array) - Attribute to tell users the energy efficiency class of your product - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the specification (custom value) - Max length: **100**
+ `value` (enum) - Value in the Google Product Specification
+ `A+++` (string)
+ `A++` (string)
+ `A+` (string)
+ `A` (string)
+ `B` (string)
+ `C` (string)
+ `D` (string)
+ `E` (string)
+ `F` (string)
+ `G` (string)
+ `age_group` (array) - Attribute to set the demographic that your product is designed for - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the specification (custom value) - Max length: **100**
+ `value` (enum) - Value in the Google Product Specification
+ `newborn` (string)
+ `infant` (string)
+ `toddler` (string)
+ `kids` (string)
+ `adult` (string)
+ `gender` (array) - Specify for what gender your product is designed - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the specification (custom value) - Max length: **100**
+ `value` (enum) - Value in the Google Product Specification
+ `male` (string)
+ `female` (string)
+ `unisex` (string)
+ `material` (array) - Attribute to describe the main fabric or material that your product is made of - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **200**
+ `value` (string) - Default normalized value to use on GMC and other integrations - Max length: **200**
+ `pattern` (array) - Attribute to describe the pattern or graphic printed on your product - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **200**
+ `value` (string) - Default normalized value to use on GMC and other integrations - Max length: **100**
+ `size` (array) - Attribute to describe the standardized size of your product - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **200**
+ `value` (string) - Default normalized value to use on GMC and other integrations - Max length: **100**
+ `size_type` (array) - Attribute to describe the cut of your product - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **100**
+ `value` (enum) - Value in the Google Product Specification
+ `regular` (string)
+ `petite` (string)
+ `plus` (string)
+ `big and tall` (string)
+ `maternity` (string)
+ `size_system` (array) - Which country's sizing system your product uses - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **100**
+ `value` (enum) - Value in the Google Product Specification
+ `AU` (string)
+ `BR` (string)
+ `CN` (string)
+ `DE` (string)
+ `EU` (string)
+ `FR` (string)
+ `IT` (string)
+ `JP` (string)
+ `MEX` (string)
+ `UK` (string)
+ `US` (string)
+ `colors` (array) - Product color palette, list ordered by importance, starting by main color
+ (object) - Color object
+ `text` (string, required) - Color name - Max length: **50**
+ `value` (string) - RGB code with # - RegEx pattern: **`^#[a-f0-9]{6}$`**
+ `^[a-z0-9_]{2,30}$` (array) - Custom product attributes, `grid_id` as property name - Min elements: **1** - Max elements: **30**
+ (object) - Attribute object
+ `text` (string, required) - Text displayed for the client describing the specification - Max length: **255**
+ `value` (string) - Default normalized value to use in integrations - Max length: **200**
+ `external_values` (object) - Normalized values to use in specific integrations (ID in property) - Max properties: **5**
+ `^[a-z0-9_]{2,30}$` (string) - Attribute text external value - Max length: **200**
+ `pictures` (array) - List of product images - Max elements: **50**
+ (object) - Image object
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `tag` (string) - Tag to identify object, use only lowercase letters, digits and underscore - Max length: **20** - RegEx pattern: **`^[a-z0-9_]+$`**
+ `^small|normal|big|zoom|custom$` (object) - Image size variation
+ `url` (string, required) - Image link - Max length: **255** - Format: **uri**
+ `size` (string) - Image size (width x height) in px, such as 100x50 (100px width, 50px height) - Max length: **11** - RegEx pattern: **`^[1-9]([0-9]+)?x[1-9]([0-9]+)?$`**
+ `alt` (string) - Alternative text, HTML alt tag (important for SEO) - Max length: **255**
+ `videos` (array) - List of videos related to your product - Max elements: **30**
+ (object) - Video object
+ `url` (string, required) - Video link - Max length: **255** - Format: **uri**
+ `title` (string) - Title describing the video - Max length: **255**
+ `attachments` (array) - List of product's attachments - Max elements: **30**
+ (object) - Attachment (file) object
+ `url` (string, required) - Link to file - Max length: **255** - Format: **uri**
+ `title` (string) - Title describing the file - Max length: **255**
+ `customizations` (array) - List of product customization fields - Max elements: **100**
+ (object) - Customization field
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `tag` (string) - Tag to identify object, use only lowercase letters, digits and underscore - Max length: **20** - RegEx pattern: **`^[a-z0-9_]+$`**
+ `label` (string, required) - Title for this customization field, can be the grid title - Max length: **70**
+ `grid_id` (string) - If this field is related to a grid, put the `grid_id` - RegEx pattern: **`^[a-z0-9_]{2,30}$`**
+ `require`: false (boolean) - If field is required (true), customer must always choose a value
+ `options` (object) - Pre-defined options for this customization field, `option_id` as property name - Max properties: **200**
+ `^[a-z0-9_]{2,30}$` (object) - Option object
+ `text` (string, required) - Option text value displayed for the client - Max length: **70**
+ `colors` (array) - Option color palette (if the field involves colors), starting by main color - Max elements: **6**
+ (string) - RGB code with #
+ `add_to_price` (object) - Specific price alteration if customer choose this option
+ `type`: percentage (enum) - Type of price addition
+ `percentage` (string)
+ `fixed` (string)
+ `addition` (number, required) - Additional value, could be negative - Mininum: **-99999999** - Maximum: **99999999**
+ `custom_value`: true (boolean) - If this field accept custom value defined by customer
+ `attachment`: false (boolean) - If this field accept customer file attachment
+ `add_to_price` (object) - Default (to all options) price alteration if customer use this field
+ `type`: percentage (enum) - Type of price addition
+ `percentage` (string)
+ `fixed` (string)
+ `addition` (number, required) - Additional value, could be negative - Mininum: **-99999999** - Maximum: **99999999**
+ `variations` (array) - Product variations list - Max elements: **3000**
+ (object) - Variation object
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `sku` (string) - Item unique reference code - Min length: **2** - Max length: **100** - RegEx pattern: **`^[A-Za-z0-9-_.]+$`**
+ `name` (string) - Product name for this specific variation - Max length: **100**
+ `gtin` (string) - Global Trade Item Numbers (barcode number): UPC, EAN, JAN, ISBN, ITF-14 - RegEx pattern: **`^([0-9]{8}|[0-9]{12,14})$`**
+ `mpn` (string) - Unique code specified by manufacturer to identify the product - Max length: **70**
+ `price` (number) - Variation sale price, when undefined, product default price should be used - Mininum: **0** - Maximum: **999999999**
+ `base_price` (number) - Variation original sale price, without discounts - Mininum: **0** - Maximum: **999999999**
+ `cost_price` (number) - Variation cost price to calculate profit - Mininum: **0** - Maximum: **999999999**
+ `installments` (object) - Default installments option
+ `number` (number, required) - Default number of installments for this product variation - Mininum: **2** - Maximum: **999**
+ `value` (number, required) - Installment value - Mininum: **0** - Maximum: **999999999**
+ `tax`: false (boolean) - Tax applied
+ `quantity` (number) - Product quantity available to sell, max to put in cart - Mininum: **0** - Maximum: **9999999**
+ `min_quantity` (number) - Minimum quantity to put in cart - Mininum: **0** - Maximum: **999999**
+ `production_time` (object) - Deadline for production or handling of pre-ordered product
+ `days` (number, required) - Number of days to post after purchase, deadline for production or handling - Mininum: **0** - Maximum: **99999**
+ `working_days`: true (boolean) - If the deadline is calculated in working days
+ `cumulative`: false (boolean) - If the production time is cumulative per unit
+ `max_time` (number) - When cumulative, increase up to this maximum in days - Mininum: **0** - Maximum: **99999**
+ `dimensions` (object) - Product dimensions with packaging for freight calculation
+ `^width|height|length$` (object) - Package width, height and length
+ `value` (number, required) - Size in specified unit - Mininum: **0** - Maximum: **999999**
+ `unit`: cm (enum) - Unit of measurement
+ `mm` (string)
+ `cm` (string)
+ `m` (string)
+ `ft` (string)
+ `in` (string)
+ `yd` (string)
+ `mi` (string)
+ `weight` (object) - Package weight for freight calculation
+ `value` (number, required) - Size in specified unit - Mininum: **0** - Maximum: **999999**
+ `unit`: g (enum) - Unit of measurement
+ `mg` (string)
+ `g` (string)
+ `kg` (string)
+ `lb` (string)
+ `oz` (string)
+ `specifications` (object, required) - Variation attributes and technical specifications - Min properties: **1** - Max properties: **20**
+ `material` (array) - Attribute to describe the main fabric or material that your product is made of - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **200**
+ `value` (string) - Default normalized value to use on GMC and other integrations - Max length: **200**
+ `pattern` (array) - Attribute to describe the pattern or graphic printed on your product - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **200**
+ `value` (string) - Default normalized value to use on GMC and other integrations - Max length: **100**
+ `size` (array) - Attribute to describe the standardized size of your product - Max elements: **1**
+ (object) - Specification object
+ `text` (string, required) - Text displayed for the client describing the attribute - Max length: **200**
+ `value` (string) - Default normalized value to use on GMC and other integrations - Max length: **100**
+ `colors` (array) - Variation color palette, list ordered by importance, starting by main color
+ (object) - Color object
+ `text` (string, required) - Color name - Max length: **50**
+ `value` (string) - RGB code with # - RegEx pattern: **`^#[a-f0-9]{6}$`**
+ `^[a-z0-9_]{2,30}$` (array) - Custom variation attributes, `grid_id` as property name - Min elements: **1** - Max elements: **6**
+ (object) - Attribute object
+ `text` (string, required) - Text displayed for the client describing the specification - Max length: **255**
+ `value` (string) - Default normalized value to use in integrations - Max length: **200**
+ `external_values` (object) - Normalized values to use in specific integrations (ID in property) - Max properties: **5**
+ `^[a-z0-9_]{2,30}$` (string) - Attribute text external value - Max length: **200**
+ `picture_id` (string) - ID of one of the product pictures for this variation - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `flags` (array) - Flags to associate additional info - Max elements: **10**
+ (string) - Flag title
+ `other_prices` (array) - Other optional prices used - Max elements: **100**
+ (object) - Price (object)
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `tag` (string) - Tag to identify object, use only lowercase letters, digits and underscore - Max length: **20** - RegEx pattern: **`^[a-z0-9_]+$`**
+ `description` (string) - Some optional notes to describe for what this price is intended - Max length: **255**
+ `currency_id`: BRL (string) - Designator of currency according to ISO 4217 (3 uppercase letters) - RegEx pattern: **`^[A-Z]{3}$`**
+ `currency_symbol`: R$ (string) - Graphic symbol used as a shorthand for currency's name - Max length: **20**
+ `price` (number, required) - Product sale price - Mininum: **0** - Maximum: **999999999**
+ `price_change_records` (array) - Historical of recent practiced sale prices - Max elements: **180**
+ (object) - Historical record
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `date_of_change` (string, required) - Date and time when price changed in ISO 8601 standard representation - Format: **date-time**
+ `currency_id`: BRL (string) - Designator of currency according to ISO 4217 (3 uppercase letters) - RegEx pattern: **`^[A-Z]{3}$`**
+ `currency_symbol`: R$ (string) - Graphic symbol used as a shorthand for currency's name - Max length: **20**
+ `price` (number, required) - Product sale price - Mininum: **0** - Maximum: **999999999**
+ `installments` (object) - Default installments option
+ `payment_method_id` (string) - Specify ID if this installments option is for an specific payment method - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `number` (number, required) - Default number of installments for this product - Mininum: **2** - Maximum: **999**
+ `value` (number, required) - Installment value - Mininum: **0** - Maximum: **999999999**
+ `tax`: false (boolean) - Tax applied
+ `discount` (object) - Default discount option, commonly by payment method
+ `label` (string) - Name of payment method or other label describing applicable discount - Max length: **50**
+ `payment_method_id` (string) - Specify ID if this discount is for an specific payment method - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `type`: percentage (enum) - Discount type
+ `percentage` (string)
+ `fixed` (string)
+ `value` (number, required) - Discount value, percentage or fixed - Mininum: **-99999999** - Maximum: **99999999**
+ `progressive_discount` (object) - Progressive discounts options, product quantity as property name - Max properties: **100**
+ `^([2-9]|([1-9][0-9]{1,8}))$` (number) - Percentage discount - Mininum: **-999** - Maximum: **999**
+ `other_discounts` (array) - Other discounts for custom applications - Max elements: **100**
+ (object) - Discount object
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `tag` (string) - Tag to identify object, use only lowercase letters, digits and underscore - Max length: **20** - RegEx pattern: **`^[a-z0-9_]+$`**
+ `description` (string) - Some optional notes to describe for what this discount is intended - Max length: **255**
+ `type`: percentage (enum) - Discount type
+ `percentage` (string)
+ `fixed` (string)
+ `discount` (number, required) - Discount value, percentage or fixed - Mininum: **-99999999** - Maximum: **99999999**
+ `buy_together` (array) - Buy together options - Max elements: **20**
+ (object) - This product and others composing buy together, product ID as property name
+ `^([a-f0-9]{24}|this)$` (object) - Product in buy together
+ `quantity` (number, required) - Product quantity - Mininum: **0** - Maximum: **9999999**
+ `discount` (object) - Discount object
+ `type`: percentage (enum) - Discount type
+ `percentage` (string)
+ `fixed` (string)
+ `value` (number, required) - Discount value, percentage or fixed - Mininum: **-99999999** - Maximum: **99999999**
+ `loyalty_points` (object) - Specify how many and what type of loyalty points a customer receives
+ `name` (string) - The name of the loyalty points program - Max length: **50**
+ `program_id` (string, required) - Unique identifier, program name using only lowercase, numbers and underscore - RegEx pattern: **`^[a-z0-9_]{2,30}$`**
+ `points_value` (number, required) - Number of loyalty points a customer receives when purchasing the product - Mininum: **0** - Maximum: **999999999**
+ `ratio` (number) - The ratio of a point when converted to currency - Mininum: **0** - Maximum: **9999**
+ `payment_methods` (object) - Payment methods for this product, application ID as property name - Max properties: **30**
+ `^[a-f0-9]{24}$` (object) - Payment option
+ `label` (string, required) - Name of payment method shown to customers - Max length: **50**
+ `icon` (string) - Payment icon image URI - Max length: **255** - Format: **uri**
+ `discount` (object) - Discount object
+ `type`: percentage (enum) - Discount type
+ `percentage` (string)
+ `fixed` (string)
+ `value` (number, required) - Discount value, percentage or fixed - Mininum: **-99999999** - Maximum: **99999999**
+ `installments` (object) - Installment options, installments number as property name - Max properties: **100**
+ `^([2-9]|([1-9][0-9]{1,3}))$` (object) - Installment option object
+ `value` (number, required) - Installment value - Mininum: **0** - Maximum: **999999999**
+ `tax`: false (boolean) - Tax applied
+ `shipping_methods` (object) - Shipping methods, application ID as property name - Max properties: **30**
+ `^[a-f0-9]{24}$` (object) - Shipping method object
+ `label` (string, required) - Name of shipping method shown to customers - Max length: **50**
+ `icon` (string) - Shipping method icon image URI - Max length: **255** - Format: **uri**
+ `free_shipping`: false (boolean) - Free shipping with this method
+ `gift_wraps` (array) - Default gift wrap options - Max elements: **20**
+ (object) - Gift wrap object
+ `tag` (string) - Tag to identify object, use only lowercase letters, digits and underscore - Max length: **20** - RegEx pattern: **`^[a-z0-9_]+$`**
+ `label` (string, required) - Title describing this gift wrap - Max length: **70**
+ `add_to_price` (number) - Additional value for this gift wrap - Mininum: **0** - Maximum: **99999999**
+ `destinations` (object) - List of available shipping destinations
+ `^included|excluded$` (object) - Available or unavailable destination
+ `country` (string, required) - An ISO 3166-2 country code - Min length: **2** - Max length: **2** - RegEx pattern: **`^[A-Z]+$`**
+ `zip_codes_range` (object) - ZIP codes range for shipping rules (include or exclude)
+ `^start|end$` (string) - ZIP (CEP, postal...) code - Max length: **30**
+ `location` (object) - Product location(s), shipping origin
+ `zip_codes` (array) - Collection of ZIP codes of product origin locations - Max elements: **30**
+ (object) - Shipping origin, ZIP code and identifier
+ `tag` (string) - Tag to identify object, use only lowercase letters, digits and underscore - Max length: **20** - RegEx pattern: **`^[a-z0-9_]+$`**
+ `code` (string, required) - ZIP (CEP, postal...) code - Max length: **30**
+ `country` (string) - An ISO 3166-2 country code - Min length: **2** - Max length: **2** - RegEx pattern: **`^[A-Z]+$`**
+ `region` (string) - State, territory or prefecture name - Max length: **30**
+ `address` (string) - Full address of product location - Max length: **255**
+ `geolocation` (object) - Geolocation of origin
+ `latitude` (number, required) - Geolocation latitude - Mininum: **-90** - Maximum: **90**
+ `longitude` (number, required) - Geolocation longitude - Mininum: **-180** - Maximum: **180**
+ `tax` (array) - List of taxes applied by region - Max elements: **100**
+ (object) - Tax object
+ `rate` (number, required) - Tax rate as a percentage of the price - Mininum: **-999** - Maximum: **999**
+ `country` (string, required) - An ISO 3166-2 country code - Min length: **2** - Max length: **2** - RegEx pattern: **`^[A-Z]+$`**
+ `tax_ship`: false (boolean) - Whether you charge tax on shipping
+ `zip_codes_range` (object) - ZIP codes range defining region to apply tax
+ `^start|end$` (string) - ZIP (CEP, postal...) code - Max length: **30**
+ `kit_composition` (array) - If this product is a kit, set its composition - Max elements: **100**
+ (object) - One of the kit items
+ `_id` (string, required) - Product ID - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `quantity` (number) - Product quantity - Mininum: **0** - Maximum: **9999999**
+ `label` (string) - Label shown to customer, if you want to use a title other than the product name - Max length: **255**
+ `has_variations`: false (boolean) - If this product has variations
+ `variation_id` (string) - ID to specify a variation if `has_variations` is true, it's optional - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `parent_item_id` (string) - Parent product ID, if this product is contained by another (a kit) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `related_products` (array) - Lists of related products - Max elements: **30**
+ (object) - A list with products related to this
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `tag` (string) - Tag to identify object, use only lowercase letters, digits and underscore - Max length: **20** - RegEx pattern: **`^[a-z0-9_]+$`**
+ `product_ids` (array, required) - List of products - Max elements: **100**
+ (string) - Product ID
+ `auto_fill_related_products`: true (boolean) - True when related products lists should be created and updated automatically (ML)
+ `views`: 0 (number) - Product popularity, will be filled automatically - Mininum: **0** - Maximum: **999999999**
+ `sales`: 0 (number) - Product popularity, will be filled automatically - Mininum: **0** - Maximum: **999999999**
+ `total_sold` (number) - Total amount earned with sales of this product, filled automatically - Mininum: **0** - Maximum: **9999999999**
+ `gtin` (array) - List of product GTIN codes - Max elements: **10**
+ (string) - Global Trade Item Numbers (barcode number): UPC, EAN, JAN, ISBN, ITF-14
+ `mpn` (array) - List of product MPN codes - Max elements: **10**
+ (string) - Unique code specified by manufacturer to identify the product
+ `seller` (object) - Whether the product is sold by a third party, usual in marketplaces
+ `code` (string) - Unique reference code to identify this seller - Max length: **100**
+ `name` (string) - Seller name - Max length: **200**
+ `logo` (string) - Image link to shop's logo - Max length: **255** - Format: **uri**
+ `description` (string) - Short description of shop - Max length: **255**
+ `doc_type` (enum) - Responsible person or organization document type
+ `CPF` (string)
+ `CNPJ` (string)
+ `doc_number` (string) - Responsible person or organization document number (only numbers) - Max length: **19** - RegEx pattern: **`^[0-9]+$`**
+ `inscription_type` (enum) - Municipal or state registration if exists
+ `State` (string)
+ `Municipal` (string)
+ `inscription_number` (string) - Municipal or state registration number (with characters) if exists - Max length: **50**
+ `corporate_name` (string) - Registered company name or responsible fullname - Max length: **255**
+ `address` (string) - Full registered address of company - Max length: **255**
+ `phone` (string) - Contact phone - Max length: **19** - RegEx pattern: **`^[0-9]+$`**
+ `contact_email` (string) - Public email address for news and general contact - Max length: **255** - Format: **email**
+ `metafields` (array) - List of custom attributes - Max elements: **100**
+ (object) - Custom attribute object
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `namespace` (string) - String to help distinguish who (or which app) created and can use the metafield - Max length: **30**
+ `field` (string) - Field name - Max length: **50**
+ `value` (string, required) - Custom property value - Max length: **255**
+ `hidden_metafields` (array) - List of custom attributes - Max elements: **100**
+ (object) - Custom attribute object
+ `_id` (string, required) - Unique ID (ObjectID) - RegEx pattern: **`^[a-f0-9]{24}$`**
+ `namespace` (string) - String to help distinguish who (or which app) created and can use the metafield - Max length: **30**
+ `field` (string) - Field name - Max length: **50**
+ `value` (string, required) - Custom property value - Max length: **255**
+ `flags` (array) - Flags to associate additional info - Max elements: **10**
+ (string) - Flag title
+ `notes` (string) - Optional notes with additional info about this product - Max length: **255**
#### JSON Schema [GET]
+ Request (application/json)
+ Headers
X-Store-ID: 100
+ Response 200 (application/json)
+ Body
{
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Products",
"description": "Product object model",
"type": "object",
"required": [
"sku",
"name"
],
"additionalProperties": false,
"properties": {
"authorized_stores": {
"type": "array",
"uniqueItems": true,
"maxItems": 1000,
"items": {
"type": "integer",
"minimum": 1000,
"maximum": 16777215,
"description": "Store ID"
},
"description": "IDs from other stores authorized to sell this product"
},
"sku": {
"type": "string",
"minLength": 2,
"maxLength": 100,
"pattern": "^[A-Za-z0-9-_.]+$",
"description": "Product unique reference code"
},
"commodity_type": {
"type": "string",
"enum": [
"physical",
"digital"
],
"default": "physical",
"description": "Product type"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Product full name"
},
"i18n": {
"type": "object",
"additionalProperties": false,
"maxProperties": 10,
"patternProperties": {
"^[a-z]{2}(_[a-z]{2})?$": {
"type": "string",
"maxLength": 255,
"description": "Translated full product name"
}
},
"description": "Product name translations"
},
"subtitle": {
"type": "string",
"maxLength": 255,
"description": "Optional subtitle intended to be used for SEO or layout purposes"
},
"slug": {
"type": "string",
"maxLength": 255,
"pattern": "^[a-z0-9]([a-z0-9-_./]+)?$",
"description": "Slug to complete page URL, starting with number or lowercase letter"
},
"permalink": {
"type": "string",
"maxLength": 255,
"format": "uri",
"description": "Permanent URL to product page"
},
"mobile_link": {
"type": "string",
"maxLength": 255,
"format": "uri",
"description": "Optional URL specific to mobile devices"
},
"status": {
"type": "string",
"maxLength": 50,
"description": "Status defined by seller, such as draft or live"
},
"available": {
"type": "boolean",
"default": true,
"description": "True when product is complete registered and ready to sell"
},