@flowio/api-mock-generator 6.17.73 → 6.17.75
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.json +268 -1013
- package/package.json +2 -2
- package/src/api.json +268 -1013
package/dist/api.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"key": "api"
|
|
11
11
|
},
|
|
12
12
|
"namespace": "io.flow.v0",
|
|
13
|
-
"version": "0.18.
|
|
13
|
+
"version": "0.18.36",
|
|
14
14
|
"info": {
|
|
15
15
|
"license": {
|
|
16
16
|
"name": "MIT",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"application": {
|
|
77
77
|
"key": "ben-test-internal"
|
|
78
78
|
},
|
|
79
|
-
"version": "0.21.
|
|
79
|
+
"version": "0.21.86",
|
|
80
80
|
"enums": [],
|
|
81
81
|
"interfaces": ["generate_load"],
|
|
82
82
|
"unions": ["generate_load"],
|
|
@@ -3183,102 +3183,6 @@
|
|
|
3183
3183
|
"description": "The details of tip associated with an order"
|
|
3184
3184
|
}],
|
|
3185
3185
|
"attributes": []
|
|
3186
|
-
}, {
|
|
3187
|
-
"name": "order_quote_address_type",
|
|
3188
|
-
"plural": "order_quote_address_types",
|
|
3189
|
-
"values": [{
|
|
3190
|
-
"name": "shipping",
|
|
3191
|
-
"attributes": []
|
|
3192
|
-
}],
|
|
3193
|
-
"attributes": []
|
|
3194
|
-
}, {
|
|
3195
|
-
"name": "order_quote_error_code",
|
|
3196
|
-
"plural": "order_quote_error_codes",
|
|
3197
|
-
"values": [{
|
|
3198
|
-
"name": "contact_email_invalid",
|
|
3199
|
-
"attributes": []
|
|
3200
|
-
}, {
|
|
3201
|
-
"name": "contact_email_required",
|
|
3202
|
-
"attributes": []
|
|
3203
|
-
}, {
|
|
3204
|
-
"name": "contact_phone_invalid",
|
|
3205
|
-
"attributes": []
|
|
3206
|
-
}, {
|
|
3207
|
-
"name": "contact_phone_required",
|
|
3208
|
-
"attributes": []
|
|
3209
|
-
}, {
|
|
3210
|
-
"name": "country_not_supported",
|
|
3211
|
-
"attributes": []
|
|
3212
|
-
}, {
|
|
3213
|
-
"name": "currency_invalid",
|
|
3214
|
-
"attributes": []
|
|
3215
|
-
}, {
|
|
3216
|
-
"name": "first_name_invalid",
|
|
3217
|
-
"attributes": []
|
|
3218
|
-
}, {
|
|
3219
|
-
"name": "first_name_required",
|
|
3220
|
-
"attributes": []
|
|
3221
|
-
}, {
|
|
3222
|
-
"name": "geo_required_when_no_session",
|
|
3223
|
-
"attributes": []
|
|
3224
|
-
}, {
|
|
3225
|
-
"name": "language_invalid",
|
|
3226
|
-
"attributes": []
|
|
3227
|
-
}, {
|
|
3228
|
-
"name": "last_name_invalid",
|
|
3229
|
-
"attributes": []
|
|
3230
|
-
}, {
|
|
3231
|
-
"name": "last_name_required",
|
|
3232
|
-
"attributes": []
|
|
3233
|
-
}, {
|
|
3234
|
-
"name": "line_item_number_invalid",
|
|
3235
|
-
"attributes": []
|
|
3236
|
-
}, {
|
|
3237
|
-
"name": "line_item_number_not_available",
|
|
3238
|
-
"attributes": []
|
|
3239
|
-
}, {
|
|
3240
|
-
"name": "line_not_found",
|
|
3241
|
-
"attributes": []
|
|
3242
|
-
}, {
|
|
3243
|
-
"name": "line_quantity_invalid",
|
|
3244
|
-
"attributes": []
|
|
3245
|
-
}, {
|
|
3246
|
-
"name": "line_value_threshold_exceeded",
|
|
3247
|
-
"attributes": []
|
|
3248
|
-
}, {
|
|
3249
|
-
"name": "name_missing_first_or_last",
|
|
3250
|
-
"attributes": []
|
|
3251
|
-
}, {
|
|
3252
|
-
"name": "name_required",
|
|
3253
|
-
"attributes": []
|
|
3254
|
-
}, {
|
|
3255
|
-
"name": "order_quote_requires_at_least_one_line",
|
|
3256
|
-
"attributes": []
|
|
3257
|
-
}, {
|
|
3258
|
-
"name": "session_not_found",
|
|
3259
|
-
"attributes": []
|
|
3260
|
-
}, {
|
|
3261
|
-
"name": "session_organization_mismatch",
|
|
3262
|
-
"attributes": []
|
|
3263
|
-
}],
|
|
3264
|
-
"attributes": []
|
|
3265
|
-
}, {
|
|
3266
|
-
"name": "order_quote_line_error_code",
|
|
3267
|
-
"plural": "order_quote_line_error_codes",
|
|
3268
|
-
"values": [{
|
|
3269
|
-
"name": "line_item_number_invalid",
|
|
3270
|
-
"attributes": []
|
|
3271
|
-
}, {
|
|
3272
|
-
"name": "line_item_number_not_available",
|
|
3273
|
-
"attributes": []
|
|
3274
|
-
}, {
|
|
3275
|
-
"name": "line_quantity_invalid",
|
|
3276
|
-
"attributes": []
|
|
3277
|
-
}, {
|
|
3278
|
-
"name": "line_value_threshold_exceeded",
|
|
3279
|
-
"attributes": []
|
|
3280
|
-
}],
|
|
3281
|
-
"attributes": []
|
|
3282
3186
|
}, {
|
|
3283
3187
|
"name": "order_refund_summary_includes",
|
|
3284
3188
|
"plural": "order_refund_summary_includes",
|
|
@@ -3394,10 +3298,18 @@
|
|
|
3394
3298
|
"name": "provided",
|
|
3395
3299
|
"attributes": [],
|
|
3396
3300
|
"description": "Package dimensions provided by caller to API"
|
|
3301
|
+
}, {
|
|
3302
|
+
"name": "item_dimensions_estimated",
|
|
3303
|
+
"attributes": [],
|
|
3304
|
+
"description": "Item dimensions were used to calculate package dimensions"
|
|
3397
3305
|
}, {
|
|
3398
3306
|
"name": "dimensions_estimated",
|
|
3399
3307
|
"attributes": [],
|
|
3400
|
-
"description": "
|
|
3308
|
+
"description": "Organization dimension estimates were used to assume package dimensions"
|
|
3309
|
+
}, {
|
|
3310
|
+
"name": "default_item_dimensions_estimated",
|
|
3311
|
+
"attributes": [],
|
|
3312
|
+
"description": "Dimension estimates set using global default of 1x5x5 inch, .5 lbs"
|
|
3401
3313
|
}],
|
|
3402
3314
|
"attributes": []
|
|
3403
3315
|
}, {
|
|
@@ -4356,6 +4268,20 @@
|
|
|
4356
4268
|
"attributes": []
|
|
4357
4269
|
}],
|
|
4358
4270
|
"attributes": []
|
|
4271
|
+
}, {
|
|
4272
|
+
"name": "restricted_review_status",
|
|
4273
|
+
"plural": "restricted_review_statuses",
|
|
4274
|
+
"values": [{
|
|
4275
|
+
"name": "in_review",
|
|
4276
|
+
"attributes": [],
|
|
4277
|
+
"description": "Product is restricted but has yet to be reviewed."
|
|
4278
|
+
}, {
|
|
4279
|
+
"name": "reviewed",
|
|
4280
|
+
"attributes": [],
|
|
4281
|
+
"description": "Product is restricted and has been reviewed."
|
|
4282
|
+
}],
|
|
4283
|
+
"attributes": [],
|
|
4284
|
+
"description": "review status of a restricted product."
|
|
4359
4285
|
}, {
|
|
4360
4286
|
"name": "return_item_status",
|
|
4361
4287
|
"plural": "return_item_statuses",
|
|
@@ -5247,16 +5173,16 @@
|
|
|
5247
5173
|
"name": "address_correction",
|
|
5248
5174
|
"attributes": []
|
|
5249
5175
|
}, {
|
|
5250
|
-
"name": "
|
|
5176
|
+
"name": "security",
|
|
5251
5177
|
"attributes": []
|
|
5252
5178
|
}, {
|
|
5253
|
-
"name": "
|
|
5179
|
+
"name": "eei_filing",
|
|
5254
5180
|
"attributes": []
|
|
5255
5181
|
}, {
|
|
5256
|
-
"name": "
|
|
5182
|
+
"name": "fixed_ddp",
|
|
5257
5183
|
"attributes": []
|
|
5258
5184
|
}, {
|
|
5259
|
-
"name": "
|
|
5185
|
+
"name": "fixed_currency_conversion",
|
|
5260
5186
|
"attributes": []
|
|
5261
5187
|
}],
|
|
5262
5188
|
"attributes": []
|
|
@@ -5774,6 +5700,13 @@
|
|
|
5774
5700
|
"attributes": [],
|
|
5775
5701
|
"annotations": [],
|
|
5776
5702
|
"description": "The amount/currency of the authorization in base currency. Added in Summer 2018 and always present since then."
|
|
5703
|
+
}, {
|
|
5704
|
+
"name": "requested",
|
|
5705
|
+
"type": "money",
|
|
5706
|
+
"required": false,
|
|
5707
|
+
"attributes": [],
|
|
5708
|
+
"annotations": [],
|
|
5709
|
+
"description": "The amount / currency that is sent to the PSP"
|
|
5777
5710
|
}, {
|
|
5778
5711
|
"name": "authorized_at",
|
|
5779
5712
|
"type": "date-time-iso8601",
|
|
@@ -6255,49 +6188,6 @@
|
|
|
6255
6188
|
"annotations": []
|
|
6256
6189
|
}],
|
|
6257
6190
|
"attributes": []
|
|
6258
|
-
}, {
|
|
6259
|
-
"name": "order_quote_line_interface",
|
|
6260
|
-
"plural": "order_quote_line_interfaces",
|
|
6261
|
-
"fields": [{
|
|
6262
|
-
"name": "item",
|
|
6263
|
-
"type": "order_summary_item",
|
|
6264
|
-
"required": true,
|
|
6265
|
-
"attributes": [],
|
|
6266
|
-
"annotations": []
|
|
6267
|
-
}, {
|
|
6268
|
-
"name": "quantity",
|
|
6269
|
-
"type": "long",
|
|
6270
|
-
"required": true,
|
|
6271
|
-
"attributes": [],
|
|
6272
|
-
"annotations": [],
|
|
6273
|
-
"minimum": 1
|
|
6274
|
-
}, {
|
|
6275
|
-
"name": "discount",
|
|
6276
|
-
"type": "order_quote_line_discount",
|
|
6277
|
-
"required": false,
|
|
6278
|
-
"attributes": [],
|
|
6279
|
-
"annotations": []
|
|
6280
|
-
}, {
|
|
6281
|
-
"name": "tax",
|
|
6282
|
-
"type": "order_quote_summary_tax",
|
|
6283
|
-
"required": false,
|
|
6284
|
-
"attributes": [],
|
|
6285
|
-
"annotations": []
|
|
6286
|
-
}, {
|
|
6287
|
-
"name": "duty",
|
|
6288
|
-
"type": "order_quote_summary_duty",
|
|
6289
|
-
"required": false,
|
|
6290
|
-
"attributes": [],
|
|
6291
|
-
"annotations": []
|
|
6292
|
-
}, {
|
|
6293
|
-
"name": "unit_price",
|
|
6294
|
-
"type": "order_quote_price",
|
|
6295
|
-
"required": true,
|
|
6296
|
-
"attributes": [],
|
|
6297
|
-
"annotations": [],
|
|
6298
|
-
"description": "The total price of quantity 1 of the item in this line. Computed as price - discount + tax + duty"
|
|
6299
|
-
}],
|
|
6300
|
-
"attributes": []
|
|
6301
6191
|
}, {
|
|
6302
6192
|
"name": "payment",
|
|
6303
6193
|
"plural": "payments",
|
|
@@ -8633,33 +8523,6 @@
|
|
|
8633
8523
|
"attributes": [],
|
|
8634
8524
|
"interfaces": [],
|
|
8635
8525
|
"discriminator": "discriminator"
|
|
8636
|
-
}, {
|
|
8637
|
-
"name": "order_quote_price",
|
|
8638
|
-
"plural": "order_quote_prices",
|
|
8639
|
-
"types": [{
|
|
8640
|
-
"type": "order_quote_price_free",
|
|
8641
|
-
"attributes": [],
|
|
8642
|
-
"discriminator_value": "free"
|
|
8643
|
-
}, {
|
|
8644
|
-
"type": "order_quote_price_not_yet_known",
|
|
8645
|
-
"attributes": [],
|
|
8646
|
-
"discriminator_value": "not_yet_known"
|
|
8647
|
-
}, {
|
|
8648
|
-
"type": "order_quote_price_included",
|
|
8649
|
-
"attributes": [],
|
|
8650
|
-
"discriminator_value": "included"
|
|
8651
|
-
}, {
|
|
8652
|
-
"type": "order_quote_price_standard",
|
|
8653
|
-
"attributes": [],
|
|
8654
|
-
"discriminator_value": "price"
|
|
8655
|
-
}, {
|
|
8656
|
-
"type": "order_quote_price_estimated",
|
|
8657
|
-
"attributes": [],
|
|
8658
|
-
"discriminator_value": "estimated"
|
|
8659
|
-
}],
|
|
8660
|
-
"attributes": [],
|
|
8661
|
-
"interfaces": [],
|
|
8662
|
-
"discriminator": "discriminator"
|
|
8663
8526
|
}, {
|
|
8664
8527
|
"name": "order_refund_summary_form",
|
|
8665
8528
|
"plural": "order_refund_summary_forms",
|
|
@@ -34381,591 +34244,6 @@
|
|
|
34381
34244
|
"attributes": [],
|
|
34382
34245
|
"interfaces": [],
|
|
34383
34246
|
"description": "The order put form is used to upsert an order, providing the details on pricing and delivery options for destination and items/quantities specified."
|
|
34384
|
-
}, {
|
|
34385
|
-
"name": "order_quote",
|
|
34386
|
-
"plural": "order_quotes",
|
|
34387
|
-
"fields": [{
|
|
34388
|
-
"name": "id",
|
|
34389
|
-
"type": "string",
|
|
34390
|
-
"required": true,
|
|
34391
|
-
"attributes": [],
|
|
34392
|
-
"annotations": [],
|
|
34393
|
-
"description": "Globally unique identifier"
|
|
34394
|
-
}, {
|
|
34395
|
-
"name": "form",
|
|
34396
|
-
"type": "order_quote_put_form",
|
|
34397
|
-
"required": true,
|
|
34398
|
-
"attributes": [],
|
|
34399
|
-
"annotations": [],
|
|
34400
|
-
"description": "The current data in the order_quote. Typically the value of the last POST/PUT request."
|
|
34401
|
-
}, {
|
|
34402
|
-
"name": "summary",
|
|
34403
|
-
"type": "order_quote_summary",
|
|
34404
|
-
"required": false,
|
|
34405
|
-
"attributes": [],
|
|
34406
|
-
"annotations": [],
|
|
34407
|
-
"description": "Available when there are no errors associated with the order_quote"
|
|
34408
|
-
}],
|
|
34409
|
-
"attributes": [],
|
|
34410
|
-
"interfaces": []
|
|
34411
|
-
}, {
|
|
34412
|
-
"name": "order_quote_address",
|
|
34413
|
-
"plural": "order_quote_addresses",
|
|
34414
|
-
"fields": [{
|
|
34415
|
-
"name": "name",
|
|
34416
|
-
"type": "string",
|
|
34417
|
-
"required": false,
|
|
34418
|
-
"attributes": [],
|
|
34419
|
-
"annotations": ["personal_data"]
|
|
34420
|
-
}, {
|
|
34421
|
-
"name": "first_name",
|
|
34422
|
-
"type": "string",
|
|
34423
|
-
"required": false,
|
|
34424
|
-
"attributes": [],
|
|
34425
|
-
"annotations": ["personal_data"]
|
|
34426
|
-
}, {
|
|
34427
|
-
"name": "last_name",
|
|
34428
|
-
"type": "string",
|
|
34429
|
-
"required": false,
|
|
34430
|
-
"attributes": [],
|
|
34431
|
-
"annotations": ["personal_data"]
|
|
34432
|
-
}, {
|
|
34433
|
-
"name": "country",
|
|
34434
|
-
"type": "string",
|
|
34435
|
-
"required": false,
|
|
34436
|
-
"attributes": [],
|
|
34437
|
-
"annotations": [],
|
|
34438
|
-
"description": "The ISO 3166-3 country code. Case insensitive. See https://api.flow.io/reference/countries",
|
|
34439
|
-
"example": "CAN"
|
|
34440
|
-
}, {
|
|
34441
|
-
"name": "streets",
|
|
34442
|
-
"type": "[string]",
|
|
34443
|
-
"required": false,
|
|
34444
|
-
"attributes": [],
|
|
34445
|
-
"annotations": ["personal_data"],
|
|
34446
|
-
"description": "Array for street line 1, street line 2, etc., in order"
|
|
34447
|
-
}, {
|
|
34448
|
-
"name": "city",
|
|
34449
|
-
"type": "string",
|
|
34450
|
-
"required": false,
|
|
34451
|
-
"attributes": [],
|
|
34452
|
-
"annotations": []
|
|
34453
|
-
}, {
|
|
34454
|
-
"name": "province",
|
|
34455
|
-
"type": "string",
|
|
34456
|
-
"required": false,
|
|
34457
|
-
"attributes": [],
|
|
34458
|
-
"annotations": []
|
|
34459
|
-
}, {
|
|
34460
|
-
"name": "postal",
|
|
34461
|
-
"type": "string",
|
|
34462
|
-
"required": false,
|
|
34463
|
-
"attributes": [],
|
|
34464
|
-
"annotations": []
|
|
34465
|
-
}, {
|
|
34466
|
-
"name": "company",
|
|
34467
|
-
"type": "string",
|
|
34468
|
-
"required": false,
|
|
34469
|
-
"attributes": [],
|
|
34470
|
-
"annotations": ["personal_data"],
|
|
34471
|
-
"description": "Business entity or organization name of this contact"
|
|
34472
|
-
}],
|
|
34473
|
-
"attributes": [],
|
|
34474
|
-
"interfaces": []
|
|
34475
|
-
}, {
|
|
34476
|
-
"name": "order_quote_contact",
|
|
34477
|
-
"plural": "order_quote_contacts",
|
|
34478
|
-
"fields": [{
|
|
34479
|
-
"name": "email",
|
|
34480
|
-
"type": "string",
|
|
34481
|
-
"required": false,
|
|
34482
|
-
"attributes": [],
|
|
34483
|
-
"annotations": ["personal_data"]
|
|
34484
|
-
}, {
|
|
34485
|
-
"name": "phone",
|
|
34486
|
-
"type": "string",
|
|
34487
|
-
"required": false,
|
|
34488
|
-
"attributes": [],
|
|
34489
|
-
"annotations": ["personal_data"]
|
|
34490
|
-
}],
|
|
34491
|
-
"attributes": [],
|
|
34492
|
-
"interfaces": []
|
|
34493
|
-
}, {
|
|
34494
|
-
"name": "order_quote_error",
|
|
34495
|
-
"plural": "order_quote_errors",
|
|
34496
|
-
"fields": [{
|
|
34497
|
-
"name": "errors",
|
|
34498
|
-
"type": "[order_quote_error_details]",
|
|
34499
|
-
"required": true,
|
|
34500
|
-
"attributes": [],
|
|
34501
|
-
"annotations": []
|
|
34502
|
-
}],
|
|
34503
|
-
"attributes": [],
|
|
34504
|
-
"interfaces": []
|
|
34505
|
-
}, {
|
|
34506
|
-
"name": "order_quote_error_details",
|
|
34507
|
-
"plural": "order_quote_error_detailses",
|
|
34508
|
-
"fields": [{
|
|
34509
|
-
"name": "code",
|
|
34510
|
-
"type": "order_quote_error_code",
|
|
34511
|
-
"required": true,
|
|
34512
|
-
"attributes": [],
|
|
34513
|
-
"annotations": []
|
|
34514
|
-
}, {
|
|
34515
|
-
"name": "message",
|
|
34516
|
-
"type": "string",
|
|
34517
|
-
"required": true,
|
|
34518
|
-
"attributes": [],
|
|
34519
|
-
"annotations": []
|
|
34520
|
-
}],
|
|
34521
|
-
"attributes": [],
|
|
34522
|
-
"interfaces": []
|
|
34523
|
-
}, {
|
|
34524
|
-
"name": "order_quote_geo_put_form",
|
|
34525
|
-
"plural": "order_quote_geo_put_forms",
|
|
34526
|
-
"fields": [{
|
|
34527
|
-
"name": "country",
|
|
34528
|
-
"type": "string",
|
|
34529
|
-
"required": false,
|
|
34530
|
-
"attributes": [],
|
|
34531
|
-
"annotations": [],
|
|
34532
|
-
"description": "If specified, we will select the experience matching this country. ISO 3166 3 currency code as defined in https://api.flow.io/reference/countries",
|
|
34533
|
-
"example": "CAN"
|
|
34534
|
-
}, {
|
|
34535
|
-
"name": "ip",
|
|
34536
|
-
"type": "string",
|
|
34537
|
-
"required": false,
|
|
34538
|
-
"attributes": [],
|
|
34539
|
-
"annotations": [],
|
|
34540
|
-
"description": "If specified, we will geolocate the user by this IP address, and if successful, select the experience matching the country of the IP address."
|
|
34541
|
-
}, {
|
|
34542
|
-
"name": "currency",
|
|
34543
|
-
"type": "string",
|
|
34544
|
-
"required": false,
|
|
34545
|
-
"attributes": [],
|
|
34546
|
-
"annotations": [],
|
|
34547
|
-
"description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience."
|
|
34548
|
-
}, {
|
|
34549
|
-
"name": "language",
|
|
34550
|
-
"type": "string",
|
|
34551
|
-
"required": false,
|
|
34552
|
-
"attributes": [],
|
|
34553
|
-
"annotations": [],
|
|
34554
|
-
"description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)",
|
|
34555
|
-
"example": "en"
|
|
34556
|
-
}],
|
|
34557
|
-
"attributes": [],
|
|
34558
|
-
"interfaces": [],
|
|
34559
|
-
"description": "Provides options that may be used to configure how a order_quote is rendered for a customer, such as currency and language."
|
|
34560
|
-
}, {
|
|
34561
|
-
"name": "order_quote_line",
|
|
34562
|
-
"plural": "order_quote_lines",
|
|
34563
|
-
"fields": [{
|
|
34564
|
-
"name": "id",
|
|
34565
|
-
"type": "string",
|
|
34566
|
-
"required": true,
|
|
34567
|
-
"attributes": [],
|
|
34568
|
-
"annotations": [],
|
|
34569
|
-
"description": "Globally unique identifier"
|
|
34570
|
-
}, {
|
|
34571
|
-
"name": "item",
|
|
34572
|
-
"type": "order_summary_item",
|
|
34573
|
-
"required": true,
|
|
34574
|
-
"attributes": [],
|
|
34575
|
-
"annotations": []
|
|
34576
|
-
}, {
|
|
34577
|
-
"name": "errors",
|
|
34578
|
-
"type": "[order_quote_line_error]",
|
|
34579
|
-
"required": false,
|
|
34580
|
-
"attributes": [],
|
|
34581
|
-
"annotations": []
|
|
34582
|
-
}, {
|
|
34583
|
-
"name": "quantity",
|
|
34584
|
-
"type": "long",
|
|
34585
|
-
"required": true,
|
|
34586
|
-
"attributes": [],
|
|
34587
|
-
"annotations": [],
|
|
34588
|
-
"minimum": 1
|
|
34589
|
-
}, {
|
|
34590
|
-
"name": "discount",
|
|
34591
|
-
"type": "order_quote_line_discount",
|
|
34592
|
-
"required": false,
|
|
34593
|
-
"attributes": [],
|
|
34594
|
-
"annotations": []
|
|
34595
|
-
}, {
|
|
34596
|
-
"name": "tax",
|
|
34597
|
-
"type": "order_quote_summary_tax",
|
|
34598
|
-
"required": false,
|
|
34599
|
-
"attributes": [],
|
|
34600
|
-
"annotations": []
|
|
34601
|
-
}, {
|
|
34602
|
-
"name": "duty",
|
|
34603
|
-
"type": "order_quote_summary_duty",
|
|
34604
|
-
"required": false,
|
|
34605
|
-
"attributes": [],
|
|
34606
|
-
"annotations": []
|
|
34607
|
-
}, {
|
|
34608
|
-
"name": "unit_price",
|
|
34609
|
-
"type": "order_quote_price",
|
|
34610
|
-
"required": true,
|
|
34611
|
-
"attributes": [],
|
|
34612
|
-
"annotations": [],
|
|
34613
|
-
"description": "The total price of quantity 1 of the item in this line. Computed as price - discount + tax + duty"
|
|
34614
|
-
}, {
|
|
34615
|
-
"name": "total",
|
|
34616
|
-
"type": "order_quote_price",
|
|
34617
|
-
"required": true,
|
|
34618
|
-
"attributes": [],
|
|
34619
|
-
"annotations": [],
|
|
34620
|
-
"description": "The total price of the specified quantity of the items in this line. Note that due to rounding, it is not guaranteed that total exactly equals quantity * unit_price"
|
|
34621
|
-
}, {
|
|
34622
|
-
"name": "price_attributes",
|
|
34623
|
-
"type": "map[order_quote_price_standard]",
|
|
34624
|
-
"required": true,
|
|
34625
|
-
"attributes": [],
|
|
34626
|
-
"annotations": []
|
|
34627
|
-
}, {
|
|
34628
|
-
"name": "attributes",
|
|
34629
|
-
"type": "map[string]",
|
|
34630
|
-
"required": true,
|
|
34631
|
-
"attributes": [],
|
|
34632
|
-
"annotations": []
|
|
34633
|
-
}],
|
|
34634
|
-
"attributes": [],
|
|
34635
|
-
"interfaces": ["order_quote_line_interface"],
|
|
34636
|
-
"description": "Same interface as experience order_summary_line_item with additional attributes needed by order_quote"
|
|
34637
|
-
}, {
|
|
34638
|
-
"name": "order_quote_line_discount",
|
|
34639
|
-
"plural": "order_quote_line_discounts",
|
|
34640
|
-
"fields": [{
|
|
34641
|
-
"name": "applied",
|
|
34642
|
-
"type": "order_quote_price_standard",
|
|
34643
|
-
"required": true,
|
|
34644
|
-
"attributes": [],
|
|
34645
|
-
"annotations": []
|
|
34646
|
-
}, {
|
|
34647
|
-
"name": "label",
|
|
34648
|
-
"type": "string",
|
|
34649
|
-
"required": false,
|
|
34650
|
-
"attributes": [],
|
|
34651
|
-
"annotations": [],
|
|
34652
|
-
"description": "The discount pretty label (e.g. SPRING10) that is displayed to the customer."
|
|
34653
|
-
}],
|
|
34654
|
-
"attributes": [],
|
|
34655
|
-
"interfaces": [],
|
|
34656
|
-
"description": "Represents the discount on a given line item. It applies to the entire line regardless of quantity."
|
|
34657
|
-
}, {
|
|
34658
|
-
"name": "order_quote_line_error",
|
|
34659
|
-
"plural": "order_quote_line_errors",
|
|
34660
|
-
"fields": [{
|
|
34661
|
-
"name": "code",
|
|
34662
|
-
"type": "order_quote_line_error_code",
|
|
34663
|
-
"required": true,
|
|
34664
|
-
"attributes": [],
|
|
34665
|
-
"annotations": []
|
|
34666
|
-
}, {
|
|
34667
|
-
"name": "message",
|
|
34668
|
-
"type": "string",
|
|
34669
|
-
"required": true,
|
|
34670
|
-
"attributes": [],
|
|
34671
|
-
"annotations": []
|
|
34672
|
-
}],
|
|
34673
|
-
"attributes": [],
|
|
34674
|
-
"interfaces": []
|
|
34675
|
-
}, {
|
|
34676
|
-
"name": "order_quote_price_estimated",
|
|
34677
|
-
"plural": "order_quote_price_estimateds",
|
|
34678
|
-
"fields": [{
|
|
34679
|
-
"name": "amount",
|
|
34680
|
-
"type": "double",
|
|
34681
|
-
"required": true,
|
|
34682
|
-
"attributes": [],
|
|
34683
|
-
"annotations": [],
|
|
34684
|
-
"example": "100"
|
|
34685
|
-
}, {
|
|
34686
|
-
"name": "currency",
|
|
34687
|
-
"type": "string",
|
|
34688
|
-
"required": true,
|
|
34689
|
-
"attributes": [],
|
|
34690
|
-
"annotations": [],
|
|
34691
|
-
"description": "ISO 4217 3 currency code as defined in https://api.flow.io/reference/currencies",
|
|
34692
|
-
"example": "CAD"
|
|
34693
|
-
}, {
|
|
34694
|
-
"name": "label",
|
|
34695
|
-
"type": "string",
|
|
34696
|
-
"required": true,
|
|
34697
|
-
"attributes": [],
|
|
34698
|
-
"annotations": [],
|
|
34699
|
-
"example": "CA$100.00"
|
|
34700
|
-
}],
|
|
34701
|
-
"attributes": [],
|
|
34702
|
-
"interfaces": []
|
|
34703
|
-
}, {
|
|
34704
|
-
"name": "order_quote_price_free",
|
|
34705
|
-
"plural": "order_quote_price_frees",
|
|
34706
|
-
"fields": [{
|
|
34707
|
-
"name": "placeholder",
|
|
34708
|
-
"type": "string",
|
|
34709
|
-
"required": false,
|
|
34710
|
-
"attributes": [],
|
|
34711
|
-
"annotations": []
|
|
34712
|
-
}],
|
|
34713
|
-
"attributes": [],
|
|
34714
|
-
"interfaces": []
|
|
34715
|
-
}, {
|
|
34716
|
-
"name": "order_quote_price_included",
|
|
34717
|
-
"plural": "order_quote_price_includeds",
|
|
34718
|
-
"fields": [{
|
|
34719
|
-
"name": "placeholder",
|
|
34720
|
-
"type": "string",
|
|
34721
|
-
"required": false,
|
|
34722
|
-
"attributes": [],
|
|
34723
|
-
"annotations": []
|
|
34724
|
-
}],
|
|
34725
|
-
"attributes": [],
|
|
34726
|
-
"interfaces": []
|
|
34727
|
-
}, {
|
|
34728
|
-
"name": "order_quote_price_not_yet_known",
|
|
34729
|
-
"plural": "order_quote_price_not_yet_knowns",
|
|
34730
|
-
"fields": [{
|
|
34731
|
-
"name": "placeholder",
|
|
34732
|
-
"type": "string",
|
|
34733
|
-
"required": false,
|
|
34734
|
-
"attributes": [],
|
|
34735
|
-
"annotations": []
|
|
34736
|
-
}],
|
|
34737
|
-
"attributes": [],
|
|
34738
|
-
"interfaces": []
|
|
34739
|
-
}, {
|
|
34740
|
-
"name": "order_quote_price_standard",
|
|
34741
|
-
"plural": "order_quote_price_standards",
|
|
34742
|
-
"fields": [{
|
|
34743
|
-
"name": "amount",
|
|
34744
|
-
"type": "double",
|
|
34745
|
-
"required": true,
|
|
34746
|
-
"attributes": [],
|
|
34747
|
-
"annotations": [],
|
|
34748
|
-
"example": "100"
|
|
34749
|
-
}, {
|
|
34750
|
-
"name": "currency",
|
|
34751
|
-
"type": "string",
|
|
34752
|
-
"required": true,
|
|
34753
|
-
"attributes": [],
|
|
34754
|
-
"annotations": [],
|
|
34755
|
-
"description": "ISO 4217 3 currency code as defined in https://api.flow.io/reference/currencies",
|
|
34756
|
-
"example": "CAD"
|
|
34757
|
-
}, {
|
|
34758
|
-
"name": "label",
|
|
34759
|
-
"type": "string",
|
|
34760
|
-
"required": true,
|
|
34761
|
-
"attributes": [],
|
|
34762
|
-
"annotations": [],
|
|
34763
|
-
"example": "CA$100.00"
|
|
34764
|
-
}],
|
|
34765
|
-
"attributes": [],
|
|
34766
|
-
"interfaces": []
|
|
34767
|
-
}, {
|
|
34768
|
-
"name": "order_quote_put_form",
|
|
34769
|
-
"plural": "order_quote_put_forms",
|
|
34770
|
-
"fields": [{
|
|
34771
|
-
"name": "line_items",
|
|
34772
|
-
"type": "[line_item_form]",
|
|
34773
|
-
"required": false,
|
|
34774
|
-
"attributes": [],
|
|
34775
|
-
"annotations": [],
|
|
34776
|
-
"minimum": 1
|
|
34777
|
-
}, {
|
|
34778
|
-
"name": "session",
|
|
34779
|
-
"type": "session_reference",
|
|
34780
|
-
"required": false,
|
|
34781
|
-
"attributes": [],
|
|
34782
|
-
"annotations": []
|
|
34783
|
-
}, {
|
|
34784
|
-
"name": "geo",
|
|
34785
|
-
"type": "order_quote_geo_put_form",
|
|
34786
|
-
"required": false,
|
|
34787
|
-
"attributes": [],
|
|
34788
|
-
"annotations": [],
|
|
34789
|
-
"description": "Required when a session is not supplied."
|
|
34790
|
-
}],
|
|
34791
|
-
"attributes": [],
|
|
34792
|
-
"interfaces": []
|
|
34793
|
-
}, {
|
|
34794
|
-
"name": "order_quote_reference",
|
|
34795
|
-
"plural": "order_quote_references",
|
|
34796
|
-
"fields": [{
|
|
34797
|
-
"name": "id",
|
|
34798
|
-
"type": "string",
|
|
34799
|
-
"required": true,
|
|
34800
|
-
"attributes": [],
|
|
34801
|
-
"annotations": [],
|
|
34802
|
-
"description": "Globally unique identifier"
|
|
34803
|
-
}],
|
|
34804
|
-
"attributes": [],
|
|
34805
|
-
"interfaces": []
|
|
34806
|
-
}, {
|
|
34807
|
-
"name": "order_quote_summary",
|
|
34808
|
-
"plural": "order_quote_summaries",
|
|
34809
|
-
"fields": [{
|
|
34810
|
-
"name": "items",
|
|
34811
|
-
"type": "order_quote_summary_items",
|
|
34812
|
-
"required": true,
|
|
34813
|
-
"attributes": [],
|
|
34814
|
-
"annotations": []
|
|
34815
|
-
}, {
|
|
34816
|
-
"name": "shipping",
|
|
34817
|
-
"type": "order_quote_summary_shipping",
|
|
34818
|
-
"required": false,
|
|
34819
|
-
"attributes": [],
|
|
34820
|
-
"annotations": []
|
|
34821
|
-
}, {
|
|
34822
|
-
"name": "tax",
|
|
34823
|
-
"type": "order_quote_summary_tax",
|
|
34824
|
-
"required": false,
|
|
34825
|
-
"attributes": [],
|
|
34826
|
-
"annotations": []
|
|
34827
|
-
}, {
|
|
34828
|
-
"name": "duty",
|
|
34829
|
-
"type": "order_quote_summary_duty",
|
|
34830
|
-
"required": false,
|
|
34831
|
-
"attributes": [],
|
|
34832
|
-
"annotations": []
|
|
34833
|
-
}, {
|
|
34834
|
-
"name": "total",
|
|
34835
|
-
"type": "order_quote_summary_total",
|
|
34836
|
-
"required": true,
|
|
34837
|
-
"attributes": [],
|
|
34838
|
-
"annotations": [],
|
|
34839
|
-
"description": "total = items.total + shipping.total + tax.total + duty.total - discount.total"
|
|
34840
|
-
}, {
|
|
34841
|
-
"name": "balance",
|
|
34842
|
-
"type": "order_quote_price",
|
|
34843
|
-
"required": true,
|
|
34844
|
-
"attributes": [],
|
|
34845
|
-
"annotations": [],
|
|
34846
|
-
"description": "balance = total - payments.total and never < 0"
|
|
34847
|
-
}],
|
|
34848
|
-
"attributes": [],
|
|
34849
|
-
"interfaces": []
|
|
34850
|
-
}, {
|
|
34851
|
-
"name": "order_quote_summary_duty",
|
|
34852
|
-
"plural": "order_quote_summary_duties",
|
|
34853
|
-
"fields": [{
|
|
34854
|
-
"name": "name",
|
|
34855
|
-
"type": "string",
|
|
34856
|
-
"required": true,
|
|
34857
|
-
"attributes": [],
|
|
34858
|
-
"annotations": [],
|
|
34859
|
-
"description": "The local duties name",
|
|
34860
|
-
"example": "Duties"
|
|
34861
|
-
}, {
|
|
34862
|
-
"name": "total",
|
|
34863
|
-
"type": "order_quote_price",
|
|
34864
|
-
"required": true,
|
|
34865
|
-
"attributes": [],
|
|
34866
|
-
"annotations": []
|
|
34867
|
-
}],
|
|
34868
|
-
"attributes": [],
|
|
34869
|
-
"interfaces": []
|
|
34870
|
-
}, {
|
|
34871
|
-
"name": "order_quote_summary_items",
|
|
34872
|
-
"plural": "order_quote_summary_items",
|
|
34873
|
-
"fields": [{
|
|
34874
|
-
"name": "lines",
|
|
34875
|
-
"type": "[order_quote_line]",
|
|
34876
|
-
"required": true,
|
|
34877
|
-
"attributes": [],
|
|
34878
|
-
"annotations": []
|
|
34879
|
-
}, {
|
|
34880
|
-
"name": "total",
|
|
34881
|
-
"type": "order_quote_price",
|
|
34882
|
-
"required": true,
|
|
34883
|
-
"attributes": [],
|
|
34884
|
-
"annotations": [],
|
|
34885
|
-
"description": "The total price of all lines"
|
|
34886
|
-
}],
|
|
34887
|
-
"attributes": [],
|
|
34888
|
-
"interfaces": []
|
|
34889
|
-
}, {
|
|
34890
|
-
"name": "order_quote_summary_shipping",
|
|
34891
|
-
"plural": "order_quote_summary_shippings",
|
|
34892
|
-
"fields": [{
|
|
34893
|
-
"name": "total",
|
|
34894
|
-
"type": "order_quote_price",
|
|
34895
|
-
"required": true,
|
|
34896
|
-
"attributes": [],
|
|
34897
|
-
"annotations": []
|
|
34898
|
-
}, {
|
|
34899
|
-
"name": "freight",
|
|
34900
|
-
"type": "order_quote_summary_shipping_freight",
|
|
34901
|
-
"required": false,
|
|
34902
|
-
"attributes": [],
|
|
34903
|
-
"annotations": []
|
|
34904
|
-
}, {
|
|
34905
|
-
"name": "surcharges",
|
|
34906
|
-
"type": "order_quote_summary_shipping_surcharges",
|
|
34907
|
-
"required": false,
|
|
34908
|
-
"attributes": [],
|
|
34909
|
-
"annotations": []
|
|
34910
|
-
}],
|
|
34911
|
-
"attributes": [],
|
|
34912
|
-
"interfaces": []
|
|
34913
|
-
}, {
|
|
34914
|
-
"name": "order_quote_summary_shipping_freight",
|
|
34915
|
-
"plural": "order_quote_summary_shipping_freight",
|
|
34916
|
-
"fields": [{
|
|
34917
|
-
"name": "total",
|
|
34918
|
-
"type": "order_quote_price",
|
|
34919
|
-
"required": true,
|
|
34920
|
-
"attributes": [],
|
|
34921
|
-
"annotations": []
|
|
34922
|
-
}],
|
|
34923
|
-
"attributes": [],
|
|
34924
|
-
"interfaces": []
|
|
34925
|
-
}, {
|
|
34926
|
-
"name": "order_quote_summary_shipping_surcharges",
|
|
34927
|
-
"plural": "order_quote_summary_shipping_surcharges",
|
|
34928
|
-
"fields": [{
|
|
34929
|
-
"name": "total",
|
|
34930
|
-
"type": "order_quote_price",
|
|
34931
|
-
"required": true,
|
|
34932
|
-
"attributes": [],
|
|
34933
|
-
"annotations": []
|
|
34934
|
-
}],
|
|
34935
|
-
"attributes": [],
|
|
34936
|
-
"interfaces": []
|
|
34937
|
-
}, {
|
|
34938
|
-
"name": "order_quote_summary_tax",
|
|
34939
|
-
"plural": "order_quote_summary_taxes",
|
|
34940
|
-
"fields": [{
|
|
34941
|
-
"name": "name",
|
|
34942
|
-
"type": "string",
|
|
34943
|
-
"required": true,
|
|
34944
|
-
"attributes": [],
|
|
34945
|
-
"annotations": [],
|
|
34946
|
-
"description": "The local tax name",
|
|
34947
|
-
"example": "GST"
|
|
34948
|
-
}, {
|
|
34949
|
-
"name": "total",
|
|
34950
|
-
"type": "order_quote_price",
|
|
34951
|
-
"required": true,
|
|
34952
|
-
"attributes": [],
|
|
34953
|
-
"annotations": []
|
|
34954
|
-
}],
|
|
34955
|
-
"attributes": [],
|
|
34956
|
-
"interfaces": []
|
|
34957
|
-
}, {
|
|
34958
|
-
"name": "order_quote_summary_total",
|
|
34959
|
-
"plural": "order_quote_summary_totals",
|
|
34960
|
-
"fields": [{
|
|
34961
|
-
"name": "total",
|
|
34962
|
-
"type": "order_quote_price",
|
|
34963
|
-
"required": true,
|
|
34964
|
-
"attributes": [],
|
|
34965
|
-
"annotations": []
|
|
34966
|
-
}],
|
|
34967
|
-
"attributes": [],
|
|
34968
|
-
"interfaces": []
|
|
34969
34247
|
}, {
|
|
34970
34248
|
"name": "order_reference",
|
|
34971
34249
|
"plural": "order_references",
|
|
@@ -42297,6 +41575,13 @@
|
|
|
42297
41575
|
"attributes": [],
|
|
42298
41576
|
"annotations": [],
|
|
42299
41577
|
"description": "IDs of regions in which this product is prohibited, as defined in https://api.flow.io/reference/regions."
|
|
41578
|
+
}, {
|
|
41579
|
+
"name": "reasons_per_region",
|
|
41580
|
+
"type": "[reasons_per_region]",
|
|
41581
|
+
"required": false,
|
|
41582
|
+
"attributes": [],
|
|
41583
|
+
"annotations": [],
|
|
41584
|
+
"description": "List of reasons for restriction per region including review status."
|
|
42300
41585
|
}, {
|
|
42301
41586
|
"name": "review_status",
|
|
42302
41587
|
"type": "review_status",
|
|
@@ -44502,6 +43787,34 @@
|
|
|
44502
43787
|
"attributes": [],
|
|
44503
43788
|
"interfaces": [],
|
|
44504
43789
|
"description": "Sent when an order is assigned to a fulfillment center in whole or in part. All assigned fulfillments for all centers will be included on the message."
|
|
43790
|
+
}, {
|
|
43791
|
+
"name": "reasons_per_region",
|
|
43792
|
+
"plural": "reasons_per_regions",
|
|
43793
|
+
"fields": [{
|
|
43794
|
+
"name": "region",
|
|
43795
|
+
"type": "string",
|
|
43796
|
+
"required": true,
|
|
43797
|
+
"attributes": [],
|
|
43798
|
+
"annotations": [],
|
|
43799
|
+
"description": "Region in which the product is restricted, as defined in https://api.flow.io/reference/regions."
|
|
43800
|
+
}, {
|
|
43801
|
+
"name": "reasons",
|
|
43802
|
+
"type": "[string]",
|
|
43803
|
+
"required": true,
|
|
43804
|
+
"attributes": [],
|
|
43805
|
+
"annotations": [],
|
|
43806
|
+
"description": "List of reasons for restriction within the region."
|
|
43807
|
+
}, {
|
|
43808
|
+
"name": "review_status",
|
|
43809
|
+
"type": "restricted_review_status",
|
|
43810
|
+
"required": true,
|
|
43811
|
+
"attributes": [],
|
|
43812
|
+
"annotations": [],
|
|
43813
|
+
"description": "Status of review of applicable restrictions."
|
|
43814
|
+
}],
|
|
43815
|
+
"attributes": [],
|
|
43816
|
+
"interfaces": [],
|
|
43817
|
+
"description": "Reasons for restriction per region including review status"
|
|
44505
43818
|
}, {
|
|
44506
43819
|
"name": "redirect_authorization_details",
|
|
44507
43820
|
"plural": "redirect_authorization_detailses",
|
|
@@ -90552,6 +89865,7 @@
|
|
|
90552
89865
|
"attributes": []
|
|
90553
89866
|
}],
|
|
90554
89867
|
"attributes": [],
|
|
89868
|
+
"description": "Update your business details.\n Common errors:\n- **EIN [{ein}] must be 9 digits**: The EIN provided should contains only 9 digits, no other character is accepted\n- **{field} cannot be blank**: the field has to at least contains some text\n*There might be other messages check them for details*",
|
|
90555
89869
|
"body": {
|
|
90556
89870
|
"type": "know_your_business_form",
|
|
90557
89871
|
"attributes": []
|
|
@@ -91523,210 +90837,36 @@
|
|
|
91523
90837
|
"value": 422
|
|
91524
90838
|
}
|
|
91525
90839
|
},
|
|
91526
|
-
"type": "generic_error",
|
|
91527
|
-
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91528
|
-
"attributes": []
|
|
91529
|
-
}],
|
|
91530
|
-
"attributes": [],
|
|
91531
|
-
"description": "See details of an application"
|
|
91532
|
-
}, {
|
|
91533
|
-
"method": "PUT",
|
|
91534
|
-
"path": "/:organization/merchant/applications/:id",
|
|
91535
|
-
"parameters": [{
|
|
91536
|
-
"name": "organization",
|
|
91537
|
-
"type": "string",
|
|
91538
|
-
"location": "Path",
|
|
91539
|
-
"required": true,
|
|
91540
|
-
"description": "Refers to your organization's account identifier"
|
|
91541
|
-
}, {
|
|
91542
|
-
"name": "id",
|
|
91543
|
-
"type": "string",
|
|
91544
|
-
"location": "Path",
|
|
91545
|
-
"required": true,
|
|
91546
|
-
"description": "Filter by one or more IDs of this resource"
|
|
91547
|
-
}],
|
|
91548
|
-
"responses": [{
|
|
91549
|
-
"code": {
|
|
91550
|
-
"integer": {
|
|
91551
|
-
"value": 200
|
|
91552
|
-
}
|
|
91553
|
-
},
|
|
91554
|
-
"type": "merchant_application",
|
|
91555
|
-
"description": "Successful response",
|
|
91556
|
-
"attributes": []
|
|
91557
|
-
}, {
|
|
91558
|
-
"code": {
|
|
91559
|
-
"integer": {
|
|
91560
|
-
"value": 401
|
|
91561
|
-
}
|
|
91562
|
-
},
|
|
91563
|
-
"type": "unit",
|
|
91564
|
-
"description": "Authorization failed",
|
|
91565
|
-
"attributes": []
|
|
91566
|
-
}, {
|
|
91567
|
-
"code": {
|
|
91568
|
-
"integer": {
|
|
91569
|
-
"value": 404
|
|
91570
|
-
}
|
|
91571
|
-
},
|
|
91572
|
-
"type": "unit",
|
|
91573
|
-
"description": "Resource was not found",
|
|
91574
|
-
"attributes": []
|
|
91575
|
-
}, {
|
|
91576
|
-
"code": {
|
|
91577
|
-
"integer": {
|
|
91578
|
-
"value": 422
|
|
91579
|
-
}
|
|
91580
|
-
},
|
|
91581
|
-
"type": "generic_error",
|
|
91582
|
-
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91583
|
-
"attributes": []
|
|
91584
|
-
}],
|
|
91585
|
-
"attributes": [],
|
|
91586
|
-
"body": {
|
|
91587
|
-
"type": "merchant_application_put_form",
|
|
91588
|
-
"attributes": []
|
|
91589
|
-
}
|
|
91590
|
-
}],
|
|
91591
|
-
"attributes": [{
|
|
91592
|
-
"name": "docs",
|
|
91593
|
-
"value": {
|
|
91594
|
-
"module": "general"
|
|
91595
|
-
}
|
|
91596
|
-
}],
|
|
91597
|
-
"path": "",
|
|
91598
|
-
"description": "Submit merchant application form for an organization"
|
|
91599
|
-
}, {
|
|
91600
|
-
"type": "merchant_gift_card_balance",
|
|
91601
|
-
"plural": "merchant_gift_card_balances",
|
|
91602
|
-
"operations": [{
|
|
91603
|
-
"method": "POST",
|
|
91604
|
-
"path": "/balance",
|
|
91605
|
-
"parameters": [],
|
|
91606
|
-
"responses": [{
|
|
91607
|
-
"code": {
|
|
91608
|
-
"integer": {
|
|
91609
|
-
"value": 200
|
|
91610
|
-
}
|
|
91611
|
-
},
|
|
91612
|
-
"type": "merchant_gift_card_balance",
|
|
91613
|
-
"description": "Successful response",
|
|
91614
|
-
"attributes": []
|
|
91615
|
-
}, {
|
|
91616
|
-
"code": {
|
|
91617
|
-
"integer": {
|
|
91618
|
-
"value": 401
|
|
91619
|
-
}
|
|
91620
|
-
},
|
|
91621
|
-
"type": "unit",
|
|
91622
|
-
"description": "Authorization failed",
|
|
91623
|
-
"attributes": []
|
|
91624
|
-
}, {
|
|
91625
|
-
"code": {
|
|
91626
|
-
"integer": {
|
|
91627
|
-
"value": 404
|
|
91628
|
-
}
|
|
91629
|
-
},
|
|
91630
|
-
"type": "unit",
|
|
91631
|
-
"description": "Resource was not found",
|
|
91632
|
-
"attributes": []
|
|
91633
|
-
}, {
|
|
91634
|
-
"code": {
|
|
91635
|
-
"integer": {
|
|
91636
|
-
"value": 422
|
|
91637
|
-
}
|
|
91638
|
-
},
|
|
91639
|
-
"type": "merchant_gift_card_error",
|
|
91640
|
-
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91641
|
-
"attributes": []
|
|
91642
|
-
}],
|
|
91643
|
-
"attributes": [],
|
|
91644
|
-
"description": "Check the remaining balance on a gift card",
|
|
91645
|
-
"body": {
|
|
91646
|
-
"type": "merchant_gift_card_balance_form",
|
|
91647
|
-
"attributes": []
|
|
91648
|
-
}
|
|
91649
|
-
}],
|
|
91650
|
-
"attributes": [{
|
|
91651
|
-
"name": "docs",
|
|
91652
|
-
"value": {
|
|
91653
|
-
"module": "general"
|
|
91654
|
-
}
|
|
91655
|
-
}],
|
|
91656
|
-
"path": "/balance"
|
|
91657
|
-
}, {
|
|
91658
|
-
"type": "merchant_gift_card_redemption",
|
|
91659
|
-
"plural": "merchant_gift_card_redemptions",
|
|
91660
|
-
"operations": [{
|
|
91661
|
-
"method": "POST",
|
|
91662
|
-
"path": "/redeem",
|
|
91663
|
-
"parameters": [],
|
|
91664
|
-
"responses": [{
|
|
91665
|
-
"code": {
|
|
91666
|
-
"integer": {
|
|
91667
|
-
"value": 201
|
|
91668
|
-
}
|
|
91669
|
-
},
|
|
91670
|
-
"type": "merchant_gift_card_balance",
|
|
91671
|
-
"description": "Operation succeeded and the resource was created",
|
|
91672
|
-
"attributes": []
|
|
91673
|
-
}, {
|
|
91674
|
-
"code": {
|
|
91675
|
-
"integer": {
|
|
91676
|
-
"value": 401
|
|
91677
|
-
}
|
|
91678
|
-
},
|
|
91679
|
-
"type": "unit",
|
|
91680
|
-
"description": "Authorization failed",
|
|
91681
|
-
"attributes": []
|
|
91682
|
-
}, {
|
|
91683
|
-
"code": {
|
|
91684
|
-
"integer": {
|
|
91685
|
-
"value": 404
|
|
91686
|
-
}
|
|
91687
|
-
},
|
|
91688
|
-
"type": "unit",
|
|
91689
|
-
"description": "Resource was not found",
|
|
91690
|
-
"attributes": []
|
|
91691
|
-
}, {
|
|
91692
|
-
"code": {
|
|
91693
|
-
"integer": {
|
|
91694
|
-
"value": 422
|
|
91695
|
-
}
|
|
91696
|
-
},
|
|
91697
|
-
"type": "merchant_gift_card_error",
|
|
90840
|
+
"type": "generic_error",
|
|
91698
90841
|
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91699
90842
|
"attributes": []
|
|
91700
90843
|
}],
|
|
91701
90844
|
"attributes": [],
|
|
91702
|
-
"description": "
|
|
91703
|
-
|
|
91704
|
-
|
|
91705
|
-
|
|
91706
|
-
|
|
91707
|
-
|
|
91708
|
-
|
|
91709
|
-
|
|
91710
|
-
|
|
91711
|
-
|
|
91712
|
-
|
|
91713
|
-
|
|
91714
|
-
|
|
91715
|
-
|
|
91716
|
-
|
|
91717
|
-
|
|
91718
|
-
|
|
91719
|
-
"method": "POST",
|
|
91720
|
-
"path": "/reverse",
|
|
91721
|
-
"parameters": [],
|
|
90845
|
+
"description": "See details of an application"
|
|
90846
|
+
}, {
|
|
90847
|
+
"method": "PUT",
|
|
90848
|
+
"path": "/:organization/merchant/applications/:id",
|
|
90849
|
+
"parameters": [{
|
|
90850
|
+
"name": "organization",
|
|
90851
|
+
"type": "string",
|
|
90852
|
+
"location": "Path",
|
|
90853
|
+
"required": true,
|
|
90854
|
+
"description": "Refers to your organization's account identifier"
|
|
90855
|
+
}, {
|
|
90856
|
+
"name": "id",
|
|
90857
|
+
"type": "string",
|
|
90858
|
+
"location": "Path",
|
|
90859
|
+
"required": true,
|
|
90860
|
+
"description": "Filter by one or more IDs of this resource"
|
|
90861
|
+
}],
|
|
91722
90862
|
"responses": [{
|
|
91723
90863
|
"code": {
|
|
91724
90864
|
"integer": {
|
|
91725
|
-
"value":
|
|
90865
|
+
"value": 200
|
|
91726
90866
|
}
|
|
91727
90867
|
},
|
|
91728
|
-
"type": "
|
|
91729
|
-
"description": "
|
|
90868
|
+
"type": "merchant_application",
|
|
90869
|
+
"description": "Successful response",
|
|
91730
90870
|
"attributes": []
|
|
91731
90871
|
}, {
|
|
91732
90872
|
"code": {
|
|
@@ -91752,14 +90892,13 @@
|
|
|
91752
90892
|
"value": 422
|
|
91753
90893
|
}
|
|
91754
90894
|
},
|
|
91755
|
-
"type": "
|
|
90895
|
+
"type": "generic_error",
|
|
91756
90896
|
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91757
90897
|
"attributes": []
|
|
91758
90898
|
}],
|
|
91759
90899
|
"attributes": [],
|
|
91760
|
-
"description": "Check the remaining balance on a gift card",
|
|
91761
90900
|
"body": {
|
|
91762
|
-
"type": "
|
|
90901
|
+
"type": "merchant_application_put_form",
|
|
91763
90902
|
"attributes": []
|
|
91764
90903
|
}
|
|
91765
90904
|
}],
|
|
@@ -91769,28 +90908,23 @@
|
|
|
91769
90908
|
"module": "general"
|
|
91770
90909
|
}
|
|
91771
90910
|
}],
|
|
91772
|
-
"path": "
|
|
90911
|
+
"path": "",
|
|
90912
|
+
"description": "Submit merchant application form for an organization"
|
|
91773
90913
|
}, {
|
|
91774
|
-
"type": "
|
|
91775
|
-
"plural": "
|
|
90914
|
+
"type": "merchant_gift_card_balance",
|
|
90915
|
+
"plural": "merchant_gift_card_balances",
|
|
91776
90916
|
"operations": [{
|
|
91777
90917
|
"method": "POST",
|
|
91778
|
-
"path": "
|
|
91779
|
-
"parameters": [
|
|
91780
|
-
"name": "organization",
|
|
91781
|
-
"type": "string",
|
|
91782
|
-
"location": "Path",
|
|
91783
|
-
"required": true,
|
|
91784
|
-
"description": "Refers to your organization's account identifier"
|
|
91785
|
-
}],
|
|
90918
|
+
"path": "/balance",
|
|
90919
|
+
"parameters": [],
|
|
91786
90920
|
"responses": [{
|
|
91787
90921
|
"code": {
|
|
91788
90922
|
"integer": {
|
|
91789
|
-
"value":
|
|
90923
|
+
"value": 200
|
|
91790
90924
|
}
|
|
91791
90925
|
},
|
|
91792
|
-
"type": "
|
|
91793
|
-
"description": "
|
|
90926
|
+
"type": "merchant_gift_card_balance",
|
|
90927
|
+
"description": "Successful response",
|
|
91794
90928
|
"attributes": []
|
|
91795
90929
|
}, {
|
|
91796
90930
|
"code": {
|
|
@@ -91816,39 +90950,39 @@
|
|
|
91816
90950
|
"value": 422
|
|
91817
90951
|
}
|
|
91818
90952
|
},
|
|
91819
|
-
"type": "
|
|
90953
|
+
"type": "merchant_gift_card_error",
|
|
91820
90954
|
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91821
90955
|
"attributes": []
|
|
91822
90956
|
}],
|
|
91823
90957
|
"attributes": [],
|
|
90958
|
+
"description": "Check the remaining balance on a gift card",
|
|
91824
90959
|
"body": {
|
|
91825
|
-
"type": "
|
|
90960
|
+
"type": "merchant_gift_card_balance_form",
|
|
91826
90961
|
"attributes": []
|
|
91827
90962
|
}
|
|
91828
|
-
},
|
|
91829
|
-
|
|
91830
|
-
"
|
|
91831
|
-
"
|
|
91832
|
-
|
|
91833
|
-
|
|
91834
|
-
|
|
91835
|
-
|
|
91836
|
-
|
|
91837
|
-
|
|
91838
|
-
|
|
91839
|
-
|
|
91840
|
-
|
|
91841
|
-
|
|
91842
|
-
|
|
91843
|
-
}],
|
|
90963
|
+
}],
|
|
90964
|
+
"attributes": [{
|
|
90965
|
+
"name": "docs",
|
|
90966
|
+
"value": {
|
|
90967
|
+
"module": "general"
|
|
90968
|
+
}
|
|
90969
|
+
}],
|
|
90970
|
+
"path": "/balance"
|
|
90971
|
+
}, {
|
|
90972
|
+
"type": "merchant_gift_card_redemption",
|
|
90973
|
+
"plural": "merchant_gift_card_redemptions",
|
|
90974
|
+
"operations": [{
|
|
90975
|
+
"method": "POST",
|
|
90976
|
+
"path": "/redeem",
|
|
90977
|
+
"parameters": [],
|
|
91844
90978
|
"responses": [{
|
|
91845
90979
|
"code": {
|
|
91846
90980
|
"integer": {
|
|
91847
|
-
"value":
|
|
90981
|
+
"value": 201
|
|
91848
90982
|
}
|
|
91849
90983
|
},
|
|
91850
|
-
"type": "
|
|
91851
|
-
"description": "
|
|
90984
|
+
"type": "merchant_gift_card_balance",
|
|
90985
|
+
"description": "Operation succeeded and the resource was created",
|
|
91852
90986
|
"attributes": []
|
|
91853
90987
|
}, {
|
|
91854
90988
|
"code": {
|
|
@@ -91868,32 +91002,45 @@
|
|
|
91868
91002
|
"type": "unit",
|
|
91869
91003
|
"description": "Resource was not found",
|
|
91870
91004
|
"attributes": []
|
|
91871
|
-
}],
|
|
91872
|
-
"attributes": []
|
|
91873
|
-
}, {
|
|
91874
|
-
"method": "PUT",
|
|
91875
|
-
"path": "/:organization/order/quotes/:id",
|
|
91876
|
-
"parameters": [{
|
|
91877
|
-
"name": "organization",
|
|
91878
|
-
"type": "string",
|
|
91879
|
-
"location": "Path",
|
|
91880
|
-
"required": true,
|
|
91881
|
-
"description": "Refers to your organization's account identifier"
|
|
91882
91005
|
}, {
|
|
91883
|
-
"
|
|
91884
|
-
|
|
91885
|
-
|
|
91886
|
-
|
|
91887
|
-
|
|
91006
|
+
"code": {
|
|
91007
|
+
"integer": {
|
|
91008
|
+
"value": 422
|
|
91009
|
+
}
|
|
91010
|
+
},
|
|
91011
|
+
"type": "merchant_gift_card_error",
|
|
91012
|
+
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91013
|
+
"attributes": []
|
|
91888
91014
|
}],
|
|
91015
|
+
"attributes": [],
|
|
91016
|
+
"description": "Redeems a gift card",
|
|
91017
|
+
"body": {
|
|
91018
|
+
"type": "merchant_gift_card_redemption_form",
|
|
91019
|
+
"attributes": []
|
|
91020
|
+
}
|
|
91021
|
+
}],
|
|
91022
|
+
"attributes": [{
|
|
91023
|
+
"name": "docs",
|
|
91024
|
+
"value": {
|
|
91025
|
+
"module": "general"
|
|
91026
|
+
}
|
|
91027
|
+
}],
|
|
91028
|
+
"path": "/redeem"
|
|
91029
|
+
}, {
|
|
91030
|
+
"type": "merchant_gift_card_reversal",
|
|
91031
|
+
"plural": "merchant_gift_card_reversals",
|
|
91032
|
+
"operations": [{
|
|
91033
|
+
"method": "POST",
|
|
91034
|
+
"path": "/reverse",
|
|
91035
|
+
"parameters": [],
|
|
91889
91036
|
"responses": [{
|
|
91890
91037
|
"code": {
|
|
91891
91038
|
"integer": {
|
|
91892
|
-
"value":
|
|
91039
|
+
"value": 201
|
|
91893
91040
|
}
|
|
91894
91041
|
},
|
|
91895
|
-
"type": "
|
|
91896
|
-
"description": "
|
|
91042
|
+
"type": "merchant_gift_card_balance",
|
|
91043
|
+
"description": "Operation succeeded and the resource was created",
|
|
91897
91044
|
"attributes": []
|
|
91898
91045
|
}, {
|
|
91899
91046
|
"code": {
|
|
@@ -91919,13 +91066,14 @@
|
|
|
91919
91066
|
"value": 422
|
|
91920
91067
|
}
|
|
91921
91068
|
},
|
|
91922
|
-
"type": "
|
|
91069
|
+
"type": "merchant_gift_card_error",
|
|
91923
91070
|
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
91924
91071
|
"attributes": []
|
|
91925
91072
|
}],
|
|
91926
91073
|
"attributes": [],
|
|
91074
|
+
"description": "Check the remaining balance on a gift card",
|
|
91927
91075
|
"body": {
|
|
91928
|
-
"type": "
|
|
91076
|
+
"type": "merchant_gift_card_reversal_form",
|
|
91929
91077
|
"attributes": []
|
|
91930
91078
|
}
|
|
91931
91079
|
}],
|
|
@@ -91935,7 +91083,7 @@
|
|
|
91935
91083
|
"module": "general"
|
|
91936
91084
|
}
|
|
91937
91085
|
}],
|
|
91938
|
-
"path": "
|
|
91086
|
+
"path": "/reverse"
|
|
91939
91087
|
}, {
|
|
91940
91088
|
"type": "organization_authorization",
|
|
91941
91089
|
"plural": "organization_authorizations",
|
|
@@ -93745,6 +92893,113 @@
|
|
|
93745
92893
|
"type": "payment_request",
|
|
93746
92894
|
"plural": "payment_requests",
|
|
93747
92895
|
"operations": [{
|
|
92896
|
+
"method": "GET",
|
|
92897
|
+
"path": "/:organization/payment/requests",
|
|
92898
|
+
"parameters": [{
|
|
92899
|
+
"name": "organization",
|
|
92900
|
+
"type": "string",
|
|
92901
|
+
"location": "Path",
|
|
92902
|
+
"required": true,
|
|
92903
|
+
"description": "Refers to your organization's account identifier"
|
|
92904
|
+
}, {
|
|
92905
|
+
"name": "id",
|
|
92906
|
+
"type": "[string]",
|
|
92907
|
+
"location": "Query",
|
|
92908
|
+
"required": false,
|
|
92909
|
+
"description": "Filter by one or more IDs of this resource",
|
|
92910
|
+
"maximum": 100
|
|
92911
|
+
}, {
|
|
92912
|
+
"name": "since",
|
|
92913
|
+
"type": "date-time-iso8601",
|
|
92914
|
+
"location": "Query",
|
|
92915
|
+
"required": false,
|
|
92916
|
+
"description": "Retrieve payment requests created after this date and time"
|
|
92917
|
+
}, {
|
|
92918
|
+
"name": "until",
|
|
92919
|
+
"type": "date-time-iso8601",
|
|
92920
|
+
"location": "Query",
|
|
92921
|
+
"required": false,
|
|
92922
|
+
"description": "Retrieve payment requests created before this date and time"
|
|
92923
|
+
}, {
|
|
92924
|
+
"name": "updated_since",
|
|
92925
|
+
"type": "date-time-iso8601",
|
|
92926
|
+
"location": "Query",
|
|
92927
|
+
"required": false,
|
|
92928
|
+
"description": "Retrieve payment requests updated after this date and time"
|
|
92929
|
+
}, {
|
|
92930
|
+
"name": "updated_until",
|
|
92931
|
+
"type": "date-time-iso8601",
|
|
92932
|
+
"location": "Query",
|
|
92933
|
+
"required": false,
|
|
92934
|
+
"description": "Retrieve payment requests updated before this date and time"
|
|
92935
|
+
}, {
|
|
92936
|
+
"name": "limit",
|
|
92937
|
+
"type": "long",
|
|
92938
|
+
"location": "Query",
|
|
92939
|
+
"required": true,
|
|
92940
|
+
"description": "The maximum number of results to return",
|
|
92941
|
+
"default": "25",
|
|
92942
|
+
"minimum": 1,
|
|
92943
|
+
"maximum": 100
|
|
92944
|
+
}, {
|
|
92945
|
+
"name": "offset",
|
|
92946
|
+
"type": "long",
|
|
92947
|
+
"location": "Query",
|
|
92948
|
+
"required": true,
|
|
92949
|
+
"description": "The number of results to skip before returning results",
|
|
92950
|
+
"default": "0",
|
|
92951
|
+
"minimum": 0
|
|
92952
|
+
}, {
|
|
92953
|
+
"name": "sort",
|
|
92954
|
+
"type": "string",
|
|
92955
|
+
"location": "Query",
|
|
92956
|
+
"required": true,
|
|
92957
|
+
"default": "-created_at"
|
|
92958
|
+
}],
|
|
92959
|
+
"responses": [{
|
|
92960
|
+
"code": {
|
|
92961
|
+
"integer": {
|
|
92962
|
+
"value": 200
|
|
92963
|
+
}
|
|
92964
|
+
},
|
|
92965
|
+
"type": "[payment_request]",
|
|
92966
|
+
"description": "Successful response",
|
|
92967
|
+
"attributes": []
|
|
92968
|
+
}, {
|
|
92969
|
+
"code": {
|
|
92970
|
+
"integer": {
|
|
92971
|
+
"value": 401
|
|
92972
|
+
}
|
|
92973
|
+
},
|
|
92974
|
+
"type": "unit",
|
|
92975
|
+
"description": "Authorization failed",
|
|
92976
|
+
"attributes": []
|
|
92977
|
+
}, {
|
|
92978
|
+
"code": {
|
|
92979
|
+
"integer": {
|
|
92980
|
+
"value": 422
|
|
92981
|
+
}
|
|
92982
|
+
},
|
|
92983
|
+
"type": "generic_error",
|
|
92984
|
+
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
92985
|
+
"attributes": []
|
|
92986
|
+
}],
|
|
92987
|
+
"attributes": [{
|
|
92988
|
+
"name": "sort",
|
|
92989
|
+
"value": {
|
|
92990
|
+
"values": [{
|
|
92991
|
+
"value": "created_at"
|
|
92992
|
+
}, {
|
|
92993
|
+
"value": "updated_at"
|
|
92994
|
+
}]
|
|
92995
|
+
}
|
|
92996
|
+
}, {
|
|
92997
|
+
"name": "linter",
|
|
92998
|
+
"value": {
|
|
92999
|
+
"ignore": ["versions"]
|
|
93000
|
+
}
|
|
93001
|
+
}]
|
|
93002
|
+
}, {
|
|
93748
93003
|
"method": "POST",
|
|
93749
93004
|
"path": "/:organization/payment/requests",
|
|
93750
93005
|
"parameters": [{
|