forked from vtex/openapi-schemas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VTEX - Marketplace Protocol - External Seller Fulfillment.json
2312 lines (2312 loc) · 156 KB
/
VTEX - Marketplace Protocol - External Seller Fulfillment.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": "Marketplace Protocol",
"description": "\r\nThe _Marketplace Protocol_ is a set of API requests and definitions to help you integrate external sellers into a VTEX marketplace as well as external marketplaces into VTEX sellers.\r\n\r\n## External Seller\r\n\r\nHere you will find the endpoints involved in the integration between a VTEX marketplace and an external seller. Note that some of these requests are typically sent by the seller while others are received.\r\n\r\n| **Request** | **From** | **To** |\r\n|-|-|-|\r\n| [Fulfillment simulation](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orderForms/simulation) | Marketplace | Seller |\r\n| [Order placement](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders) | Marketplace | Seller |\r\n| [Authorize fulfillment](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders/-sellerOrderId-/fulfill) | Marketplace | Seller |\r\n| [Marketplace order cancellation](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders/-orderId-/cancel) | Marketplace | Seller |\r\n| [Send invoice](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/invoice) | Seller | Marketplace |\r\n| [Send tracking information](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/invoice/-invoiceNumber-) | Seller | Marketplace |\r\n| [Update tracking status](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/invoice/-invoiceNumber-/tracking) | Seller | Marketplace |\r\n| [Cancel order in marketplace](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/cancel) | Seller | Marketplace |\r\n\r\nFor a detailed explanation of the steps required to develop a custom connector to sell products from an external seller in your storefront, check out our complete [External Seller Integration Guide](https://developers.vtex.com/docs/guides/external-seller-integration-guide).\r\n\r\n\r\n## External Marketplace\r\n\r\nIn this section, you will find the endpoints involved in the VTEX integration between an external marketplace and a VTEX seller.\r\n\r\n\r\n| **Request** | **From** | **To** |\r\n|-|-|-|\r\n| [VTEX Mapper Registration](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper#post-/api/mkp-category-mapper/connector/register) | External marketplace | VTEX system |\r\n| [Send Category Mapping to VTEX Mapper](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper#post-/api/mkp-category-mapper/categories/marketplace/-id-) | External marketplace | VTEX system |\r\n| [New Order Integration](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/order-integration/orders) | External marketplace | VTEX system |\r\n| [Update Order Status](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#put-/api/order-integration/orders/status) | External marketplace | VTEX system |\r\n| [Fulfillment simulation - External Marketplace](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/checkout/pub/orderForms/simulation) | External marketplace | VTEX system |\r\n| [Place fulfillment order](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/fulfillment/pvt/orders) | External marketplace | VTEX Seller |\r\n| [Authorize dispatch for fulfillment order](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/fulfillment/pvt/orders/-orderId-/fulfill) | External marketplace | VTEX Seller |\r\n\r\n\r\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide).",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "https://{fulfillmentEndpoint}",
"description": "Fulfillment Endpoint",
"variables": {
"fulfillmentEndpoint": {
"description": "This is the fulfillment endpoint registered for each specific external seller in the **seller management** section of VTEX's admin panel.",
"default": "{fulfillmentEndpoint}"
}
}
}
],
"paths": {
"/pvt/orderForms/simulation": {
"post": {
"tags": [
"External Seller"
],
"summary": "Fulfillment simulation - External Seller",
"description": "This endpoint may be called upon by VTEX for fulfillment simulation in the external seller different contexts. See examples below.\n\nWhen a [price](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/price) or [inventory](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/inventory) notification request returns a response with status `200 OK`, it means that the SKU already exists in the marketplace. Whenever this happens, the marketplace will call the seller to get two updated information about the SKU: Price and Inventory.\n\nThe seller needs to have an endpoint implemented in order to receive this call and send a response containing the requested information to the marketplace. We call it the Fulfillment Simulation endpoint.\n\nIf the seller wishes to include other parameters in this call (like account name, or [sales channel](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV) ID), this should be done within their {fulfillmentEndpoint}. This path is then inserted in the marketplace's VTEX admin when [configuring a seller](https://help.vtex.com/en/tutorial/configurando-seller--tutorials_392). \n\nThe marketplace will send an object containing an array of items. The seller must use this list to get the updated information about the referred SKUs and send them back to the marketplace, following the response format explained in the API Reference. \n\nThis call is also applied in the Storefront simulation scenario, in which case the request from VTEX does not send the paramenters `country` and `postalCode`. \nThe call's payload can be adapted into two scenarios: \n\n- **Displaying items in the storefront**: the address information can be nulled in the request, since they are not mandatory data for this context. \n- **Making a shopping cart simulation during checkout**: address information must be sent, since this data is needed to calculate freight values. If the address information (including `postalCode` and `country`) is not sent through the call, VTEX interprets the stock balance as zero. Without a valid stock balance, the seller will not be shown as an option during checkout. \n \n## Request body example - Indexing simulation\n\n```\n{\n \"items\": [\n {\n \"id\": \"7908010136043\",\n \"quantity\": 1,\n \"seller\": \"1\",\n }\n ],\n \"isCheckedIn\": false,\n }\n``` \n## Request body example - Checkout simulation\n\n```\n{\n \"items\": [\n {\n \"id\": \"7908010136043\",\n \"quantity\": 1,\n \"seller\": \"1\",\n }\n ],\n \"postalCode\": \"22270-030\",\n \"country\": \"BRA\",\n }\n```",
"operationId": "fulfillment-simulation",
"parameters": [
{
"name": "fulfillmentEndpoint",
"in": "path",
"description": "This is the fulfillment endpoint registered for each specific external seller in the **seller management** section of VTEX's admin panel.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "marketplaceexample.externalseller.com"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"required": [
"postalCode"
],
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"description": "Delivery address postal code. This field is mandatory for shopping carts simulations, where both Country and Postal Code are required. This field should be sent as `null` for storefront simulations, where the information is not necessary.",
"example": "12345678"
},
"geoCoordinates": {
"type": "array",
"description": "Geographic coordinates of the delivery address. This may be used instead of the postalCode, in case the marketplace is configured to accept geolocation. Example of value: `[-22.9443504,-43.1825635]`.",
"items": {
"type": "string",
"example": "00.00000000"
}
},
"country": {
"type": "string",
"description": "ISO 3-digit code of the country where the delivery address is located. This field is mandatory, for shopping carts simulations, where both Country and Postal Code are required. This field should be sent as `null` for storefront simulations, where the information is not necessary.",
"example": "USA"
},
"items": {
"type": "array",
"description": "Array containing the cart items.",
"items": {
"$ref": "#/components/schemas/fulfillmentItem"
}
},
"sc": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) associated to the seller account created.",
"example": "1"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"title": "Response body",
"description": "Expected response body of fulfillment simulation",
"type": "object",
"required": [
"country",
"items",
"logisticsInfo",
"postalCode"
],
"example": {
"country": "BRA",
"items": [
{
"id": "2000037",
"listPrice": 67203,
"measurementUnit": "un",
"merchantName": "mySeller1",
"offerings": [
{
"type": "Warranty",
"id": "5",
"name": "1 year warranty",
"price": 10000
}
],
"price": 67203,
"priceTags": [],
"priceValidUntil": "2014-03-01T22:58:28.143",
"quantity": 1,
"requestIndex": 0,
"seller": "1",
"unitMultiplier": 1
}
],
"logisticsInfo": [
{
"itemIndex": 0,
"quantity": 1,
"shipsTo": [
"BRA"
],
"slas": [
{
"id": "Curbside pickup",
"deliveryChannel": "pickup-in-point",
"name": "Curbside pickup",
"shippingEstimate": "0bd",
"price": 0,
"availableDeliveryWindows": [
{
"startDateUtc": "2013-02-04T08:00:00+00:00",
"endDateUtc": "2013-02-04T13:00:00+00:00",
"price": 0
}
],
"pickupStoreInfo": {
"isPickupStore": true,
"friendlyName": "Santa Felicidade",
"address": {
"addressType": "pickup",
"receiverName": "Juliana",
"addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
"postalCode": "82320-040",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Domingos Strapasson",
"number": "100",
"neighborhood": "Santa Felicidade",
"complement": "Loja 10",
"reference": "Next to the unicorn statue",
"geoCoordinates": [
49.334934,
25.401705
]
},
"additionalInfo": ""
}
}
],
"stockBalance": 199,
"deliveryChannels": [
{
"id": "delivery",
"stockBalance": 179
},
{
"id": "pickup-in-point",
"stockBalance": 20
}
]
}
],
"postalCode": "80250000",
"allowMultipleDeliveries": true
},
"properties": {
"country": {
"title": "Country",
"description": "ISO 3-digit code of the country where the delivery address is located. If you don’t want to send it, use the value null.",
"type": "string",
"example": "BRA"
},
"items": {
"title": "Items",
"description": "Contains the data about each SKU in the cart.",
"type": "array",
"items": {
"title": "Items",
"description": "Contains the data about each SKU in the cart.",
"type": "object",
"required": [
"id",
"listPrice",
"measurementUnit",
"merchantName",
"offerings",
"price",
"priceTags",
"priceValidUntil",
"quantity",
"requestIndex",
"seller",
"unitMultiplier"
],
"properties": {
"id": {
"title": "id",
"description": "SKU ID",
"type": "string",
"example": "2000037"
},
"listPrice": {
"title": "listPrice",
"description": "List price. It’s the amount presented to the customer as a “previous” price that has been lowered due to a discount. Don’t separate the decimal places. The last two digits are the cents.",
"type": "integer",
"example": 67203
},
"measurementUnit": {
"title": "measurementUnit",
"description": "SKU’s measurement unit.",
"type": "string",
"example": "un"
},
"merchantName": {
"title": "merchantName",
"description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Payments in VTEX marketplaces](https://help.vtex.com/en/tutorial/payments-in-vtex-marketplaces--2kYOfWCZYweJkYl18bw9yD) article to know more.",
"type": "string",
"example": "mySeller1"
},
"offerings": {
"title": "offerings",
"description": "Services that may be offered for this SKU. example are the assembly of a piece of furniture or warranty. In case these information are sent, the following fields are mandatory. If you don’t want to send it, use an empty array.",
"type": "array",
"items": {
"title": "offerings",
"description": "Services that may be offered for this SKU. example are the assembly of a piece of furniture or warranty. In case these information are sent, the following fields are mandatory. If you don’t want to send it, use an empty array.",
"type": "object",
"required": [
"type",
"id",
"name",
"price"
],
"properties": {
"type": {
"title": "type",
"description": "Type of the service.",
"type": "string",
"example": "Warranty"
},
"id": {
"title": "id",
"description": "Service ID.",
"type": "string",
"example": "5"
},
"name": {
"title": "name",
"description": "Service name.",
"type": "string",
"example": "1 year warranty"
},
"price": {
"title": "price",
"description": "Service price. The last two digits are the cents.",
"type": "integer",
"example": 10000
}
}
},
"example": [
{
"type": "Warranty",
"id": "5",
"name": "1 year warranty",
"price": 10000
}
]
},
"price": {
"title": "price",
"description": "Actual selling price of the SKU. Don’t separate the decimal places. The last two digits are the cents.",
"type": "integer",
"example": 67203
},
"priceTags": {
"title": "priceTags",
"description": "List with the promotions applied to the SKU.",
"type": "array",
"items": {
"title": "priceTags",
"description": "Promotions applied to the SKU.",
"type": "string",
"example": "promotion 1"
}
},
"priceValidUntil": {
"title": "priceValidUntil",
"description": "Expiration date of the SKU price. Example: `2014-03-01T22:58:28.143`. In case you don’t want to send it, use the value null.",
"type": "string",
"example": "2014-03-01T22:58:28.143",
"nullable": true
},
"quantity": {
"title": "quantity",
"description": "Quantity of the item. The seller should send the quantity that was indicated in the request, or the maximum quantity possible.",
"type": "integer",
"default": 0,
"example": 1
},
"requestIndex": {
"title": "requestIndex",
"description": "Position of this item in the original array (request).",
"type": "integer",
"example": 0
},
"seller": {
"title": "seller",
"description": "ID of the seller as registered in VTEX. You should send the same value that came in the request.",
"type": "string",
"example": "1"
},
"unitMultiplier": {
"title": "unitMultiplier",
"description": "SKU unit multiplier. The default value is 1.",
"type": "integer",
"example": 1
}
}
},
"example": [
{
"id": "2000037",
"listPrice": 67203,
"measurementUnit": "un",
"merchantName": "mySeller1",
"offerings": [
{
"type": "Warranty",
"id": "5",
"name": "1 year warranty",
"price": 10000
}
],
"price": 67203,
"priceTags": [],
"priceValidUntil": "2014-03-01T22:58:28.143",
"quantity": 1,
"requestIndex": 0,
"seller": "1",
"unitMultiplier": 1
}
]
},
"logisticsInfo": {
"title": "logisticsInfo",
"description": "Array that contains the data regarding the delivery methods and stock for each item. If all products are unavailable, this field should return empty.",
"type": "array",
"items": {
"title": "A Schema",
"description": "An explanation about the purpose of this instance.",
"type": "object",
"required": [
"itemIndex",
"quantity",
"shipsTo",
"slas",
"stockBalance",
"deliveryChannels"
],
"properties": {
"itemIndex": {
"title": "itemIndex",
"description": "Position of this item in the original array, i.e., in the array that came with the request. This index is what identifies which SKU you are referring to for each object inside the logisticsInfo.",
"type": "integer",
"example": 0
},
"quantity": {
"title": "quantity",
"description": "Quantity of the item. The seller should send the quantity that was indicated in the request, or the maximum quantity possible.",
"type": "integer",
"example": 1
},
"shipsTo": {
"title": "shipsTo",
"description": "ISO 3-digit code of the countries to where the SKU is delivered.",
"type": "array",
"items": {
"title": "shipsTo",
"description": "Array of country codes",
"type": "string",
"example": "BRA"
},
"example": [
"BRA",
"BOL"
]
},
"slas": {
"title": "slas",
"description": "Contains the available delivery methods.",
"type": "array",
"items": {
"title": "slas",
"description": "Object with delivery methods information.",
"type": "object",
"required": [
"id",
"deliveryChannel",
"name",
"price",
"shippingEstimate",
"availableDeliveryWindows",
"pickupStoreInfo"
],
"properties": {
"id": {
"title": "id",
"description": "Identifier of the delivery method.",
"type": "string",
"example": "Curbside pickup"
},
"deliveryChannel": {
"title": "deliveryChannel",
"description": "Type of delivery channel. The values that are possible are: `pickup-in-point` for pickup point and `delivery` for regular delivery.",
"type": "string",
"example": "pickup-in-point"
},
"name": {
"title": "name",
"description": "Name of the delivery method.",
"type": "string",
"example": "Curbside pickup"
},
"price": {
"title": "price",
"description": "Delivery price. The two last digits are the cents.",
"type": "integer",
"example": 846
},
"shippingEstimate": {
"title": "shippingEstimate",
"description": "Time estimated for the delivery. Possible suffixes are `bd` for *business day* , `h` for *hours*, and `m` for *minutes*.",
"type": "string",
"example": "19bd"
},
"availableDeliveryWindows": {
"title": "availableDeliveryWindows",
"description": "Contains the delivery windows available for the SLA.",
"type": "array",
"items": {
"title": "availableDeliveryWindows",
"description": "Object with delivery windows information.",
"type": "object",
"required": [
"startDateUtc",
"endDateUtc",
"price"
],
"properties": {
"startDateUtc": {
"title": "startDateUtc",
"description": "Start date of the delivery window.",
"type": "string",
"example": "2013-02-04T08:00:00+00:00"
},
"endDateUtc": {
"title": "endDateUtc",
"description": "End date of the delivery window.",
"type": "string",
"example": "2013-02-04T13:00:00+00:00"
},
"price": {
"title": "price",
"description": "Extra price for scheduled delivery. The last two digits are the cents.",
"type": "integer",
"example": 0
}
},
"example": {
"startDateUtc": "2013-02-04T08:00:00+00:00",
"endDateUtc": "2013-02-04T13:00:00+00:00",
"price": 0
}
},
"example": [
{
"startDateUtc": "2013-02-04T08:00:00+00:00",
"endDateUtc": "2013-02-04T13:00:00+00:00",
"price": 0
},
{
"startDateUtc": "2014-02-04T08:00:00+00:00",
"endDateUtc": "2014-02-04T13:00:00+00:00",
"price": 100
}
]
},
"pickupStoreInfo": {
"title": "pickupStoreInfo",
"description": "Contains the data about the pickup point. If you don’t want to send this, use the value `null`.",
"type": "object",
"nullable": true,
"required": [
"isPickupStore",
"friendlyName",
"address",
"additionalInfo"
],
"properties": {
"isPickupStore": {
"title": "isPickupStore",
"description": "`true` if it is a pickup point.",
"type": "boolean",
"example": true
},
"friendlyName": {
"title": "friendlyName",
"description": "Friendly name of the pickup point.",
"type": "string",
"example": "Store ABC"
},
"address": {
"title": "address",
"description": "Address data of the pickup point.",
"type": "object",
"required": [
"addressType",
"receiverName",
"addressId",
"postalCode",
"city",
"state",
"country",
"street",
"number",
"neighborhood",
"complement",
"reference",
"geoCoordinates"
],
"properties": {
"addressType": {
"title": " addressType",
"description": "The possible value is pickup.",
"type": "string",
"example": "pickup"
},
"receiverName": {
"title": "receiverName",
"description": "Name of the person who will receive the product. May be sent as `null`.",
"type": "string",
"example": "Juliana",
"nullable": true
},
"addressId": {
"title": "addressId",
"description": "Identifies the pickup point.",
"type": "string",
"example": "548304ed-dd40-4416-b12b-4b32bfa7b1e0"
},
"postalCode": {
"title": "postalCode",
"description": "Postal code of the pickup point. This field is mandatory, for shopping carts simulations, where both Country and Postal Code are required. This field should be sent as `null` for storefront simulations, where the information is not necessary.",
"type": "string",
"example": "82320-040"
},
"city": {
"title": "city",
"description": "Pickup point's city.",
"type": "string",
"example": "Rio de Janeiro"
},
"state": {
"title": "state",
"description": "Pickup point's state.",
"type": "string",
"example": "RJ"
},
"country": {
"title": "country",
"description": "3-digit ISO code of the country where the pickup point is located.",
"type": "string",
"example": "BRA"
},
"street": {
"title": "street",
"description": "Street where the pickup point is located.",
"type": "string",
"example": "Rua Praia de Botafogo"
},
"number": {
"title": "number",
"description": "Address number of the pickup point.",
"type": "string",
"example": "100"
},
"neighborhood": {
"title": "neighborhood",
"description": "Neighborhood where the pickup point is located.",
"type": "string",
"example": "Botafogo"
},
"complement": {
"title": "complement",
"description": "Complement of the pickup point address.",
"type": "string",
"example": "2nd floor"
},
"reference": {
"title": "reference",
"description": "A reference for the pickup point address. ",
"type": "string",
"example": "Right next to the Unicorn statue.",
"nullable": true
},
"geoCoordinates": {
"title": "geoCoordinates",
"description": "Contains the geographic coordinates of the pickup point.",
"type": "array",
"items": {
"title": "geoCoordinates",
"description": "Contains the geographic coordinates of the pickup point.",
"type": "number",
"example": 25.401705
},
"example": [
-49.334934,
25.401705
]
}
},
"example": {
"addressType": "pickup",
"receiverName": "Juliana",
"addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
"postalCode": "82320-040",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Domingos Strapasson",
"number": "100",
"neighborhood": "Santa Felicidade",
"complement": "Loja 10",
"reference": "Right next to the Unicorn statue.",
"geoCoordinates": [
49.334934,
25.401705
]
}
},
"additionalInfo": {
"title": "additionalInfo",
"description": "Description or extra information about the pickup point.",
"type": "string",
"example": "Pick up your order at the cashier."
}
},
"example": {
"isPickupStore": true,
"friendlyName": "Santa Felicidade",
"address": {
"addressType": "pickup",
"receiverName": "Juliana",
"addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
"postalCode": "82320-040",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Domingos Strapasson",
"number": "100",
"neighborhood": "Santa Felicidade",
"complement": "Loja 10",
"reference": "Right next to the Unicorn statue.",
"geoCoordinates": [
49.334934,
25.401705
]
},
"additionalInfo": ""
}
}
},
"example": {
"id": "Curbside pickup",
"deliveryChannel": "pickup-in-point",
"name": "Curbside pickup",
"shippingEstimate": "0bd",
"price": 0,
"availableDeliveryWindows": [
{
"startDateUtc": "2013-02-04T08:00:00+00:00",
"endDateUtc": "2013-02-04T13:00:00+00:00",
"price": 0
}
],
"pickupStoreInfo": {
"isPickupStore": true,
"friendlyName": "Santa Felicidade",
"address": {
"addressType": "pickup",
"receiverName": "Juliana",
"addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
"postalCode": "82320-040",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Domingos Strapasson",
"number": "100",
"neighborhood": "Santa Felicidade",
"complement": "Loja 10",
"reference": "Right next to the Unicorn statue.",
"geoCoordinates": [
49.334934,
25.401705
]
},
"additionalInfo": ""
}
}
},
"example": [
{
"id": "Curbside pickup",
"deliveryChannel": "pickup-in-point",
"name": "Curbside pickup",
"shippingEstimate": "0bd",
"price": 0,
"availableDeliveryWindows": [
{
"startDateUtc": "2013-02-04T08:00:00+00:00",
"endDateUtc": "2013-02-04T13:00:00+00:00",
"price": 0
}
],
"pickupStoreInfo": {
"isPickupStore": true,
"friendlyName": "Santa Felicidade",
"address": {
"addressType": "pickup",
"receiverName": "Juliana",
"addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
"postalCode": "82320-040",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Domingos Strapasson",
"number": "100",
"neighborhood": "Santa Felicidade",
"complement": "Loja 10",
"reference": "Right next to the Unicorn statue.",
"geoCoordinates": [
49.334934,
25.401705
]
},
"additionalInfo": ""
}
}
]
},
"stockBalance": {
"title": "stockBalance",
"description": "Stock balance of the SKU.",
"type": "integer",
"example": 199
},
"deliveryChannels": {
"title": "deliveryChannels",
"description": "Array contains the stock balance for each channel.",
"type": "array",
"items": {
"title": "deliveryChannels",
"description": "Object containing ID and stockbalance of each delivery channel.",
"type": "object",
"required": [
"id",
"stockBalance"
],
"properties": {
"id": {
"title": "id",
"description": "Identifies the channel type whose stock balance will be informed in the next field. Possible values are: pickup-in-point for pickup point and delivery for regular delivery.",
"type": "string",
"example": "pickup-in-point"
},
"stockBalance": {
"title": "stockBalance",
"description": "Stock balance for the channel type selected in the previous field.",
"type": "integer",
"example": 20
}
},
"example": {
"id": "delivery",
"stockBalance": 179
}
},
"example": [
{
"id": "delivery",
"stockBalance": 179
},
{
"id": "pickup-in-point",
"stockBalance": 20
}
]
}
},
"example": {
"itemIndex": 0,
"quantity": 1,
"shipsTo": [
"BRA"
],
"slas": [
{
"id": "Curbside pickup",
"deliveryChannel": "pickup-in-point",
"name": "Curbside pickup",
"shippingEstimate": "0bd",
"price": 0,
"availableDeliveryWindows": [
{
"startDateUtc": "2013-02-04T08:00:00+00:00",
"endDateUtc": "2013-02-04T13:00:00+00:00",
"price": 0
}
],
"pickupStoreInfo": {
"isPickupStore": true,
"friendlyName": "Santa Felicidade",
"address": {
"addressType": "pickup",
"receiverName": null,
"addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
"postalCode": "82320-040",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Domingos Strapasson",
"number": "100",
"neighborhood": "Santa Felicidade",
"complement": "Loja 10",
"reference": null,
"geoCoordinates": [
49.334934,
25.401705
]
},
"additionalInfo": ""
}
}
],
"stockBalance": 199,
"deliveryChannels": [
{
"id": "delivery",
"stockBalance": 179
},
{
"id": "pickup-in-point",
"stockBalance": 20
}
]
}
},
"example": [
{
"itemIndex": 0,
"quantity": 1,
"shipsTo": [
"BRA"
],
"slas": [
{
"id": "Curbside pickup",
"deliveryChannel": "pickup-in-point",
"name": "Curbside pickup",
"shippingEstimate": "0bd",
"price": 0,
"availableDeliveryWindows": [
{
"startDateUtc": "2013-02-04T08:00:00+00:00",
"endDateUtc": "2013-02-04T13:00:00+00:00",
"price": 0
}
],
"pickupStoreInfo": {
"isPickupStore": true,
"friendlyName": "Santa Felicidade",
"address": {
"addressType": "pickup",
"receiverName": null,
"addressId": "548304ed-dd40-4416-b12b-4b32bfa7b1e0",
"postalCode": "82320-040",
"city": "Curitiba",
"state": "PR",
"country": "BRA",
"street": "Rua Domingos Strapasson",
"number": "100",
"neighborhood": "Santa Felicidade",
"complement": "Loja 10",
"reference": null,
"geoCoordinates": [
49.334934,
25.401705
]
},
"additionalInfo": ""
}
}
],
"stockBalance": 199,
"deliveryChannels": [
{
"id": "delivery",
"stockBalance": 179
},
{
"id": "pickup-in-point",
"stockBalance": 20
}
]
}
]
},
"postalCode": {
"title": "postalCode",
"description": "Postal code of the delivery address. This field is mandatory, for shopping carts simulations, where both Country and Postal Code are required. This field should be sent as `null` for storefront simulations, where the information is not necessary.",
"type": "string",
"example": "80250000"
},
"allowMultipleDeliveries": {
"description": "Flag for permission of multiple deliveries",
"type": "boolean"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/pvt/orders": {
"post": {
"tags": [
"External Seller"
],
"summary": "Order placement",
"description": "This request is sent by VTEX to the external seller once the customer finishes their checkout, to let the seller know there is a newly placed order. It does that by calling the **Order Placement** endpoint, which needs to be implemented by the seller.\n\nThe marketplace will send information such as the items contained in the cart, the client’s profile data, the shipping data, and the payment data. With all that, the seller will be able to create the order in their own store.",
"operationId": "order-placement",
"parameters": [
{
"name": "fulfillmentEndpoint",
"in": "path",
"description": "This is the fulfillment endpoint registered for each specific external seller in the **seller management** section of VTEX's admin panel.",
"required": true,
"style": "simple",