-
Notifications
You must be signed in to change notification settings - Fork 133
/
VTEX - Orders API PII version.json
6345 lines (6345 loc) · 474 KB
/
VTEX - Orders API PII version.json
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
{
"openapi": "3.0.0",
"info": {
"title": "Orders API - PII data architecture",
"description": "VTEX stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus) must use this adapted version of the Orders API. Learn more about the modified behavior at [Changes in VTEX features behavior to handle PII data](https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data).\r\n\r\n>⚠️ The **Orders API - PII data architecture** is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in selected regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\n## Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#get-/api/orders/pvt/document/-orderId-)\r\n- `POST` [List orders](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/extendsearch/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/actions/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/cancel)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/invoices)\r\n\r\n### Payment\r\n\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/payment/-paymentId-/notify-payment)",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "https://{accountName}.{environment}.com.br",
"description": "VTEX server URL.",
"variables": {
"accountName": {
"description": "Name of the VTEX account. Used as part of the URL.",
"default": "apiexamples"
},
"environment": {
"description": "Environment to use. Used as part of the URL.",
"enum": [
"vtexcommercestable"
],
"default": "vtexcommercestable"
}
}
}
],
"paths": {
"/api/orders/pvt/document/{orderId}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get order",
"description": "Retrieves order details by searching by order ID.\r\n\r\nIf you wish to retrieve unmasked data, use the `reason` query parameter.\r\n\r\n>⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute.\r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).\r\n\r\n> Check the [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
"operationId": "GetOrder2",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Accept"
},
{
"$ref": "#/components/parameters/orderId"
},
{
"$ref": "#/components/parameters/reason"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Order ID."
},
"sellerOrderId": {
"type": "string",
"description": "Seller order ID."
},
"orderFormId": {
"type": "string",
"description": "ID of the shopping cart from which the order was created."
},
"origin": {
"type": "string",
"description": "Order's [origin in the order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).",
"enum": [
"Marketplace",
"Fulfillment",
"Chain"
]
},
"orderGroup": {
"type": "string",
"description": "Order group ID."
},
"items": {
"type": "array",
"description": "Information on order items.",
"items": {
"type": "object",
"description": "Information on each order item.",
"properties": {
"productCategories": {
"type": "object",
"description": "Object containing product categories with the structure: `{CategoryID}: {CategoryName}`.",
"properties": {
"additionalProperties": {
"type": "string",
"description": "Product category corresponding to the ID in the field key."
}
}
},
"uniqueId": {
"type": "string",
"description": "Order item unique ID."
},
"id": {
"type": "string",
"description": "Item ID."
},
"productId": {
"type": "string",
"description": "Product ID."
},
"lockId": {
"type": "string",
"description": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID.",
"nullable": true
},
"ean": {
"type": "string",
"description": "European Article Number (EAN) of the item.",
"nullable": true
},
"quantity": {
"type": "integer",
"description": "Item quantity."
},
"seller": {
"type": "string",
"description": "Seller name. When the store acts both as marketplace and seller, this field corresponds to `1`, because every VTEX store is its own seller 1."
},
"sellerSku": {
"type": "string",
"description": "Seller SKU ID."
},
"priceValidUntil": {
"type": "string",
"description": "Item price expiration date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
},
"name": {
"type": "string",
"description": "SKU name."
},
"additionalInfo": {
"type": "object",
"description": "Item additional information.",
"properties": {
"brandName": {
"type": "string",
"description": "Item brand name."
},
"brandId": {
"type": "string",
"description": "Item brand ID."
},
"categoriesIds": {
"type": "string",
"description": "Categories IDs."
},
"dimension": {
"type": "object",
"description": "Item dimensions.",
"properties": {
"cubicweight": {
"type": "number",
"description": "Item cubic weight."
},
"height": {
"type": "number",
"description": "Item height."
},
"length": {
"type": "number",
"description": "Item length."
},
"weight": {
"type": "number",
"description": "Item weight."
},
"width": {
"type": "number",
"description": "Item width."
}
}
},
"productClusterId": {
"type": "string",
"description": "All product clusters related to the item."
},
"commercialConditionId": {
"type": "string",
"description": "Commercial condition ID."
},
"offeringInfo": {
"type": "string",
"description": "Offering information.",
"nullable": true
},
"offeringType": {
"type": "string",
"description": "Offering type.",
"nullable": true
},
"offeringTypeId": {
"type": "string",
"description": "Offering type ID.",
"nullable": true
},
"categories": {
"type": "array",
"description": "Item [categories](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf) information.",
"items": {
"type": "object",
"description": "Information about a given category.",
"properties": {
"id": {
"type": "integer",
"description": "Category ID."
},
"name": {
"type": "string",
"description": "Category name."
}
}
}
}
}
},
"attachments": {
"type": "array",
"description": "Information on [attachments](https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm).",
"nullable": true,
"items": {
"type": "object",
"description": "Information about a given attachment.",
"properties": {
"name": {
"type": "string",
"description": "Attachment name.",
"nullable": true
},
"content": {
"type": "object",
"description": "Custom field for attachment content.",
"nullable": true,
"additionalProperties": {
"type": "string",
"description": "Custom field information.",
"nullable": true
}
}
}
}
},
"attachmentOfferings": {
"type": "array",
"description": "Array containing attachments details.",
"nullable": true,
"items": {
"type": "object",
"description": "Attachment details.",
"nullable": true,
"properties": {
"name": {
"type": "string",
"description": "Attachment name.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Defines if the attachment is required (`true`) or not (`false`).",
"nullable": true
},
"schema": {
"type": "object",
"description": "Schema of the content declared in the field `attachmentOfferings`.",
"nullable": true
}
}
}
},
"assemblies": {
"type": "array",
"description": "Information about the item customization, when applicable.",
"nullable": true,
"items": {
"type": "string",
"description": "Customization information.",
"nullable": true
}
},
"refId": {
"type": "string",
"description": "Ref ID."
},
"shippingPrice": {
"type": "integer",
"description": "Item shipping price in cents. This value does not account for the order total shipping price.",
"nullable": true
},
"price": {
"type": "integer",
"description": "Item price in cents."
},
"sellingPrice": {
"type": "integer",
"description": "Selling price in cents. This field can present rounding discrepancies, so we recommend retrieving pricing information from the `priceDefinition` field."
},
"listPrice": {
"type": "integer",
"description": "List price in cents."
},
"manualPrice": {
"type": "integer",
"description": "[Manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf) in cents.",
"nullable": true
},
"tax": {
"type": "integer",
"description": "Tax value in cents."
},
"rewardValue": {
"type": "integer",
"description": "Reward value in cents."
},
"freightCommission": {
"type": "integer",
"description": "Freight commission value in cents."
},
"commission": {
"type": "integer",
"description": "Commission value registered for the seller."
},
"priceTags": {
"type": "array",
"description": "Information about price tags. A price tag is a price modifier, like s discount or a promotion applicable to the item in the order context.",
"items": {
"type": "object",
"description": "Information about a given price tag.",
"properties": {
"name": {
"type": "string",
"description": "Price tag name."
},
"rawValue": {
"type": "number",
"description": "Price tag raw value."
},
"isPercentual": {
"type": "boolean",
"description": "Indicates whether price tag value is applied through a percentage (`true`) or not (`false`)."
},
"identifier": {
"type": "string",
"description": "Price tag identifier."
},
"rate": {
"type": "integer",
"description": "Price tag value.",
"nullable": true
},
"jurisCode": {
"type": "string",
"description": "Juris code.",
"nullable": true
},
"jurisType": {
"type": "string",
"description": "Juris type.",
"nullable": true
},
"jurisName": {
"type": "string",
"description": "Juris name.",
"nullable": true
}
}
}
},
"imageUrl": {
"type": "string",
"description": "Image URL."
},
"detailUrl": {
"type": "string",
"description": "Detail URL."
},
"components": {
"type": "array",
"description": "Item components.",
"nullable": true,
"items": {
"type": "string",
"description": "Component name.",
"nullable": true
}
},
"bundleItems": {
"type": "array",
"description": "Information about services sold with the item. For example, a gift package.",
"nullable": true,
"items": {
"type": "object",
"description": "Information about a given service.",
"properties": {
"type": {
"type": "string",
"description": "Service type."
},
"id": {
"type": "integer",
"description": "Service ID."
},
"name": {
"type": "string",
"description": "Service name."
},
"price": {
"type": "integer",
"description": "Service price in cents."
}
}
}
},
"offerings": {
"type": "array",
"description": "Information about offerings, which are services related to the item. For example, a warranty or installation.",
"nullable": true,
"items": {
"type": "string",
"description": "Name of the service related to the item. For example, warranty or installation.",
"nullable": true
}
},
"preSaleDate": {
"type": "string",
"description": "Presale date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
"nullable": true
},
"isGift": {
"type": "boolean",
"description": "Defines it the item is a gift (`true`) or not (`false`)."
},
"taxCode": {
"type": "string",
"description": " Item tax code.",
"nullable": true
},
"measurementUnit": {
"type": "string",
"description": "Item measurement unit."
},
"unitMultiplier": {
"type": "number",
"description": "Item unit multiplier."
},
"marketingData": {
"type": "object",
"description": "Information about marketing and promotions, such as coupon code and [Urchin Tracking Module (UTM)](https://help.vtex.com/en/tutorial/what-are-utm-source-utm-campaign-and-utm-medium--2wTz7QJ8KUG6skGAoAQuii).",
"nullable": true,
"properties": {
"utmSource": {
"type": "string",
"description": "A UTM is an Urchin Tracking Module used to track traffic related to your store. This field is an UTM for tracking the traffic source, to know from which site, advertiser, or publication the customer came before reaching your site.",
"nullable": true
},
"utmMedium": {
"type": "string",
"description": "UTM for tracking the advertising or marketing media used to reach your site, such as banners and newsletters."
},
"utmCampaign": {
"type": "string",
"description": "UTM for tracking the marketing campaign context.",
"nullable": true
},
"utmPartner": {
"type": "string",
"description": "UTM for tracking the partner.",
"nullable": true
},
"utmipage": {
"type": "string",
"description": "A `utmi` is an internal Urchin Tracking Module (UTM) used to track traffic inside your site. This field is an internal UTM for tracking pages.",
"nullable": true
},
"utmiPart": {
"type": "string",
"description": "Internal UTM for tracking the partner.",
"nullable": true
},
"utmiCampaign": {
"type": "string",
"description": "Internal UTM for tracking the marketing campaign context.",
"nullable": true
},
"coupon": {
"type": "string",
"description": "Coupon code used by the customer.",
"nullable": true
},
"marketingTags": {
"type": "array",
"description": "List of marketing tags valid for the item.",
"items": {
"type": "string",
"description": "Marketing tag name."
}
}
}
},
"parentAssemblyBinding": {
"type": "string",
"description": "When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH).",
"nullable": true
},
"parentItemIndex": {
"type": "integer",
"description": "Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options.",
"nullable": true
},
"callCenterOperator": {
"type": "string",
"description": "Identification code of the call center operator that sold the item, when applicable.",
"nullable": true
},
"priceDefinition": {
"type": "object",
"description": "Item price information.",
"properties": {
"calculatedSellingPrice": {
"type": "integer",
"description": "Item calculated selling price in cents."
},
"total": {
"type": "integer",
"description": "Item total price in cents."
},
"sellingPrices": {
"type": "array",
"description": "Item selling prices.",
"items": {
"type": "object",
"description": "Price value per quantity.",
"properties": {
"value": {
"type": "integer",
"description": "Item selling price value in cents."
},
"quantity": {
"type": "integer",
"description": "Item quantity."
}
}
}
},
"reason": {
"type": "string",
"description": "Item price definition reason.",
"nullable": true
}
}
},
"costPrice": {
"type": "integer",
"description": "Item cost price in cents.",
"nullable": true
}
}
}
},
"marketplaceItems": {
"type": "array",
"description": "Marketplace items.",
"nullable": true,
"items": {
"type": "string",
"description": "Marketplace item.",
"nullable": true
}
},
"authorizedDate": {
"type": "string",
"description": "Order authorization date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
},
"subscriptionData": {
"type": "object",
"description": "Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453), when applicable.",
"nullable": true,
"properties": {
"subscriptionGroupId": {
"type": "string",
"description": "Subscription group ID. If this field returns `null` and the `executionCount` is `0`, the order is the first subscription order.",
"nullable": true
},
"subscriptions": {
"type": "array",
"description": "List with subscriptions details.",
"nullable": true,
"items": {
"type": "object",
"description": "Subscription details.",
"properties": {
"executionCount": {
"type": "integer",
"description": "Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on."
},
"priceAtSubscriptionDate": {
"type": "number",
"description": "Value of the order when the customer subscribed. Subscriptions created via VTEX Admin or [Subscriptions API](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3) do not have an original order, so this field returns `0.0`.",
"nullable": true,
"deprecated": true
},
"itemIndex": {
"type": "integer",
"description": "Each item in the subscription order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on."
},
"plan": {
"type": "object",
"description": "Information about the [subscription plan](https://help.vtex.com/en/tutorial/subscription-plans-beta--5kczKRqHEsrs1tYtRcY8wR).",
"properties": {
"type": {
"type": "string",
"description": "Plan type."
},
"frequency": {
"type": "object",
"description": "Information about subscriptions' recurrence.",
"properties": {
"periodicity": {
"type": "string",
"description": "Defines the subscription recurrence period.",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"YEARLY"
]
},
"interval": {
"type": "integer",
"description": "Time interval configured between subscription orders, which depends on the frequency. For a `DAY` frequency, the value will be days, for `MONTH` it will be months, and so on."
}
}
},
"validity": {
"type": "object",
"description": "Information about the period during which the subscription will be valid.",
"properties": {
"begin": {
"type": "string",
"description": "Subscription plan beginning date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
},
"end": {
"type": "string",
"description": "Subscription plan ending date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
"nullable": true
}
}
}
}
}
}
}
}
}
},
"taxData": {
"type": "object",
"description": "Order taxes information.",
"required": [
"areTaxesDesignatedByMarketplace",
"taxInfoCollection"
],
"nullable": true,
"properties": {
"areTaxesDesignatedByMarketplace": {
"type": "boolean",
"description": "Defines if the taxes were applied by the marketplace (`true`) or not (`false`)."
},
"taxInfoCollection": {
"type": "array",
"description": "Order taxes details.",
"items": {
"type": "object",
"description": "Information about a given tax.",
"required": [
"itemIndex",
"sku",
"priceTags"
],
"properties": {
"itemIndex": {
"type": "integer",
"description": "Item indexing number."
},
"sku": {
"type": "string",
"description": "SKU ID."
},
"priceTags": {
"type": "object",
"description": "Information about order taxes.",
"nullable": true,
"properties": {
"areTaxesDesignatedByMarketplace": {
"type": "boolean",
"description": "Defines if the taxes were designated by the marketplace (`true`) or not (`false`)."
},
"taxInfoCollection": {
"type": "array",
"description": "Array with taxes' details.",
"items": {
"type": "object",
"description": "Details about a given tax.",
"properties": {
"itemIndex": {
"type": "integer",
"description": "Item index number."
},
"sku": {
"type": "string",
"description": "Alphanumeric sequence that identifies a SKU."
},
"priceTags": {
"type": "array",
"description": "Price tags information with the original taxes calculated at order placement.",
"items": {
"type": "object",
"description": "Information about a given price tag.",
"properties": {
"identifier": {
"type": "string",
"description": "Price tag identifier code."
},
"isPercentual": {
"type": "boolean",
"description": "Indicates whether price tag value is applied through a percentage (`true`) or not (`false`)."
},
"name": {
"type": "string",
"description": "Price tag name."
},
"value": {
"type": "number",
"description": "Price tag value."
},
"rawValue": {
"type": "number",
"description": "Price tag raw value that can contain up to five decimals, separated by a period."
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"invoicedDate": {
"type": "string",
"description": "Order invoice date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
"nullable": true
},
"marketplaceOrderId": {
"type": "string",
"description": "Order ID in the marketplace.",
"nullable": true
},
"marketplaceServicesEndpoint": {
"type": "string",
"description": "Marketplace endpoint for post purchase communication.",
"nullable": true
},
"clientProfileData": {
"$ref": "#/components/schemas/ClientProfileData"
},
"giftRegistryData": {
"type": "object",
"description": "[Gift list](https://developers.vtex.com/docs/guides/creating-gift-lists) information.",
"nullable": true,
"properties": {
"giftRegistryId": {
"type": "string",
"description": "Gift list ID."
},
"giftRegistryType": {
"type": "string",
"description": "[Gift list type](https://help.vtex.com/en/tutorial/creating-a-type-of-list)."
},
"giftRegistryTypeName": {
"type": "string",
"description": "Gift list type name."
},
"addressId": {
"type": "string",
"description": "Gift list shipping address ID."
},
"description": {
"type": "string",
"description": "Gift list description."
}
}
},
"emailTracked": {
"type": "string",
"description": "Customer email [tracked](https://help.vtex.com/en/tutorial/understanding-the-conversation-tracker--tutorials_195)."
},
"isCheckedIn": {
"type": "boolean",
"description": "Defines if the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`)."
},
"approvedBy": {
"type": "string",
"description": "User who approved the order, in case of manual approval.",
"nullable": true
},
"cancelledBy": {
"type": "string",
"description": "User that canceled the order.",
"nullable": true
},
"canceledBy": {
"type": "string",
"description": "User that canceled the order.",
"nullable": true
},
"cancelReason": {
"type": "string",
"description": "Order cancellation reason.",
"nullable": true
},
"callCenterOperatorData": {
"type": "object",
"description": "Information about the call center operator responsible for the order.",
"nullable": true,
"properties": {
"id": {
"type": "string",
"description": "Call center operator identification code."
},
"email": {
"type": "string",
"description": "Call center operator email."
},
"userName": {
"type": "string",
"description": "Call center operator user name."
}
}
},
"allowCancellation": {
"type": "boolean",
"description": "Defines if order cancellation is allowed (`true`) or not anymore (`false`)."
},
"allowEdition": {
"type": "boolean",
"description": "Defines if the order can be edited (`true`) or not anymore (`false`)."
},
"roundingError": {
"type": "integer",
"description": "Rounding error total amount in cents, when applicable. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field."
},
"salesChannel": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) related to the order."
},
"salesChannelData": {
"type": "object",
"description": "Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) information.",
"properties": {
"countryCode": {
"type": "string",
"description": "Three-digit country code, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
"nullable": true
},
"currencyCode": {
"type": "string",
"description": "Currency code in [ISO 4217](https://www.iban.com/currency-codes) format.",
"nullable": true
},
"currencyFormatInfo": {
"type": "object",
"description": "Currency format details.",
"nullable": true,
"properties": {
"CurrencyDecimalDigits": {
"type": "integer",
"description": "Quantity of currency decimal digits."
},
"CurrencyDecimalSeparator": {
"type": "string",
"description": "Defines what currency decimal separator will be applied."
},
"CurrencyGroupSeparator": {
"type": "string",
"description": "Defines what currency group separator will be applied."
},
"CurrencyGroupSize": {
"type": "integer",
"description": "Defines how many characters will be grouped."
},
"StartsWithCurrencySymbol": {
"type": "boolean",
"description": "Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`)."
}
}
},
"cultureInfo": {
"type": "string",
"description": "Information about the culture.",
"nullable": true
},
"currencyLocale": {
"type": "integer",
"description": "Currency Locale Code in [LCID](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a) format."
},
"currencySymbol": {
"type": "string",
"description": "Currency symbol.",
"nullable": true
},
"timeZone": {
"type": "string",
"description": "Time zone where the order was created.",
"nullable": true
},
"id": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID."
},
"name": {
"type": "string",
"description": "Store name."
},
"isActive": {
"type": "boolean",
"description": "Defines if the sales channel is active (`true`) or inactive (`false`)."
}
}
},
"customData": {
"type": "object",
"description": "Customizable fields created by the store for the shopping cart. This field is useful for storing data not included in other fields. For example, a message for a gift or a name to be printed in a shirt.",
"nullable": true,
"properties": {
"customApps": {
"type": "array",
"description": "Customizable apps created by the store.",
"nullable": true,
"items": {
"type": "string",
"description": "Customizable apps details.",
"nullable": true
}
}
}
},
"changesAttachment": {
"$ref": "#/components/schemas/ChangesAttachment"
},
"commercialConditionData": {
"type": "string",
"description": "Commercial condition information.",
"nullable": true
},
"shippingData": {
"$ref": "#/components/schemas/ShippingData"
},
"packageAttachment": {
"type": "object",
"description": "Information about shipping packages, which are created after order invoicing.",
"nullable": true,
"properties": {
"packages": {
"type": "array",
"description": "List with packages' information.",
"nullable": true,
"items": {
"type": "object",
"description": "Package details.",
"properties": {
"courier": {
"type": "string",
"description": "Name of the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) responsible for the package shipping."
},
"description": {
"type": "string",
"description": "Package description.",
"nullable": true
},
"invoiceNumber": {
"type": "string",
"description": "Unique identification code of the package invoice."
},
"invoiceValue": {
"type": "integer",