POST v1/purchases/BulkCreate?preview={preview}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| preview | boolean |
Default value is False |
Body Parameters
Common.Dto.Post.BulkPurchase| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId | integer |
None. |
|
| autoPurchase | boolean |
None. |
|
| purchases | Collection of Common.Dto.Post.BasePurchase |
None. |
|
| invoiceCollectOptions | Common.Dto.Post.InvoiceCollectOptions |
None. |
|
| view | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"customerId": 1,
"autoPurchase": true,
"purchases": [
{
"productId": 1,
"quantity": 1.0,
"name": "sample string 2",
"description": "sample string 3",
"overridePriceRanges": [
{
"min": 1.0,
"max": 1.0,
"amount": 2.0
},
{
"min": 1.0,
"max": 1.0,
"amount": 2.0
}
],
"pricingModelType": "sample string 4",
"pricingFormulaType": "sample string 5",
"customFields": [
{
"key": "sample string 1",
"value": {}
},
{
"key": "sample string 1",
"value": {}
}
],
"discounts": [
{
"discountType": "sample string 1",
"amount": 2.0
},
{
"discountType": "sample string 1",
"amount": 2.0
}
],
"productItems": [
{
"reference": "sample string 1",
"name": "sample string 2",
"description": "sample string 3"
},
{
"reference": "sample string 1",
"name": "sample string 2",
"description": "sample string 3"
}
],
"couponCodes": [
"sample string 1",
"sample string 2"
],
"earningSettings": {
"earningSchedules": [
{
"scheduledType": "sample string 1",
"scheduledInterval": "sample string 2",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 3"
},
{
"scheduledType": "sample string 1",
"scheduledInterval": "sample string 2",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 3"
}
],
"earningInterval": "sample string 1",
"earningNumberOfIntervals": 1,
"earningTimingInterval": "sample string 2",
"earningTimingType": "sample string 3"
},
"netsuiteClassId": "sample string 6",
"netsuiteLocationId": "sample string 7",
"targetOrderQuantity": 1.0,
"netsuiteBinId": "sample string 8",
"invoiceOwner": "sample string 9",
"skipCouponValidation": true,
"hubspotDealId": 11,
"quickBooksClassId": "sample string 12"
},
{
"productId": 1,
"quantity": 1.0,
"name": "sample string 2",
"description": "sample string 3",
"overridePriceRanges": [
{
"min": 1.0,
"max": 1.0,
"amount": 2.0
},
{
"min": 1.0,
"max": 1.0,
"amount": 2.0
}
],
"pricingModelType": "sample string 4",
"pricingFormulaType": "sample string 5",
"customFields": [
{
"key": "sample string 1",
"value": {}
},
{
"key": "sample string 1",
"value": {}
}
],
"discounts": [
{
"discountType": "sample string 1",
"amount": 2.0
},
{
"discountType": "sample string 1",
"amount": 2.0
}
],
"productItems": [
{
"reference": "sample string 1",
"name": "sample string 2",
"description": "sample string 3"
},
{
"reference": "sample string 1",
"name": "sample string 2",
"description": "sample string 3"
}
],
"couponCodes": [
"sample string 1",
"sample string 2"
],
"earningSettings": {
"earningSchedules": [
{
"scheduledType": "sample string 1",
"scheduledInterval": "sample string 2",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 3"
},
{
"scheduledType": "sample string 1",
"scheduledInterval": "sample string 2",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 3"
}
],
"earningInterval": "sample string 1",
"earningNumberOfIntervals": 1,
"earningTimingInterval": "sample string 2",
"earningTimingType": "sample string 3"
},
"netsuiteClassId": "sample string 6",
"netsuiteLocationId": "sample string 7",
"targetOrderQuantity": 1.0,
"netsuiteBinId": "sample string 8",
"invoiceOwner": "sample string 9",
"skipCouponValidation": true,
"hubspotDealId": 11,
"quickBooksClassId": "sample string 12"
}
],
"invoiceCollectOptions": {
"paymentMethod": 0,
"paymentMethodId": 1,
"useAnyAvailableFundsFirst": true,
"rollbackOnFailedPayment": true,
"paymentIntentId": "sample string 3",
"uRLForSSP": "sample string 4"
},
"view": "sample string 3"
}
Response Information
Resource Description
Common.Dto.Get.BulkPurchase| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId | integer |
None. |
|
| purchases | Collection of Common.Dto.Get.BasePurchase |
None. |
|
| sideEffects | Common.Dto.Get.SideEffects |
None. |
Response Formats
application/json, text/json
Sample:
{
"customerId": 1,
"purchases": null,
"sideEffects": {}
}