forked from vtex/openapi-schemas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VTEX - Orders API (PII version).json
5867 lines (5867 loc) · 334 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 version)",
"description": "Endpoints that deal with order management. New version of the orders API.",
"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 a specific order ID.\n\r\n\r>If you wish to retrieve unmasked data, use the `reason` parameter.\n\r\n\r> The `View order` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).\n\r\n\r> Check the new [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.\n\r\n\r> Throttling: Each account can make up to 5000 requests per minute.\n\r\n\r## Request object has the following properties:\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `orderId` | string | Order Id |\r\n\r\n\r\n## Response object has the following properties:\r\n\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `affiliateId` | string | Seller Name who was responsible for the order |\r\n| `allowCancellation` | boolean | If Cancellation is allowed |\r\n| `allowEdition` | boolean | If Order Edition is allowed |\r\n| `approvedBy` | string | User who approved the order |\r\n| `authorizedDate` | string | Authorized Order Date |\r\n| `callCenterOperatorData` | string | Call Center Operator responsible for the order |\r\n| `cancelReason` | string | Cancel Reason |\r\n| `cancelledBy` | string | User who Cancelled the order |\r\n| `changesAttachment` | object | Change details object |\r\n| `changesData` | object | Array with each change |\r\n| `discountValue` | integer | Change Discount Value |\r\n| `incrementValue` | integer | Change Increment Value |\r\n| `itemsAdded` | object | Added items details |\r\n| `itemsRemoved` | object | Removed items details |\r\n| `id` | integer | Changed SKU ID |\r\n| `name` | string | Changed SKU Name |\r\n| `price` | integer | Changed SKU Price |\r\n| `quantity` | integer | Changed SKU Quantity |\r\n| `unitMultiplier` | integer | Changed SKU Unit Multiplier |\r\n| `reason` | string | Change Reason |\r\n| `receipt` | object | Change receipt details object |\r\n| `date` | string | Change receipt date |\r\n| `orderId` | string | Change receipt order Id |\r\n| `receipt` | object | Change receipt ID |\r\n| `id` | string | Object Id, expect value \"changeAttachment\" |\r\n| `clientProfileData` | object | Object with all Cliente Profile Data |\r\n| `corporateDocument` | string | Client Corporate Document |\r\n| `corporateName` | string | Client Corporate Name |\r\n| `corporatePhone` | string | Cliente Corporate Telephone |\r\n| `customerClass` | string | Customer class |\r\n| `document` | string | Client Document |\r\n| `documentType` | string | Client Document Type |\r\n| `email` | string | Client e-mail |\r\n| `firstName` | string | Client First Name |\r\n| `id` | string | Object ID, expected value \"clientProfileData\" |\r\n| `isCorporate` | string | If the Client is a Corporate Client |\r\n| `lastName` | string | Client Last Name|\r\n| `phone` | string | Client Telephone |\r\n| `stateInscription` | string | Client Corporate Inscription |\r\n| `tradeName` | string | Client Corporate Trade Name |\r\n| `userProfileId` | string | Client User Profile ID |\r\n| `commercialConditionData` | object | Commercial condition information, including `\"Id\"`, `\"parentOrderId\"`, and `\"reason\"` |\r\n| `creationDate` | string | Order Creation Date |\r\n| `customData` | object | Custom Data Object |\r\n| `customApps` | object | Custom apps details object |\r\n| `fields` | object | Custom app fields |\r\n| `id` | string | Custom App ID |\r\n| `major` | integer | Major |\r\n| `emailTracked` | string | Client Conversation Tracker email |\r\n| `followUpEmail` | string | Responsible store e-mail |\r\n| `giftRegistryData` | object | Gift registry list information, including `\"addressId\"` (object), `\"description\"` (string), and `\"giftRegistryId\"` (string) |\r\n| `hostname` | string | Account hostname registered in License Manager |\r\n| `invoiceData` | object | Information pertinent to the order's invoice |\r\n| `invoicedDate` | string | Invoice Date |\r\n| `isCheckedIn` | boolean | True if order is from inStore |\r\n| `isCompleted` | boolean | True if the order is completed |\r\n| `items` | object | Order items object |\r\n| `additionalInfo` | string | Order item additional info |\r\n| `brandId` | string | Brand ID |\r\n| `brandName` | string | Brand name |\r\n| `categoriesIds` | string | Item category ID |\r\n| `commercialConditionId` | string | Invoice date |\r\n| `dimension` | object | Item dimension object |\r\n| `cubicweight` | number | Item cubic weight |\r\n| `height` | number | Item height |\r\n| `length` | number | Item length |\r\n| `weight` | number | Item weight |\r\n| `width` | number | Item width |\r\n| `offeringInfo` | string | Extra information on offering |\r\n| `offeringType` | string | Offering type |\r\n| `offeringTypeId` | string | ID of offering type |\r\n| `productClusterId` | string | All releated product clusters |\r\n| `attachments` | object | Attachents Array |\r\n| `content` | object | Attachment Content Custom Field |\r\n| `name` | string | Attachment Name |\r\n| `bundleItems` | object | Invoice date |\r\n| `commission` | string | Comission value registered to Seller |\r\n| `components` | object | If item is a kit, contains components information |\r\n| `detailUrl` | string | Product Slug URL |\r\n| `ean` | string | SKU EAN |\r\n| `freightCommission` | integer | Comission value registered to seller |\r\n| `id` | string | SKU Id |\r\n| `imageUrl` | string | SKU Image URL |\r\n| `isGift` | string | If this item is a gift in order context |\r\n| `itemAttachment` | object | Attachment Object |\r\n| `content` | object | Attachment Content Array |\r\n| `name` | string | Attachment Name |\r\n| `listPrice` | integer | Item List Price |\r\n| `lockId` | string | Reservation ID |\r\n| `manualPrice` | string | Manually inserted price, if there is one. |\r\n| `measurementUnit` | string | Item measurement unit |\r\n| `name` | string | Item name |\r\n| `offerings` | object | Offerings information |\r\n| `params` | object | \"ContextParameter\" hashset with `\"name\"` and `\"value\"` |\r\n| `preSaleDate` | string | Item pre sale date |\r\n| `price` | integer | Item Price |\r\n| `items[].priceDefinition` | Object | Price information for all units of a specific item. |\r\n| `items[].priceDefinition.total` | Integer | Total value for all units of the item in cents. |\r\n| `items[].priceDefinition.calculatedSellingPrice` | Integer | Item's calculated unitary selling price in cents. |\r\n| `items[].priceDefinition.sellingPrices` | Array | Array of objects, each containing `value` (in cents) and `quantity` for the different rounding instances that can be combined to form the correctly rounded `total`. |\r\n| `priceTags` | object | Object with all price modifiers |\r\n| `identifier` | string | Price Tag ID |\r\n| `isPercentual` | boolean | Indicates whether the price tag is a percentual modifier |\r\n| `name` | string | Price tag name |\r\n| `rawValue` | string | Price tag raw value |\r\n| `value` | string | Price tag value |\r\n| `priceValidUntil` | string | Price expiration date |\r\n| `productId` | string | Item product ID |\r\n| `quantity` | integer | Item quantity |\r\n| `refId` | string | Item reference ID |\r\n| `rewardValue` | integer | Item reward value |\r\n| `seller` | string | Item seller |\r\n| `sellerSku` | string | Invoice Date |\r\n| `sellingPrice` | integer | Item selling price. For more accurate information, see the `priceDefinition` field |\r\n| `shippingPrice` | string | Item Shipping Price |\r\n| `tax` | integer | Item Tax |\r\n| `taxCode` | string | Item Tax Code |\r\n| `uniqueId` | string | Item Order Unique ID |\r\n| `unitMultiplier` | integer | Item Unit Multipler |\r\n| `lastChange` | string | Order Last Change Date |\r\n| `lastMessage` | string | initial excerpt from last message sent to the customer |\r\n| `marketingData` | string | Marketing Data Object |\r\n| `coupon` | string | Order Disccount Coupon |\r\n| `id` | string | Object ID, expected value \"marketingData\" |\r\n| `marketingTags` | object | Marketing Tags Array |\r\n| `utmCampaign` | string | UTM Campaign Parameters |\r\n| `utmMedium` | string | UTM Medium Parameters |\r\n| `utmPartner` | string | UTM Source Parameters |\r\n| `utmSource` | string | UTM Source Parameters|\r\n| `utmiCampaign` | string | UTMI Campaign Internal Parameters |\r\n| `utmiPart` | string | UTMI Part Internal Parameters |\r\n| `utmipage` | string | UTMI Page Internal Parameters |\r\n| `marketplace` | object | Marketplace Details Object |\r\n| `baseURL` | string | Marketplace Base URL |\r\n| `isCertified` | string | If is a Certified Marketplace |\r\n| `name` | string | Marketplace Name |\r\n| `marketplaceItems` | object | Marketplace Details Object |\r\n| `marketplaceOrderId` | string | Marketplace Order Id |\r\n| `marketplaceServicesEndpoint` | string | Marketplace Services Endpoint |\r\n| `merchantName` | string | Merchant Name |\r\n| `openTextField` | object | Open Text Field Object |\r\n| `value` | string | Open Text Field Value |\r\n| `orderFormId` | string | Order Form Id |\r\n| `orderGroup` | string | Order Group Id |\r\n| `orderId` | string | Order Id |\r\n| `origin` | string | Order Origin: \"Marketplace\", \"Fulfillment\", or \"Chain\" (for the third level in a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4?&utm_source=autocomplete#) purchase). |\r\n| `packageAttachment` | object | Package Object |\r\n| `packages` | object | Packages Details Object, populated after order invoiced |\r\n| `cfop` | string | Fiscal code for operations and installments |\r\n| `courier` | string | Package selected Courier |\r\n| `courierStatus` | string | Package Tracking Status |\r\n| `data` | object | Package Tracking Timeline |\r\n| `finished` | string | If the delivery are finished |\r\n| `status` | string | Courier Status |\r\n| `embeddedInvoice` | string | XML of the invoice |\r\n| `invoiceKey` | string | Invoice Credencial Key |\r\n| `invoiceNumber` | string | Package Invoice Number |\r\n| `invoiceUrl` | string | Package Invoice URL |\r\n| `invoiceValue` | string | Package Invoice Value |\r\n| `issuanceDate` | string | Package Issuance Date |\r\n| `items` | string | Items Package Array |\r\n| `description` | string | Item Desciprtion |\r\n| `itemIndex` | string | Item Index |\r\n| `price` | string | Item Price |\r\n| `quantity` | string | Item Quantity |\r\n| `unitMultiplier` | string | Unit Multiplier |\r\n| `trackingNumber` | string | Package Tracking Number |\r\n| `trackingUrl` | string | Tracking Order URL |\r\n| `type` | string | Invoice Type, expected values \"Output\" and \"Input\" |\r\n| `paymentData` | object | Payment Object |\r\n| `transactions` | object | Transactions Object |\r\n| `isActive` | boolean | If the payment is Active |\r\n| `merchantName` | string | Merchant Name|\r\n| `payments` | object | Payment Object |\r\n| `cardHolder` | string | Payment Card Holder |\r\n| `connectorResponses` | object | Connector Responses Object |\r\n| `billingAddress` | object | Billing Address information |\r\n| `Message` | string | Connector Responses Message |\r\n| `ReturnCode` | string | Connector Return Code |\r\n| `Tid` | string | Connector Transaction ID |\r\n| `acquirer` | string | Connector acquirer |\r\n| `authId` | string | Connector authorization ID |\r\n| `dueDate` | string | Payment due date |\r\n| `firstDigits` | string | Payment card first digits |\r\n| `giftCardCaption` | string | Gift card caption |\r\n| `giftCardId` | string | Gift card ID |\r\n| `giftCardName` | string | Gift card name |\r\n| `group` | string | Payment group |\r\n| `id` | string | Payment ID |\r\n| `installments` | string | Payment installments quantity |\r\n| `lastDigits` | string | Payment card last digits |\r\n| `paymentSystem` | string | Payment system type ID |\r\n| `paymentSystemName` | string | Payment system name |\r\n| `redemptionCode` | string | Gift card redemption code |\r\n| `referenceValue` | string | Payment reference value |\r\n| `tid` | string | Payment transaction ID |\r\n| `url` | string | Payment URL |\r\n| `value` | string | Payment value with interest if it applies |\r\n| `transactionId` | string | Transaction Id |\r\n| `ratesAndBenefitsData` | string | Rates and Benefits Data Object |\r\n| `id` | string | Object ID, expected value \"ratesAndBenefitsData\" |\r\n| `rateAndBenefitsIdentifiers` | object | Rates and Benefits Details Object |\r\n| `additionalInfo` | string | Rates and Benefits Additional Info |\r\n| `description` | string | Rates and Benefits Description |\r\n| `featured` | string | If is allowed to acumulate the Rates and Benefits |\r\n| `matchedParameters` | object | March Parameters Array |\r\n| `name` | string | Rates and Benefits Name |\r\n| `roundingError` | integer | Rounding Error Total Amount |\r\n| `salesChannel` | string | Order Sales Channel Id |\r\n| `sellerOrderId` | string | Order Seller Id |\r\n| `sellers` | object | Sellers Array |\r\n| `id` | string | Seller Id |\r\n| `logo` | string | URL Seller Logo |\r\n| `name` | string | Seller Name |\r\n| `sequence` | string | Order Sequence ID |\r\n| `shippingData` | object | Shipping Data Object |\r\n| `address` | object | Shipping Address |\r\n| `addressId` | string | Shipping Address Id |\r\n| `addressType` | string | Shipping Address Type |\r\n| `city` | string | Shipping City |\r\n| `complement` | string | Shipping Complement |\r\n| `country` | string | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `geoCoordinates` | object | Shipping Geo Coordinates Array |\r\n| `neighborhood` | string | Shipping Neighborhood |\r\n| `number` | string | Shipping Number |\r\n| `postalCode` | string | Shipping Postal Code |\r\n| `receiverName` | string | Shipping Receiver Name |\r\n| `reference` | string | Shipping Reference |\r\n| `state` | string | Shipping State |\r\n| `street` | string | Shipping Street |\r\n| `id` | string | Object ID, expected value \"shippingData\"|\r\n| `logisticsInfo` | object | Logistics Info Object |\r\n| `addressId` | string | Adress Id |\r\n| `deliveryChannel` | string | Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\" |\r\n| `deliveryCompany` | string | Courier Company Name |\r\n| `deliveryIds` | object | Delivery Ids Object |\r\n| `courierId` | string | Courier Id |\r\n| `courierName` | string | Courier Name |\r\n| `dockId` | string | Releated Dock Id |\r\n| `quantity` | integer | Items Quantity |\r\n| `warehouseId` | string | Releated Warehouse Id |\r\n| `deliveryWindow` | object | Delivery Window Object |\r\n| `endDateUtc` | string | Delivery Date End in UTC |\r\n| `price` | string | Delivery Window Cost |\r\n| `startDateUtc` | string | Delivery Date Starts in UTC |\r\n| `itemIndex` | integer | Logistic Info Item Index |\r\n| `listPrice` | integer | Logistic Info Item List Price |\r\n| `lockTTL` | string | Stock reservation waiting period |\r\n| `pickupStoreInfo` | object | Pickup Store Info Object |\r\n| `additionalInfo` | string | Pickup Store Additional Info |\r\n| `address` | string | Pickup Store Address |\r\n| `dockId` | string | Pickup Store Releated Dock Id |\r\n| `friendlyName` | string | Pickup Store Friendly Name |\r\n| `isPickupStore` | boolean | If is a Pickup Store |\r\n| `polygonName` | string | Releated Polygom Name |\r\n| `price` | integer | Logistic Info Item Price |\r\n| `selectedSla` | string | Selected SLA |\r\n| `sellingPrice` | integer | Logistic Info Item Selling Price |\r\n| `shippingEstimate` | string | Estimate Shipping Duration |\r\n| `shippingEstimateDate` | string | Estimate Shipping Date |\r\n| `shipsTo` | object | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `slas` | object | SLAs Object |\r\n| `deliveryChannel` | string | Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\" |\r\n| `deliveryWindow` | object | Delivery Window Object |\r\n| `endDateUtc` | string | Delivery Date End in UTC |\r\n| `price` | string | Delivery Window Cost |\r\n| `startDateUtc` | string | Delivery Date Starts in UTC |\r\n| `id` | string | SLA Id |\r\n| `pickupStoreInfo` | object | Pickup Store Details Object |\r\n| `additionalInfo` | string | Pickup Store Additional Info |\r\n| `address` | string | Pickup Store Address |\r\n| `dockId` | string | Pickup Store releated Dock Id |\r\n| `friendlyName` | string | Pickup Store Friendly Name |\r\n| `isPickupStore` | boolean | If is a Pickup Store |\r\n| `polygonName` | string | Releated Polygon Name |\r\n| `price` | integer | SLA Price |\r\n| `shippingEstimate` | string | SLA Shipping Estimate |\r\n| `selectedAddresses` | object | Selected Address Details Object |\r\n| `addressId` | string | Shipping Address Id |\r\n| `addressType` | string | Shipping Address Type |\r\n| `city` | string | Shipping City |\r\n| `complement` | string | Shipping Complement |\r\n| `country` | string | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `geoCoordinates` | object | Shipping Geo Coordinates Array |\r\n| `neighborhood` | string | Shipping Neighborhood |\r\n| `number` | string | Shipping Number |\r\n| `postalCode` | string | Shipping Postal Code |\r\n| `receiverName` | string | Shipping Receiver Name |\r\n| `reference` | string | Shipping Reference |\r\n| `state` | string | Shipping State |\r\n| `street` | string | Shipping Street |\r\n| `trackingHints` | array | Array of tracking hint objects, containing `\"courierName\"`, `\"trackingId\"`, `\"trackingLabel\"`, and `\"trackingUrl\"` |\r\n| `status` | string | Order Status |\r\n| `statusDescription` | string | Status Description |\r\n| `storePreferencesData` | object | Store Preferences Data Object |\r\n| `countryCode` | string | Country Code in ISO 3166 ALPHA-3 abbreviation |\r\n| `currencyCode` | string | Currency Code in ISO 4217 |\r\n| `currencyFormatInfo` | object | Currency Format Info Object |\r\n| `CurrencyDecimalDigits` | integer | Currency Decimal Digits |\r\n| `CurrencyDecimalSeparator` | string | Currency Decimal Separator |\r\n| `CurrencyGroupSeparator` | string | Currency Group Separator |\r\n| `CurrencyGroupSize` | integer | Currency Group Size |\r\n| `StartsWithCurrencySymbol` | boolean | If Starts With Currency Symbol |\r\n| `currencyLocale` | integer | LCID Decimal |\r\n| `currencySymbol` | string | Currency Symbol |\r\n| `timeZone` | string | Order Time Zone |\r\n| `totals` | object | Totals Object |\r\n| `id` | string | Totals Ids, expected values: \"Items\", \"Discounts\", \"Shipping\" and \"Tax\" |\r\n| `name` | string | Totals ID Description |\r\n| `value` | integer | Totals Value |\r\n| `value` | integer | Order Value |\r\n",
"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": {
"title": "",
"type": "object",
"properties": {
"emailTracked": {
"type": "string",
"description": "Email tracked.",
"example": "clark.kent@example.com"
},
"approvedBy": {
"type": "string",
"description": "User that approved the order, in case of manual approval.",
"example": "alex@store.com"
},
"cancelledBy": {
"type": "string",
"description": "User that canceled the order.",
"example": "alex@store.com"
},
"cancelReason": {
"type": "string",
"description": "Reason for cancelation.",
"example": "Stock shortage."
},
"orderId": {
"type": "string",
"description": "Order ID.",
"example": "v5195004lux-01"
},
"sequence": {
"type": "string",
"description": "Sequence number.",
"example": "502556"
},
"marketplaceOrderId": {
"type": "string",
"description": "ID of the order in the marketplace.",
"example": "ABC-v5195004lux-01"
},
"marketplaceServicesEndpoint": {
"type": "string",
"description": "Marketplace endpoint for post purchase communication.",
"example": "http://oms.vtexinternal.com.br/api/oms?an=luxstore"
},
"sellerOrderId": {
"type": "string",
"description": "Seller order ID.",
"example": "00-v5195004lux-01"
},
"origin": {
"type": "string",
"description": "Origin.",
"example": "Marketplace"
},
"affiliateId": {
"type": "string",
"description": "Three letter code identifying the marketplace where the order was placed.",
"example": "ABC"
},
"salesChannel": {
"type": "string",
"description": "Sales channel.",
"example": "1"
},
"merchantName": {
"type": "string",
"description": "Merchant name.",
"example": "luxstore"
},
"status": {
"type": "string",
"description": "Status in the order workflow.",
"example": "invoiced"
},
"statusDescription": {
"type": "string",
"description": "Status description which is displayed on the Admin panel.",
"example": "Faturado"
},
"value": {
"type": "integer",
"format": "int32",
"description": "Value in cents.",
"example": 2499
},
"creationDate": {
"type": "string",
"description": "Creation date.",
"example": "2019-01-28T20:09:43+00:00"
},
"lastChange": {
"type": "string",
"description": "Date of last change.",
"example": "2019-02-06T20:46:11.7010747+00:00"
},
"orderGroup": {
"type": "string",
"description": "Order group.",
"example": "00"
},
"totals": {
"type": "array",
"description": "Information on each of the order's totals.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Order's total ID.",
"example": "Discounts"
},
"name": {
"type": "string",
"description": "Order's total name.",
"example": "Discount total."
},
"value": {
"type": "integer",
"format": "int32",
"description": "Order's total value.",
"example": 199
}
}
}
},
"items": {
"type": "array",
"description": "Information on each item in the order.",
"items": {
"type": "object",
"properties": {
"uniqueId": {
"type": "string",
"description": "Order's item unique ID."
},
"id": {
"type": "string",
"description": "ID."
},
"productId": {
"type": "string",
"description": "Product ID."
},
"productRefId": {
"type": "string",
"description": "Product Ref ID."
},
"refId": {
"type": "string",
"description": "Ref ID."
},
"ean": {
"type": "string",
"description": "European Article Number."
},
"name": {
"type": "string",
"description": "Name."
},
"skuName": {
"type": "string",
"description": "SKU name."
},
"modalType": {
"type": "string",
"description": "Modal type."
},
"parentItemIndex": {
"type": "integer",
"description": "Parent item index."
},
"parentAssemblyBinding": {
"type": "string",
"description": "Parent assembly binding."
},
"priceValidUntil": {
"type": "string",
"description": "Price expiration date and time."
},
"tax": {
"type": "integer",
"description": "Tax value in cents."
},
"price": {
"type": "integer",
"description": "Price in cents."
},
"listPrice": {
"type": "integer",
"description": "List price in cents."
},
"manualPrice": {
"type": "integer",
"description": "Manual price in cents."
},
"manualPriceAppliedBy": {
"type": "string",
"description": "User that applied the manual price, if that is the case."
},
"sellingPrice": {
"type": "integer",
"description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
},
"rewardValue": {
"type": "integer",
"description": "Reward value in cents."
},
"isGift": {
"type": "boolean",
"description": "Indicates whether item is a gift."
},
"additionalInfo": {
"type": "object",
"description": "Additional information.",
"properties": {
"dimension": {
"type": "string",
"description": "Dimension."
},
"brandName": {
"type": "string",
"description": "Brand name."
},
"brandId": {
"type": "string",
"description": "Brand ID."
},
"offeringInfo": {
"type": "string",
"description": "Offering information."
},
"offeringType": {
"type": "string",
"description": "Offering type."
},
"offeringTypeId": {
"type": "string",
"description": "Offering type ID."
}
}
},
"preSaleDate": {
"type": "string",
"description": "Presale date."
},
"productCategoryIds": {
"type": "string",
"description": "Product category IDs."
},
"productCategories": {
"type": "object",
"description": "Object, where each field is an ID from `productCategoryIds.",
"properties": {
"{ID}": {
"type": "string",
"description": "Product category corresponding to the ID in the field key."
}
}
},
"quantity": {
"type": "integer",
"description": "Quantity."
},
"seller": {
"type": "string",
"description": "Seller."
},
"sellerChain": {
"type": "array",
"description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
"items": {
"type": "string",
"description": "Seller."
}
},
"imageUrl": {
"type": "string",
"description": "Image URL."
},
"detailUrl": {
"type": "string",
"description": "Detail URL."
},
"bundleItems": {
"type": "array",
"description": "Information on services sold along with the SKU. Example: a gift package.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type"
},
"id": {
"type": "integer",
"description": "Service identifier."
},
"name": {
"type": "string",
"description": "Name."
},
"price": {
"type": "integer",
"description": "Price in cents."
}
}
}
},
"attachments": {
"type": "array",
"description": "Array containing information on attachments.",
"items": {
"type": "string"
}
},
"priceTags": {
"type": "array",
"description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
"items": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "Price tag identifier."
},
"isPercentual": {
"type": "boolean",
"description": "Indicates whether price tag value is applied through a percentage."
},
"name": {
"type": "string",
"description": "Name."
},
"rawValue": {
"type": "integer",
"description": "Raw value."
},
"value": {
"type": "integer",
"description": "Value."
}
}
}
},
"availability": {
"type": "string",
"description": "Availability"
},
"measurementUnit": {
"type": "string",
"description": "Measurement unit"
},
"unitMultiplier": {
"type": "integer",
"description": "Unit multiplier"
},
"manufacturerCode": {
"type": "string",
"description": "Manufacturer code."
},
"priceDefinition": {
"type": "object",
"description": "Price information.",
"properties": {
"calculatedSellingPrice": {
"type": "integer",
"description": "Calculated selling price in cents."
},
"total": {
"type": "integer",
"description": "Total in cents."
},
"sellingPrices": {
"type": "array",
"description": "Selling prices.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Value in cents."
},
"quantity": {
"type": "integer",
"description": "Quantity."
}
}
}
}
}
}
}
}
},
"marketplaceItems": {
"type": "array",
"description": "Marketplace items.",
"items": {
"type": "string"
}
},
"clientProfileData": {
"$ref": "#/components/schemas/ClientProfileData"
},
"giftRegistryData": {
"type": "string",
"nullable": true,
"description": "Gift registry data."
},
"marketingData": {
"type": "string",
"nullable": true,
"description": "Marketing data."
},
"ratesAndBenefitsData": {
"$ref": "#/components/schemas/RatesAndBenefitsData"
},
"shippingData": {
"$ref": "#/components/schemas/ShippingData"
},
"paymentData": {
"$ref": "#/components/schemas/PaymentData"
},
"packageAttachment": {
"type": "object",
"description": "Package attachment.",
"properties": {
"packages": {
"type": "array",
"description": "Information on each package.",
"items": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "Information on each item in the package.",
"items": {
"type": "object",
"properties": {
"itemIndex": {
"type": "integer",
"description": "Item index in reference to the position of the item in the `items` array."
},
"quantity": {
"type": "integer",
"description": "Item quantity."
},
"price": {
"type": "integer",
"description": "Item price in cents."
},
"description": {
"type": "string",
"description": "Item description."
},
"unitMultiplier": {
"type": "number",
"description": "Item unit multiplier."
}
}
}
},
"courier": {
"type": "string",
"description": "Courier."
},
"invoiceNumber": {
"type": "string",
"description": "Invoice number."
},
"invoiceValue": {
"type": "integer",
"description": "Invoice value in cents."
},
"invoiceUrl": {
"type": "string",
"description": "Invoice URL."
},
"issuanceDate": {
"type": "string",
"description": "Issuance date."
},
"trackingNumber": {
"type": "string",
"description": "Tracking number."
},
"invoiceKey": {
"type": "string",
"description": "Invoice key."
},
"trackingUrl": {
"type": "string",
"description": "Tracking URL."
},
"embeddedInvoice": {
"type": "string",
"description": "Embedded voice in XML."
},
"type": {
"type": "string",
"description": "Invoice type `Output` for sales and `Input` for returns."
},
"courierStatus": {
"type": "string",
"description": "Courier status."
},
"cfop": {
"type": "string",
"description": "Fiscal operation code."
},
"restitutions": {
"type": "object",
"description": "Information on how restitutions are to be made to the customer, in case of a return (invoice `type` is `input`).",
"properties": {
"refund": {
"type": "object",
"description": "Information on refunds.",
"properties": {
"items": {
"type": "array",
"description": "Information on items.",
"items": {
"type": "object",
"properties": {
"itemIndex": {
"type": "string",
"description": "Item index corresponding to the position of the item in the main `items` array."
},
"quantity": {
"type": "integer",
"description": "Quantity."
}
}
}
}
}
}
}
},
"volumes": {
"type": "integer",
"description": "Quantity of packages involved in the order."
}
}
}
}
},
"example": {
"packages": []
}
},
"sellers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Seller"
},
"description": "Array with sellers information."
},
"callCenterOperatorData": {
"type": "string",
"nullable": true,
"description": "Call center operator data."
},
"followUpEmail": {
"type": "string",
"description": "Follow up email."
},
"lastMessage": {
"type": "string",
"nullable": true,
"description": "Last message."
},
"hostname": {
"type": "string",
"description": "Host name."
},
"invoiceData": {
"type": "object",
"description": "Information pertinent to the order's invoice.",
"nullable": true
},
"changesAttachment": {
"$ref": "#/components/schemas/ChangesAttachment"
},
"openTextField": {
"type": "string",
"nullable": true,
"description": "Open text field."
},
"roundingError": {
"type": "integer",
"format": "int32",
"description": "Rounding error in cents."
},
"orderFormId": {
"type": "string",
"description": "ID of the shopping cart from which the order was created."
},
"commercialConditionData": {
"type": "string",
"nullable": true,
"description": "Commercial condition data."
},
"isCompleted": {
"type": "boolean",
"description": "Indicates whether order is completed."
},
"customData": {
"type": "string",
"nullable": true,
"description": "Custom data."
},
"storePreferencesData": {
"$ref": "#/components/schemas/StorePreferencesData"
},
"allowCancellation": {
"type": "boolean",
"description": "Indicates whether cancelation is allowed for the order."
},
"allowEdition": {
"type": "boolean",
"description": "Indicates whether edition is allowed for the order."
},
"isCheckedIn": {
"type": "boolean",
"description": "Indicates whether client is checked in."
},
"marketplace": {
"$ref": "#/components/schemas/Marketplace"
},
"authorizedDate": {
"type": "string",
"description": "Date in which the order was authorized in UTC."
},
"invoicedDate": {
"type": "string",
"description": "Date in which the order was invoiced in UTC."
}
},
"example": {
"emailTracked": "a27499cad31f42b7a771ae34f57c8358@ct.vtex.com.br",
"approvedBy": null,
"cancelledBy": null,
"cancelReason": null,
"orderId": "v5195004lux-01",
"sequence": "502556",
"marketplaceOrderId": "",
"marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
"sellerOrderId": "00-v5195004lux-01",
"origin": "Marketplace",
"affiliateId": "",
"salesChannel": "1",
"merchantName": null,
"status": "handling",
"statusDescription": "Preparando Entrega",
"value": 1160,
"creationDate": "2019-01-28T20:09:43.899958+00:00",
"lastChange": "2019-02-06T20:46:11.7010747+00:00",
"orderGroup": null,
"totals": [
{
"id": "Items",
"name": "Total dos Itens",
"value": 3290
},
{
"id": "Discounts",
"name": "Total dos Descontos",
"value": 0
},
{
"id": "Shipping",
"name": "Total do Frete",
"value": 1160
},
{
"id": "Tax",
"name": "Total da Taxa",
"value": 0
},
{
"id": "Change",
"name": "Total das mudanças",
"value": -3290
}
],
"items": [
{
"uniqueId": "87F0945396994B349158C7D9C9941442",
"id": "1234568358",
"productId": "9429485",
"ean": null,
"lockId": "00-v5195004lux-01",
"itemAttachment": {
"content": {},
"name": null
},
"attachments": [],
"quantity": 1,
"seller": "1",
"name": "Bay Max L",
"refId": "BIGHEROBML",
"price": 3290,
"listPrice": 3290,
"manualPrice": null,
"priceTags": [],
"imageUrl": "http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000",
"detailUrl": "/bay-max-9429485/p",
"components": [],
"bundleItems": [],
"params": [],
"offerings": [],
"sellerSku": "1234568358",
"priceValidUntil": null,
"commission": 0,
"tax": 0,
"preSaleDate": null,
"additionalInfo": {
"brandName": "VTEX",
"brandId": "2000023",
"categoriesIds": "/1/",
"productClusterId": "135,142",
"commercialConditionId": "5",
"dimension": {
"cubicweight": 0.7031,
"height": 15,
"length": 15,
"weight": 15,
"width": 15
},
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null
},
"measurementUnit": "un",
"unitMultiplier": 1,
"sellingPrice": 3290,
"isGift": false,
"shippingPrice": null,
"rewardValue": 0,
"freightCommission": 0,
"priceDefinitions": null,
"taxCode": null,
"parentItemIndex": null,
"parentAssemblyBinding": null
}
],
"marketplaceItems": [],
"clientProfileData": {
"id": "clientProfileData",
"email": "rodrigo.cunha@vtex.com.br",
"firstName": "Rodrigo",
"lastName": "VTEX",
"documentType": "cpf",
"document": "11047867702",
"phone": "+5521972321094",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"stateInscription": null,
"corporatePhone": null,
"isCorporate": false,
"userProfileId": "5a3692de-358a-4bea-8885-044bce33bb93",
"customerClass": null
},
"giftRegistryData": null,
"marketingData": null,
"ratesAndBenefitsData": {
"id": "ratesAndBenefitsData",
"rateAndBenefitsIdentifiers": []
},
"shippingData": {
"id": "shippingData",
"address": {
"addressType": "residential",
"receiverName": "Rodrigo Cunha",
"addressId": "-1425945657910",
"postalCode": "22250-040",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Praia de Botafogo",
"number": "300",
"neighborhood": "Botafogo",
"complement": "3",
"reference": null,
"geoCoordinates": []
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Normal",
"lockTTL": "10d",
"price": 1160,
"listPrice": 1160,
"sellingPrice": 1160,
"deliveryWindow": null,
"deliveryCompany": "Todos os CEPS",
"shippingEstimate": "5bd",
"shippingEstimateDate": "2019-02-04T20:33:46.4595004+00:00",
"slas": [
{
"id": "Normal",
"name": "Normal",
"shippingEstimate": "5bd",
"deliveryWindow": null,
"price": 1160,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": null
},
{
"id": "Expressa",
"name": "Expressa",
"shippingEstimate": "5bd",
"deliveryWindow": null,
"price": 1160,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": null
},
{
"id": "Quebra Kit",
"name": "Quebra Kit",
"shippingEstimate": "2bd",
"deliveryWindow": null,
"price": 1392,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": null
},
{
"id": "Sob Encomenda",
"name": "Sob Encomenda",
"shippingEstimate": "32bd",
"deliveryWindow": null,
"price": 1392,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": null
}
],
"shipsTo": ["BRA"],
"deliveryIds": [
{
"courierId": "197a56f",
"courierName": "Todos os CEPS",
"dockId": "1",
"quantity": 1,
"warehouseId": "1_1"
}
],
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"addressId": "-1425945657910",
"polygonName": null
}
],
"trackingHints": null,
"selectedAddresses": [
{
"addressId": "-1425945657910",
"addressType": "residential",
"receiverName": "Rodrigo Cunha",
"street": "Praia de Botafogo",
"number": "518",
"complement": "10",
"neighborhood": "Botafogo",
"postalCode": "22250-040",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"reference": null,
"geoCoordinates": []
}
]
},
"paymentData": {
"transactions": [
{
"isActive": true,
"transactionId": "418213DE29634837A63DD693A937A696",
"merchantName": "luxstore",
"payments": [
{
"id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
"paymentSystem": "6",
"paymentSystemName": "Boleto Bancário",
"value": 4450,
"installments": 1,
"referenceValue": 4450,
"cardHolder": null,
"cardNumber": null,
"firstDigits": null,
"lastDigits": null,
"cvv2": null,
"expireMonth": null,
"expireYear": null,
"url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
"giftCardId": null,
"giftCardName": null,
"giftCardCaption": null,
"redemptionCode": null,
"group": "bankInvoice",
"tid": null,
"dueDate": "2019-02-02",
"connectorResponses": {}
}
]
}
]
},
"packageAttachment": {
"packages": []
},
"sellers": [
{