@unified-api/typescript-sdk 1.0.0 → 1.0.2
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/README.md +54 -700
- package/dist/sdk/accounting.d.ts +0 -40
- package/dist/sdk/accounting.js +44 -696
- package/dist/sdk/link.d.ts +31 -0
- package/dist/sdk/link.js +503 -0
- package/dist/sdk/models/operations/{createaccountingpayment.d.ts → createpaymentlink.d.ts} +7 -7
- package/dist/sdk/models/operations/createpaymentlink.js +95 -0
- package/dist/sdk/models/operations/createpaymentpayment.d.ts +28 -0
- package/dist/sdk/models/operations/{createaccountingpayment.js → createpaymentpayment.js} +20 -20
- package/dist/sdk/models/operations/getpaymentlink.d.ts +35 -0
- package/dist/sdk/models/operations/getpaymentlink.js +99 -0
- package/dist/sdk/models/operations/{getaccountingpayment.d.ts → getpaymentpayment.d.ts} +6 -6
- package/dist/sdk/models/operations/{getaccountingpayment.js → getpaymentpayment.js} +20 -20
- package/dist/sdk/models/operations/{getaccountingpayout.d.ts → getpaymentpayout.d.ts} +6 -6
- package/dist/sdk/models/operations/{getaccountingpayout.js → getpaymentpayout.js} +20 -20
- package/dist/sdk/models/operations/{getaccountingrefund.d.ts → getpaymentrefund.d.ts} +6 -6
- package/dist/sdk/models/operations/{getaccountingrefund.js → getpaymentrefund.js} +20 -20
- package/dist/sdk/models/operations/getunifiedintegrationauth.d.ts +6 -4
- package/dist/sdk/models/operations/getunifiedintegrationauth.js +6 -4
- package/dist/sdk/models/operations/index.d.ts +16 -10
- package/dist/sdk/models/operations/index.js +16 -10
- package/dist/sdk/models/operations/listpaymentlinks.d.ts +51 -0
- package/dist/sdk/models/operations/listpaymentlinks.js +127 -0
- package/dist/sdk/models/operations/{listaccountingpayments.d.ts → listpaymentpayments.d.ts} +6 -6
- package/dist/sdk/models/operations/{listaccountingpayments.js → listpaymentpayments.js} +28 -28
- package/dist/sdk/models/operations/{listaccountingpayouts.d.ts → listpaymentpayouts.d.ts} +6 -6
- package/dist/sdk/models/operations/{listaccountingpayouts.js → listpaymentpayouts.js} +26 -26
- package/dist/sdk/models/operations/{listaccountingrefunds.d.ts → listpaymentrefunds.d.ts} +6 -6
- package/dist/sdk/models/operations/{listaccountingrefunds.js → listpaymentrefunds.js} +27 -27
- package/dist/sdk/models/operations/listunifiedconnections.d.ts +2 -1
- package/dist/sdk/models/operations/listunifiedconnections.js +1 -0
- package/dist/sdk/models/operations/listunifiedintegrations.d.ts +2 -1
- package/dist/sdk/models/operations/listunifiedintegrations.js +1 -0
- package/dist/sdk/models/operations/listunifiedintegrationworkspaces.d.ts +2 -1
- package/dist/sdk/models/operations/listunifiedintegrationworkspaces.js +1 -0
- package/dist/sdk/models/operations/patchpaymentlink.d.ts +32 -0
- package/dist/sdk/models/operations/patchpaymentlink.js +99 -0
- package/dist/sdk/models/operations/{patchaccountingpayment.d.ts → patchpaymentpayment.d.ts} +7 -7
- package/dist/sdk/models/operations/{patchaccountingpayment.js → patchpaymentpayment.js} +21 -21
- package/dist/sdk/models/operations/removepaymentlink.d.ts +30 -0
- package/dist/sdk/models/operations/{removeaccountingpayment.js → removepaymentlink.js} +17 -17
- package/dist/sdk/models/operations/{removeaccountingpayment.d.ts → removepaymentpayment.d.ts} +2 -2
- package/dist/sdk/models/operations/removepaymentpayment.js +71 -0
- package/dist/sdk/models/operations/updatepaymentlink.d.ts +32 -0
- package/dist/sdk/models/operations/updatepaymentlink.js +99 -0
- package/dist/sdk/models/operations/{updateaccountingpayment.d.ts → updatepaymentpayment.d.ts} +7 -7
- package/dist/sdk/models/operations/{updateaccountingpayment.js → updatepaymentpayment.js} +21 -21
- package/dist/sdk/models/shared/accountinginvoice.d.ts +1 -0
- package/dist/sdk/models/shared/accountinginvoice.js +5 -0
- package/dist/sdk/models/shared/index.d.ts +5 -3
- package/dist/sdk/models/shared/index.js +5 -3
- package/dist/sdk/models/shared/paymenntlinklineitem.d.ts +20 -0
- package/dist/sdk/models/shared/paymenntlinklineitem.js +137 -0
- package/dist/sdk/models/shared/paymentlink.d.ts +15 -0
- package/dist/sdk/models/shared/paymentlink.js +105 -0
- package/dist/sdk/models/shared/{accountingpayment.d.ts → paymentpayment.d.ts} +1 -1
- package/dist/sdk/models/shared/{accountingpayment.js → paymentpayment.js} +18 -18
- package/dist/sdk/models/shared/{accountingpayout.d.ts → paymentpayout.d.ts} +3 -3
- package/dist/sdk/models/shared/{accountingpayout.js → paymentpayout.js} +21 -21
- package/dist/sdk/models/shared/{accountingrefund.d.ts → paymentrefund.d.ts} +3 -3
- package/dist/sdk/models/shared/{accountingrefund.js → paymentrefund.js} +23 -23
- package/dist/sdk/models/shared/propertyconnectioncategories.d.ts +2 -1
- package/dist/sdk/models/shared/propertyconnectioncategories.js +1 -0
- package/dist/sdk/models/shared/propertyconnectionpermissions.d.ts +6 -4
- package/dist/sdk/models/shared/propertyconnectionpermissions.js +6 -4
- package/dist/sdk/models/shared/propertyintegrationcategories.d.ts +2 -1
- package/dist/sdk/models/shared/propertyintegrationcategories.js +1 -0
- package/dist/sdk/models/shared/webhook.d.ts +4 -3
- package/dist/sdk/models/shared/webhook.js +4 -3
- package/dist/sdk/payment.d.ts +46 -6
- package/dist/sdk/payment.js +705 -53
- package/dist/sdk/payout.d.ts +2 -2
- package/dist/sdk/payout.js +11 -11
- package/dist/sdk/refund.d.ts +2 -2
- package/dist/sdk/refund.js +11 -11
- package/dist/sdk/sdk.d.ts +5 -3
- package/dist/sdk/sdk.js +7 -5
- package/docs/sdk/models/operations/categories.md +2 -1
- package/docs/sdk/models/operations/createpaymentlinkrequest.md +9 -0
- package/docs/sdk/models/operations/createpaymentlinkresponse.md +11 -0
- package/docs/sdk/models/operations/createpaymentpaymentrequest.md +9 -0
- package/docs/sdk/models/operations/createpaymentpaymentresponse.md +11 -0
- package/docs/sdk/models/operations/getpaymentlinkrequest.md +10 -0
- package/docs/sdk/models/operations/getpaymentlinkresponse.md +11 -0
- package/docs/sdk/models/operations/{getaccountingpaymentrequest.md → getpaymentpaymentrequest.md} +1 -1
- package/docs/sdk/models/operations/getpaymentpaymentresponse.md +11 -0
- package/docs/sdk/models/operations/{getaccountingpayoutrequest.md → getpaymentpayoutrequest.md} +1 -1
- package/docs/sdk/models/operations/getpaymentpayoutresponse.md +11 -0
- package/docs/sdk/models/operations/{getaccountingrefundrequest.md → getpaymentrefundrequest.md} +1 -1
- package/docs/sdk/models/operations/getpaymentrefundresponse.md +11 -0
- package/docs/sdk/models/operations/listpaymentlinksrequest.md +17 -0
- package/docs/sdk/models/operations/listpaymentlinksresponse.md +11 -0
- package/docs/sdk/models/operations/{listaccountingpaymentsrequest.md → listpaymentpaymentsrequest.md} +1 -1
- package/docs/sdk/models/operations/listpaymentpaymentsresponse.md +11 -0
- package/docs/sdk/models/operations/{listaccountingpayoutsrequest.md → listpaymentpayoutsrequest.md} +1 -1
- package/docs/sdk/models/operations/listpaymentpayoutsresponse.md +11 -0
- package/docs/sdk/models/operations/{listaccountingrefundsrequest.md → listpaymentrefundsrequest.md} +1 -1
- package/docs/sdk/models/operations/listpaymentrefundsresponse.md +11 -0
- package/docs/sdk/models/operations/listunifiedintegrationsqueryparamcategories.md +2 -1
- package/docs/sdk/models/operations/patchpaymentlinkrequest.md +10 -0
- package/docs/sdk/models/operations/patchpaymentlinkresponse.md +11 -0
- package/docs/sdk/models/operations/patchpaymentpaymentrequest.md +10 -0
- package/docs/sdk/models/operations/patchpaymentpaymentresponse.md +11 -0
- package/docs/sdk/models/operations/queryparamcategories.md +2 -1
- package/docs/sdk/models/operations/{removeaccountingpaymentrequest.md → removepaymentlinkrequest.md} +2 -2
- package/docs/sdk/models/operations/{removeaccountingpaymentresponse.md → removepaymentlinkresponse.md} +1 -1
- package/docs/sdk/models/operations/removepaymentpaymentrequest.md +9 -0
- package/docs/sdk/models/operations/removepaymentpaymentresponse.md +11 -0
- package/docs/sdk/models/operations/scopes.md +6 -4
- package/docs/sdk/models/operations/updatepaymentlinkrequest.md +10 -0
- package/docs/sdk/models/operations/updatepaymentlinkresponse.md +11 -0
- package/docs/sdk/models/operations/updatepaymentpaymentrequest.md +10 -0
- package/docs/sdk/models/operations/updatepaymentpaymentresponse.md +11 -0
- package/docs/sdk/models/shared/accountinginvoice.md +2 -1
- package/docs/sdk/models/shared/objecttype.md +4 -3
- package/docs/sdk/models/shared/paymenntlinklineitem.md +24 -0
- package/docs/sdk/models/shared/paymentlink.md +18 -0
- package/docs/sdk/models/shared/{accountingpayment.md → paymentpayment.md} +1 -1
- package/docs/sdk/models/shared/paymentpayout.md +15 -0
- package/docs/sdk/models/shared/{accountingpayoutstatus.md → paymentpayoutstatus.md} +1 -1
- package/docs/sdk/models/shared/paymentrefund.md +17 -0
- package/docs/sdk/models/shared/{accountingrefundstatus.md → paymentrefundstatus.md} +1 -1
- package/docs/sdk/models/shared/propertyconnectioncategories.md +2 -1
- package/docs/sdk/models/shared/propertyconnectionpermissions.md +6 -4
- package/docs/sdk/models/shared/propertyintegrationcategories.md +2 -1
- package/package.json +1 -1
- package/docs/sdk/models/operations/createaccountingpaymentrequest.md +0 -9
- package/docs/sdk/models/operations/createaccountingpaymentresponse.md +0 -11
- package/docs/sdk/models/operations/getaccountingpaymentresponse.md +0 -11
- package/docs/sdk/models/operations/getaccountingpayoutresponse.md +0 -11
- package/docs/sdk/models/operations/getaccountingrefundresponse.md +0 -11
- package/docs/sdk/models/operations/listaccountingpaymentsresponse.md +0 -11
- package/docs/sdk/models/operations/listaccountingpayoutsresponse.md +0 -11
- package/docs/sdk/models/operations/listaccountingrefundsresponse.md +0 -11
- package/docs/sdk/models/operations/patchaccountingpaymentrequest.md +0 -10
- package/docs/sdk/models/operations/patchaccountingpaymentresponse.md +0 -11
- package/docs/sdk/models/operations/updateaccountingpaymentrequest.md +0 -10
- package/docs/sdk/models/operations/updateaccountingpaymentresponse.md +0 -11
- package/docs/sdk/models/shared/accountingpayout.md +0 -15
- package/docs/sdk/models/shared/accountingrefund.md +0 -17
- package/docs/sdks/account/README.md +0 -312
- package/docs/sdks/accounting/README.md +0 -2198
- package/docs/sdks/activity/README.md +0 -321
- package/docs/sdks/apicall/README.md +0 -95
- package/docs/sdks/application/README.md +0 -333
- package/docs/sdks/applicationstatus/README.md +0 -54
- package/docs/sdks/ats/README.md +0 -2488
- package/docs/sdks/auth/README.md +0 -103
- package/docs/sdks/call/README.md +0 -54
- package/docs/sdks/candidate/README.md +0 -369
- package/docs/sdks/collection/README.md +0 -348
- package/docs/sdks/commerce/README.md +0 -1371
- package/docs/sdks/company/README.md +0 -517
- package/docs/sdks/connection/README.md +0 -359
- package/docs/sdks/contact/README.md +0 -1028
- package/docs/sdks/crm/README.md +0 -2048
- package/docs/sdks/customer/README.md +0 -348
- package/docs/sdks/deal/README.md +0 -315
- package/docs/sdks/document/README.md +0 -309
- package/docs/sdks/employee/README.md +0 -363
- package/docs/sdks/enrich/README.md +0 -97
- package/docs/sdks/event/README.md +0 -390
- package/docs/sdks/file/README.md +0 -330
- package/docs/sdks/group/README.md +0 -327
- package/docs/sdks/hris/README.md +0 -685
- package/docs/sdks/integration/README.md +0 -155
- package/docs/sdks/interview/README.md +0 -318
- package/docs/sdks/inventory/README.md +0 -309
- package/docs/sdks/invoice/README.md +0 -324
- package/docs/sdks/issue/README.md +0 -49
- package/docs/sdks/item/README.md +0 -417
- package/docs/sdks/job/README.md +0 -396
- package/docs/sdks/lead/README.md +0 -336
- package/docs/sdks/list/README.md +0 -306
- package/docs/sdks/location/README.md +0 -312
- package/docs/sdks/login/README.md +0 -52
- package/docs/sdks/martech/README.md +0 -643
- package/docs/sdks/member/README.md +0 -342
- package/docs/sdks/note/README.md +0 -306
- package/docs/sdks/organization/README.md +0 -104
- package/docs/sdks/passthrough/README.md +0 -249
- package/docs/sdks/payment/README.md +0 -306
- package/docs/sdks/payout/README.md +0 -104
- package/docs/sdks/person/README.md +0 -51
- package/docs/sdks/pipeline/README.md +0 -306
- package/docs/sdks/refund/README.md +0 -104
- package/docs/sdks/scorecard/README.md +0 -324
- package/docs/sdks/storage/README.md +0 -330
- package/docs/sdks/taxrate/README.md +0 -312
- package/docs/sdks/ticket/README.md +0 -318
- package/docs/sdks/ticketing/README.md +0 -962
- package/docs/sdks/transaction/README.md +0 -327
- package/docs/sdks/uc/README.md +0 -388
- package/docs/sdks/unified/README.md +0 -929
- package/docs/sdks/unifiedto/README.md +0 -9
- package/docs/sdks/webhook/README.md +0 -291
|
@@ -1,1371 +0,0 @@
|
|
|
1
|
-
# Commerce
|
|
2
|
-
(*commerce*)
|
|
3
|
-
|
|
4
|
-
### Available Operations
|
|
5
|
-
|
|
6
|
-
* [createCommerceCollection](#createcommercecollection) - Create a collection
|
|
7
|
-
* [createCommerceInventory](#createcommerceinventory) - Create an inventory
|
|
8
|
-
* [createCommerceItem](#createcommerceitem) - Create an item
|
|
9
|
-
* [createCommerceLocation](#createcommercelocation) - Create a location
|
|
10
|
-
* [getCommerceCollection](#getcommercecollection) - Retrieve a collection
|
|
11
|
-
* [getCommerceInventory](#getcommerceinventory) - Retrieve an inventory
|
|
12
|
-
* [getCommerceItem](#getcommerceitem) - Retrieve an item
|
|
13
|
-
* [getCommerceLocation](#getcommercelocation) - Retrieve a location
|
|
14
|
-
* [listCommerceCollections](#listcommercecollections) - List all collections
|
|
15
|
-
* [listCommerceInventories](#listcommerceinventories) - List all inventories
|
|
16
|
-
* [listCommerceItems](#listcommerceitems) - List all items
|
|
17
|
-
* [listCommerceLocations](#listcommercelocations) - List all locations
|
|
18
|
-
* [patchCommerceCollection](#patchcommercecollection) - Update a collection
|
|
19
|
-
* [patchCommerceInventory](#patchcommerceinventory) - Update an inventory
|
|
20
|
-
* [patchCommerceItem](#patchcommerceitem) - Update an item
|
|
21
|
-
* [patchCommerceLocation](#patchcommercelocation) - Update a location
|
|
22
|
-
* [removeCommerceCollection](#removecommercecollection) - Remove a collection
|
|
23
|
-
* [removeCommerceInventory](#removecommerceinventory) - Remove an inventory
|
|
24
|
-
* [removeCommerceItem](#removecommerceitem) - Remove an item
|
|
25
|
-
* [removeCommerceLocation](#removecommercelocation) - Remove a location
|
|
26
|
-
* [updateCommerceCollection](#updatecommercecollection) - Update a collection
|
|
27
|
-
* [updateCommerceInventory](#updatecommerceinventory) - Update an inventory
|
|
28
|
-
* [updateCommerceItem](#updatecommerceitem) - Update an item
|
|
29
|
-
* [updateCommerceLocation](#updatecommercelocation) - Update a location
|
|
30
|
-
|
|
31
|
-
## createCommerceCollection
|
|
32
|
-
|
|
33
|
-
Create a collection
|
|
34
|
-
|
|
35
|
-
### Example Usage
|
|
36
|
-
|
|
37
|
-
```typescript
|
|
38
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
39
|
-
import { CommerceItemMediaType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
|
|
40
|
-
|
|
41
|
-
async function run() {
|
|
42
|
-
const sdk = new UnifiedTo({
|
|
43
|
-
security: {
|
|
44
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
45
|
-
},
|
|
46
|
-
});
|
|
47
|
-
|
|
48
|
-
const res = await sdk.commerce.createCommerceCollection({
|
|
49
|
-
commerceCollection: {
|
|
50
|
-
id: "<id>",
|
|
51
|
-
itemIds: [
|
|
52
|
-
"<value>",
|
|
53
|
-
],
|
|
54
|
-
media: [
|
|
55
|
-
{
|
|
56
|
-
url: "http://uneven-mattress.name",
|
|
57
|
-
},
|
|
58
|
-
],
|
|
59
|
-
name: "<value>",
|
|
60
|
-
raw: {
|
|
61
|
-
"key": "<value>",
|
|
62
|
-
},
|
|
63
|
-
tags: [
|
|
64
|
-
"<value>",
|
|
65
|
-
],
|
|
66
|
-
},
|
|
67
|
-
connectionId: "<value>",
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
if (res.statusCode == 200) {
|
|
71
|
-
// handle response
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
run();
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Parameters
|
|
79
|
-
|
|
80
|
-
| Parameter | Type | Required | Description |
|
|
81
|
-
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
82
|
-
| `request` | [operations.CreateCommerceCollectionRequest](../../sdk/models/operations/createcommercecollectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
83
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
### Response
|
|
87
|
-
|
|
88
|
-
**Promise<[operations.CreateCommerceCollectionResponse](../../sdk/models/operations/createcommercecollectionresponse.md)>**
|
|
89
|
-
### Errors
|
|
90
|
-
|
|
91
|
-
| Error Object | Status Code | Content Type |
|
|
92
|
-
| --------------- | --------------- | --------------- |
|
|
93
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
94
|
-
|
|
95
|
-
## createCommerceInventory
|
|
96
|
-
|
|
97
|
-
Create an inventory
|
|
98
|
-
|
|
99
|
-
### Example Usage
|
|
100
|
-
|
|
101
|
-
```typescript
|
|
102
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
103
|
-
|
|
104
|
-
async function run() {
|
|
105
|
-
const sdk = new UnifiedTo({
|
|
106
|
-
security: {
|
|
107
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
108
|
-
},
|
|
109
|
-
});
|
|
110
|
-
|
|
111
|
-
const res = await sdk.commerce.createCommerceInventory({
|
|
112
|
-
commerceInventory: {
|
|
113
|
-
available: 5165.08,
|
|
114
|
-
raw: {
|
|
115
|
-
"key": "<value>",
|
|
116
|
-
},
|
|
117
|
-
},
|
|
118
|
-
connectionId: "<value>",
|
|
119
|
-
});
|
|
120
|
-
|
|
121
|
-
if (res.statusCode == 200) {
|
|
122
|
-
// handle response
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
run();
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### Parameters
|
|
130
|
-
|
|
131
|
-
| Parameter | Type | Required | Description |
|
|
132
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
133
|
-
| `request` | [operations.CreateCommerceInventoryRequest](../../sdk/models/operations/createcommerceinventoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
134
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
### Response
|
|
138
|
-
|
|
139
|
-
**Promise<[operations.CreateCommerceInventoryResponse](../../sdk/models/operations/createcommerceinventoryresponse.md)>**
|
|
140
|
-
### Errors
|
|
141
|
-
|
|
142
|
-
| Error Object | Status Code | Content Type |
|
|
143
|
-
| --------------- | --------------- | --------------- |
|
|
144
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
145
|
-
|
|
146
|
-
## createCommerceItem
|
|
147
|
-
|
|
148
|
-
Create an item
|
|
149
|
-
|
|
150
|
-
### Example Usage
|
|
151
|
-
|
|
152
|
-
```typescript
|
|
153
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
154
|
-
import { CommerceItemMediaType, SizeUnit, WeightUnit } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
|
|
155
|
-
|
|
156
|
-
async function run() {
|
|
157
|
-
const sdk = new UnifiedTo({
|
|
158
|
-
security: {
|
|
159
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
160
|
-
},
|
|
161
|
-
});
|
|
162
|
-
|
|
163
|
-
const res = await sdk.commerce.createCommerceItem({
|
|
164
|
-
commerceItem: {
|
|
165
|
-
media: [
|
|
166
|
-
{
|
|
167
|
-
url: "http://loud-minister.name",
|
|
168
|
-
},
|
|
169
|
-
],
|
|
170
|
-
name: "<value>",
|
|
171
|
-
raw: {
|
|
172
|
-
"key": "<value>",
|
|
173
|
-
},
|
|
174
|
-
tags: [
|
|
175
|
-
"<value>",
|
|
176
|
-
],
|
|
177
|
-
variants: [
|
|
178
|
-
{
|
|
179
|
-
media: [
|
|
180
|
-
{
|
|
181
|
-
url: "http://other-external.info",
|
|
182
|
-
},
|
|
183
|
-
],
|
|
184
|
-
name: "<value>",
|
|
185
|
-
options: [
|
|
186
|
-
{
|
|
187
|
-
id: "<id>",
|
|
188
|
-
name: "<value>",
|
|
189
|
-
values: [
|
|
190
|
-
"<value>",
|
|
191
|
-
],
|
|
192
|
-
},
|
|
193
|
-
],
|
|
194
|
-
prices: [
|
|
195
|
-
{
|
|
196
|
-
price: 3330.74,
|
|
197
|
-
},
|
|
198
|
-
],
|
|
199
|
-
tags: [
|
|
200
|
-
"<value>",
|
|
201
|
-
],
|
|
202
|
-
},
|
|
203
|
-
],
|
|
204
|
-
},
|
|
205
|
-
connectionId: "<value>",
|
|
206
|
-
});
|
|
207
|
-
|
|
208
|
-
if (res.statusCode == 200) {
|
|
209
|
-
// handle response
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
run();
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
### Parameters
|
|
217
|
-
|
|
218
|
-
| Parameter | Type | Required | Description |
|
|
219
|
-
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
220
|
-
| `request` | [operations.CreateCommerceItemRequest](../../sdk/models/operations/createcommerceitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
221
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
### Response
|
|
225
|
-
|
|
226
|
-
**Promise<[operations.CreateCommerceItemResponse](../../sdk/models/operations/createcommerceitemresponse.md)>**
|
|
227
|
-
### Errors
|
|
228
|
-
|
|
229
|
-
| Error Object | Status Code | Content Type |
|
|
230
|
-
| --------------- | --------------- | --------------- |
|
|
231
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
232
|
-
|
|
233
|
-
## createCommerceLocation
|
|
234
|
-
|
|
235
|
-
Create a location
|
|
236
|
-
|
|
237
|
-
### Example Usage
|
|
238
|
-
|
|
239
|
-
```typescript
|
|
240
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
241
|
-
|
|
242
|
-
async function run() {
|
|
243
|
-
const sdk = new UnifiedTo({
|
|
244
|
-
security: {
|
|
245
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
246
|
-
},
|
|
247
|
-
});
|
|
248
|
-
|
|
249
|
-
const res = await sdk.commerce.createCommerceLocation({
|
|
250
|
-
commerceLocation: {
|
|
251
|
-
address: {},
|
|
252
|
-
name: "<value>",
|
|
253
|
-
raw: {
|
|
254
|
-
"key": "<value>",
|
|
255
|
-
},
|
|
256
|
-
},
|
|
257
|
-
connectionId: "<value>",
|
|
258
|
-
});
|
|
259
|
-
|
|
260
|
-
if (res.statusCode == 200) {
|
|
261
|
-
// handle response
|
|
262
|
-
}
|
|
263
|
-
}
|
|
264
|
-
|
|
265
|
-
run();
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
### Parameters
|
|
269
|
-
|
|
270
|
-
| Parameter | Type | Required | Description |
|
|
271
|
-
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
272
|
-
| `request` | [operations.CreateCommerceLocationRequest](../../sdk/models/operations/createcommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
273
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
### Response
|
|
277
|
-
|
|
278
|
-
**Promise<[operations.CreateCommerceLocationResponse](../../sdk/models/operations/createcommercelocationresponse.md)>**
|
|
279
|
-
### Errors
|
|
280
|
-
|
|
281
|
-
| Error Object | Status Code | Content Type |
|
|
282
|
-
| --------------- | --------------- | --------------- |
|
|
283
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
284
|
-
|
|
285
|
-
## getCommerceCollection
|
|
286
|
-
|
|
287
|
-
Retrieve a collection
|
|
288
|
-
|
|
289
|
-
### Example Usage
|
|
290
|
-
|
|
291
|
-
```typescript
|
|
292
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
293
|
-
|
|
294
|
-
async function run() {
|
|
295
|
-
const sdk = new UnifiedTo({
|
|
296
|
-
security: {
|
|
297
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
298
|
-
},
|
|
299
|
-
});
|
|
300
|
-
|
|
301
|
-
const res = await sdk.commerce.getCommerceCollection({
|
|
302
|
-
connectionId: "<value>",
|
|
303
|
-
fields: [
|
|
304
|
-
"<value>",
|
|
305
|
-
],
|
|
306
|
-
id: "<id>",
|
|
307
|
-
});
|
|
308
|
-
|
|
309
|
-
if (res.statusCode == 200) {
|
|
310
|
-
// handle response
|
|
311
|
-
}
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
run();
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
### Parameters
|
|
318
|
-
|
|
319
|
-
| Parameter | Type | Required | Description |
|
|
320
|
-
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
321
|
-
| `request` | [operations.GetCommerceCollectionRequest](../../sdk/models/operations/getcommercecollectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
322
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
### Response
|
|
326
|
-
|
|
327
|
-
**Promise<[operations.GetCommerceCollectionResponse](../../sdk/models/operations/getcommercecollectionresponse.md)>**
|
|
328
|
-
### Errors
|
|
329
|
-
|
|
330
|
-
| Error Object | Status Code | Content Type |
|
|
331
|
-
| --------------- | --------------- | --------------- |
|
|
332
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
333
|
-
|
|
334
|
-
## getCommerceInventory
|
|
335
|
-
|
|
336
|
-
Retrieve an inventory
|
|
337
|
-
|
|
338
|
-
### Example Usage
|
|
339
|
-
|
|
340
|
-
```typescript
|
|
341
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
342
|
-
|
|
343
|
-
async function run() {
|
|
344
|
-
const sdk = new UnifiedTo({
|
|
345
|
-
security: {
|
|
346
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
347
|
-
},
|
|
348
|
-
});
|
|
349
|
-
|
|
350
|
-
const res = await sdk.commerce.getCommerceInventory({
|
|
351
|
-
connectionId: "<value>",
|
|
352
|
-
fields: [
|
|
353
|
-
"<value>",
|
|
354
|
-
],
|
|
355
|
-
id: "<id>",
|
|
356
|
-
});
|
|
357
|
-
|
|
358
|
-
if (res.statusCode == 200) {
|
|
359
|
-
// handle response
|
|
360
|
-
}
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
run();
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
### Parameters
|
|
367
|
-
|
|
368
|
-
| Parameter | Type | Required | Description |
|
|
369
|
-
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
370
|
-
| `request` | [operations.GetCommerceInventoryRequest](../../sdk/models/operations/getcommerceinventoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
371
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
### Response
|
|
375
|
-
|
|
376
|
-
**Promise<[operations.GetCommerceInventoryResponse](../../sdk/models/operations/getcommerceinventoryresponse.md)>**
|
|
377
|
-
### Errors
|
|
378
|
-
|
|
379
|
-
| Error Object | Status Code | Content Type |
|
|
380
|
-
| --------------- | --------------- | --------------- |
|
|
381
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
382
|
-
|
|
383
|
-
## getCommerceItem
|
|
384
|
-
|
|
385
|
-
Retrieve an item
|
|
386
|
-
|
|
387
|
-
### Example Usage
|
|
388
|
-
|
|
389
|
-
```typescript
|
|
390
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
391
|
-
|
|
392
|
-
async function run() {
|
|
393
|
-
const sdk = new UnifiedTo({
|
|
394
|
-
security: {
|
|
395
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
396
|
-
},
|
|
397
|
-
});
|
|
398
|
-
|
|
399
|
-
const res = await sdk.commerce.getCommerceItem({
|
|
400
|
-
connectionId: "<value>",
|
|
401
|
-
fields: [
|
|
402
|
-
"<value>",
|
|
403
|
-
],
|
|
404
|
-
id: "<id>",
|
|
405
|
-
});
|
|
406
|
-
|
|
407
|
-
if (res.statusCode == 200) {
|
|
408
|
-
// handle response
|
|
409
|
-
}
|
|
410
|
-
}
|
|
411
|
-
|
|
412
|
-
run();
|
|
413
|
-
```
|
|
414
|
-
|
|
415
|
-
### Parameters
|
|
416
|
-
|
|
417
|
-
| Parameter | Type | Required | Description |
|
|
418
|
-
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
419
|
-
| `request` | [operations.GetCommerceItemRequest](../../sdk/models/operations/getcommerceitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
420
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
### Response
|
|
424
|
-
|
|
425
|
-
**Promise<[operations.GetCommerceItemResponse](../../sdk/models/operations/getcommerceitemresponse.md)>**
|
|
426
|
-
### Errors
|
|
427
|
-
|
|
428
|
-
| Error Object | Status Code | Content Type |
|
|
429
|
-
| --------------- | --------------- | --------------- |
|
|
430
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
431
|
-
|
|
432
|
-
## getCommerceLocation
|
|
433
|
-
|
|
434
|
-
Retrieve a location
|
|
435
|
-
|
|
436
|
-
### Example Usage
|
|
437
|
-
|
|
438
|
-
```typescript
|
|
439
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
440
|
-
|
|
441
|
-
async function run() {
|
|
442
|
-
const sdk = new UnifiedTo({
|
|
443
|
-
security: {
|
|
444
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
445
|
-
},
|
|
446
|
-
});
|
|
447
|
-
|
|
448
|
-
const res = await sdk.commerce.getCommerceLocation({
|
|
449
|
-
connectionId: "<value>",
|
|
450
|
-
fields: [
|
|
451
|
-
"<value>",
|
|
452
|
-
],
|
|
453
|
-
id: "<id>",
|
|
454
|
-
});
|
|
455
|
-
|
|
456
|
-
if (res.statusCode == 200) {
|
|
457
|
-
// handle response
|
|
458
|
-
}
|
|
459
|
-
}
|
|
460
|
-
|
|
461
|
-
run();
|
|
462
|
-
```
|
|
463
|
-
|
|
464
|
-
### Parameters
|
|
465
|
-
|
|
466
|
-
| Parameter | Type | Required | Description |
|
|
467
|
-
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
468
|
-
| `request` | [operations.GetCommerceLocationRequest](../../sdk/models/operations/getcommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
469
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
### Response
|
|
473
|
-
|
|
474
|
-
**Promise<[operations.GetCommerceLocationResponse](../../sdk/models/operations/getcommercelocationresponse.md)>**
|
|
475
|
-
### Errors
|
|
476
|
-
|
|
477
|
-
| Error Object | Status Code | Content Type |
|
|
478
|
-
| --------------- | --------------- | --------------- |
|
|
479
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
480
|
-
|
|
481
|
-
## listCommerceCollections
|
|
482
|
-
|
|
483
|
-
List all collections
|
|
484
|
-
|
|
485
|
-
### Example Usage
|
|
486
|
-
|
|
487
|
-
```typescript
|
|
488
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
489
|
-
|
|
490
|
-
async function run() {
|
|
491
|
-
const sdk = new UnifiedTo({
|
|
492
|
-
security: {
|
|
493
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
494
|
-
},
|
|
495
|
-
});
|
|
496
|
-
|
|
497
|
-
const res = await sdk.commerce.listCommerceCollections({
|
|
498
|
-
connectionId: "<value>",
|
|
499
|
-
fields: [
|
|
500
|
-
"<value>",
|
|
501
|
-
],
|
|
502
|
-
});
|
|
503
|
-
|
|
504
|
-
if (res.statusCode == 200) {
|
|
505
|
-
// handle response
|
|
506
|
-
}
|
|
507
|
-
}
|
|
508
|
-
|
|
509
|
-
run();
|
|
510
|
-
```
|
|
511
|
-
|
|
512
|
-
### Parameters
|
|
513
|
-
|
|
514
|
-
| Parameter | Type | Required | Description |
|
|
515
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
516
|
-
| `request` | [operations.ListCommerceCollectionsRequest](../../sdk/models/operations/listcommercecollectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
517
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
### Response
|
|
521
|
-
|
|
522
|
-
**Promise<[operations.ListCommerceCollectionsResponse](../../sdk/models/operations/listcommercecollectionsresponse.md)>**
|
|
523
|
-
### Errors
|
|
524
|
-
|
|
525
|
-
| Error Object | Status Code | Content Type |
|
|
526
|
-
| --------------- | --------------- | --------------- |
|
|
527
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
528
|
-
|
|
529
|
-
## listCommerceInventories
|
|
530
|
-
|
|
531
|
-
List all inventories
|
|
532
|
-
|
|
533
|
-
### Example Usage
|
|
534
|
-
|
|
535
|
-
```typescript
|
|
536
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
537
|
-
|
|
538
|
-
async function run() {
|
|
539
|
-
const sdk = new UnifiedTo({
|
|
540
|
-
security: {
|
|
541
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
542
|
-
},
|
|
543
|
-
});
|
|
544
|
-
|
|
545
|
-
const res = await sdk.commerce.listCommerceInventories({
|
|
546
|
-
connectionId: "<value>",
|
|
547
|
-
fields: [
|
|
548
|
-
"<value>",
|
|
549
|
-
],
|
|
550
|
-
});
|
|
551
|
-
|
|
552
|
-
if (res.statusCode == 200) {
|
|
553
|
-
// handle response
|
|
554
|
-
}
|
|
555
|
-
}
|
|
556
|
-
|
|
557
|
-
run();
|
|
558
|
-
```
|
|
559
|
-
|
|
560
|
-
### Parameters
|
|
561
|
-
|
|
562
|
-
| Parameter | Type | Required | Description |
|
|
563
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
564
|
-
| `request` | [operations.ListCommerceInventoriesRequest](../../sdk/models/operations/listcommerceinventoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
565
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
### Response
|
|
569
|
-
|
|
570
|
-
**Promise<[operations.ListCommerceInventoriesResponse](../../sdk/models/operations/listcommerceinventoriesresponse.md)>**
|
|
571
|
-
### Errors
|
|
572
|
-
|
|
573
|
-
| Error Object | Status Code | Content Type |
|
|
574
|
-
| --------------- | --------------- | --------------- |
|
|
575
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
576
|
-
|
|
577
|
-
## listCommerceItems
|
|
578
|
-
|
|
579
|
-
List all items
|
|
580
|
-
|
|
581
|
-
### Example Usage
|
|
582
|
-
|
|
583
|
-
```typescript
|
|
584
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
585
|
-
|
|
586
|
-
async function run() {
|
|
587
|
-
const sdk = new UnifiedTo({
|
|
588
|
-
security: {
|
|
589
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
590
|
-
},
|
|
591
|
-
});
|
|
592
|
-
|
|
593
|
-
const res = await sdk.commerce.listCommerceItems({
|
|
594
|
-
connectionId: "<value>",
|
|
595
|
-
fields: [
|
|
596
|
-
"<value>",
|
|
597
|
-
],
|
|
598
|
-
});
|
|
599
|
-
|
|
600
|
-
if (res.statusCode == 200) {
|
|
601
|
-
// handle response
|
|
602
|
-
}
|
|
603
|
-
}
|
|
604
|
-
|
|
605
|
-
run();
|
|
606
|
-
```
|
|
607
|
-
|
|
608
|
-
### Parameters
|
|
609
|
-
|
|
610
|
-
| Parameter | Type | Required | Description |
|
|
611
|
-
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
612
|
-
| `request` | [operations.ListCommerceItemsRequest](../../sdk/models/operations/listcommerceitemsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
613
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
### Response
|
|
617
|
-
|
|
618
|
-
**Promise<[operations.ListCommerceItemsResponse](../../sdk/models/operations/listcommerceitemsresponse.md)>**
|
|
619
|
-
### Errors
|
|
620
|
-
|
|
621
|
-
| Error Object | Status Code | Content Type |
|
|
622
|
-
| --------------- | --------------- | --------------- |
|
|
623
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
624
|
-
|
|
625
|
-
## listCommerceLocations
|
|
626
|
-
|
|
627
|
-
List all locations
|
|
628
|
-
|
|
629
|
-
### Example Usage
|
|
630
|
-
|
|
631
|
-
```typescript
|
|
632
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
633
|
-
|
|
634
|
-
async function run() {
|
|
635
|
-
const sdk = new UnifiedTo({
|
|
636
|
-
security: {
|
|
637
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
638
|
-
},
|
|
639
|
-
});
|
|
640
|
-
|
|
641
|
-
const res = await sdk.commerce.listCommerceLocations({
|
|
642
|
-
connectionId: "<value>",
|
|
643
|
-
fields: [
|
|
644
|
-
"<value>",
|
|
645
|
-
],
|
|
646
|
-
});
|
|
647
|
-
|
|
648
|
-
if (res.statusCode == 200) {
|
|
649
|
-
// handle response
|
|
650
|
-
}
|
|
651
|
-
}
|
|
652
|
-
|
|
653
|
-
run();
|
|
654
|
-
```
|
|
655
|
-
|
|
656
|
-
### Parameters
|
|
657
|
-
|
|
658
|
-
| Parameter | Type | Required | Description |
|
|
659
|
-
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
660
|
-
| `request` | [operations.ListCommerceLocationsRequest](../../sdk/models/operations/listcommercelocationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
661
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
### Response
|
|
665
|
-
|
|
666
|
-
**Promise<[operations.ListCommerceLocationsResponse](../../sdk/models/operations/listcommercelocationsresponse.md)>**
|
|
667
|
-
### Errors
|
|
668
|
-
|
|
669
|
-
| Error Object | Status Code | Content Type |
|
|
670
|
-
| --------------- | --------------- | --------------- |
|
|
671
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
672
|
-
|
|
673
|
-
## patchCommerceCollection
|
|
674
|
-
|
|
675
|
-
Update a collection
|
|
676
|
-
|
|
677
|
-
### Example Usage
|
|
678
|
-
|
|
679
|
-
```typescript
|
|
680
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
681
|
-
import { CommerceItemMediaType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
|
|
682
|
-
|
|
683
|
-
async function run() {
|
|
684
|
-
const sdk = new UnifiedTo({
|
|
685
|
-
security: {
|
|
686
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
687
|
-
},
|
|
688
|
-
});
|
|
689
|
-
|
|
690
|
-
const res = await sdk.commerce.patchCommerceCollection({
|
|
691
|
-
commerceCollection: {
|
|
692
|
-
id: "<id>",
|
|
693
|
-
itemIds: [
|
|
694
|
-
"<value>",
|
|
695
|
-
],
|
|
696
|
-
media: [
|
|
697
|
-
{
|
|
698
|
-
url: "http://personal-sorrow.com",
|
|
699
|
-
},
|
|
700
|
-
],
|
|
701
|
-
name: "<value>",
|
|
702
|
-
raw: {
|
|
703
|
-
"key": "<value>",
|
|
704
|
-
},
|
|
705
|
-
tags: [
|
|
706
|
-
"<value>",
|
|
707
|
-
],
|
|
708
|
-
},
|
|
709
|
-
connectionId: "<value>",
|
|
710
|
-
id: "<id>",
|
|
711
|
-
});
|
|
712
|
-
|
|
713
|
-
if (res.statusCode == 200) {
|
|
714
|
-
// handle response
|
|
715
|
-
}
|
|
716
|
-
}
|
|
717
|
-
|
|
718
|
-
run();
|
|
719
|
-
```
|
|
720
|
-
|
|
721
|
-
### Parameters
|
|
722
|
-
|
|
723
|
-
| Parameter | Type | Required | Description |
|
|
724
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
725
|
-
| `request` | [operations.PatchCommerceCollectionRequest](../../sdk/models/operations/patchcommercecollectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
726
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
### Response
|
|
730
|
-
|
|
731
|
-
**Promise<[operations.PatchCommerceCollectionResponse](../../sdk/models/operations/patchcommercecollectionresponse.md)>**
|
|
732
|
-
### Errors
|
|
733
|
-
|
|
734
|
-
| Error Object | Status Code | Content Type |
|
|
735
|
-
| --------------- | --------------- | --------------- |
|
|
736
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
737
|
-
|
|
738
|
-
## patchCommerceInventory
|
|
739
|
-
|
|
740
|
-
Update an inventory
|
|
741
|
-
|
|
742
|
-
### Example Usage
|
|
743
|
-
|
|
744
|
-
```typescript
|
|
745
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
746
|
-
|
|
747
|
-
async function run() {
|
|
748
|
-
const sdk = new UnifiedTo({
|
|
749
|
-
security: {
|
|
750
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
751
|
-
},
|
|
752
|
-
});
|
|
753
|
-
|
|
754
|
-
const res = await sdk.commerce.patchCommerceInventory({
|
|
755
|
-
commerceInventory: {
|
|
756
|
-
available: 615.23,
|
|
757
|
-
raw: {
|
|
758
|
-
"key": "<value>",
|
|
759
|
-
},
|
|
760
|
-
},
|
|
761
|
-
connectionId: "<value>",
|
|
762
|
-
id: "<id>",
|
|
763
|
-
});
|
|
764
|
-
|
|
765
|
-
if (res.statusCode == 200) {
|
|
766
|
-
// handle response
|
|
767
|
-
}
|
|
768
|
-
}
|
|
769
|
-
|
|
770
|
-
run();
|
|
771
|
-
```
|
|
772
|
-
|
|
773
|
-
### Parameters
|
|
774
|
-
|
|
775
|
-
| Parameter | Type | Required | Description |
|
|
776
|
-
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
777
|
-
| `request` | [operations.PatchCommerceInventoryRequest](../../sdk/models/operations/patchcommerceinventoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
778
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
### Response
|
|
782
|
-
|
|
783
|
-
**Promise<[operations.PatchCommerceInventoryResponse](../../sdk/models/operations/patchcommerceinventoryresponse.md)>**
|
|
784
|
-
### Errors
|
|
785
|
-
|
|
786
|
-
| Error Object | Status Code | Content Type |
|
|
787
|
-
| --------------- | --------------- | --------------- |
|
|
788
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
789
|
-
|
|
790
|
-
## patchCommerceItem
|
|
791
|
-
|
|
792
|
-
Update an item
|
|
793
|
-
|
|
794
|
-
### Example Usage
|
|
795
|
-
|
|
796
|
-
```typescript
|
|
797
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
798
|
-
import { CommerceItemMediaType, SizeUnit, WeightUnit } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
|
|
799
|
-
|
|
800
|
-
async function run() {
|
|
801
|
-
const sdk = new UnifiedTo({
|
|
802
|
-
security: {
|
|
803
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
804
|
-
},
|
|
805
|
-
});
|
|
806
|
-
|
|
807
|
-
const res = await sdk.commerce.patchCommerceItem({
|
|
808
|
-
commerceItem: {
|
|
809
|
-
media: [
|
|
810
|
-
{
|
|
811
|
-
url: "http://frank-galley.biz",
|
|
812
|
-
},
|
|
813
|
-
],
|
|
814
|
-
name: "<value>",
|
|
815
|
-
raw: {
|
|
816
|
-
"key": "<value>",
|
|
817
|
-
},
|
|
818
|
-
tags: [
|
|
819
|
-
"<value>",
|
|
820
|
-
],
|
|
821
|
-
variants: [
|
|
822
|
-
{
|
|
823
|
-
media: [
|
|
824
|
-
{
|
|
825
|
-
url: "http://irresponsible-reason.biz",
|
|
826
|
-
},
|
|
827
|
-
],
|
|
828
|
-
name: "<value>",
|
|
829
|
-
options: [
|
|
830
|
-
{
|
|
831
|
-
id: "<id>",
|
|
832
|
-
name: "<value>",
|
|
833
|
-
values: [
|
|
834
|
-
"<value>",
|
|
835
|
-
],
|
|
836
|
-
},
|
|
837
|
-
],
|
|
838
|
-
prices: [
|
|
839
|
-
{
|
|
840
|
-
price: 4506.62,
|
|
841
|
-
},
|
|
842
|
-
],
|
|
843
|
-
tags: [
|
|
844
|
-
"<value>",
|
|
845
|
-
],
|
|
846
|
-
},
|
|
847
|
-
],
|
|
848
|
-
},
|
|
849
|
-
connectionId: "<value>",
|
|
850
|
-
id: "<id>",
|
|
851
|
-
});
|
|
852
|
-
|
|
853
|
-
if (res.statusCode == 200) {
|
|
854
|
-
// handle response
|
|
855
|
-
}
|
|
856
|
-
}
|
|
857
|
-
|
|
858
|
-
run();
|
|
859
|
-
```
|
|
860
|
-
|
|
861
|
-
### Parameters
|
|
862
|
-
|
|
863
|
-
| Parameter | Type | Required | Description |
|
|
864
|
-
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
865
|
-
| `request` | [operations.PatchCommerceItemRequest](../../sdk/models/operations/patchcommerceitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
866
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
### Response
|
|
870
|
-
|
|
871
|
-
**Promise<[operations.PatchCommerceItemResponse](../../sdk/models/operations/patchcommerceitemresponse.md)>**
|
|
872
|
-
### Errors
|
|
873
|
-
|
|
874
|
-
| Error Object | Status Code | Content Type |
|
|
875
|
-
| --------------- | --------------- | --------------- |
|
|
876
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
877
|
-
|
|
878
|
-
## patchCommerceLocation
|
|
879
|
-
|
|
880
|
-
Update a location
|
|
881
|
-
|
|
882
|
-
### Example Usage
|
|
883
|
-
|
|
884
|
-
```typescript
|
|
885
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
886
|
-
|
|
887
|
-
async function run() {
|
|
888
|
-
const sdk = new UnifiedTo({
|
|
889
|
-
security: {
|
|
890
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
891
|
-
},
|
|
892
|
-
});
|
|
893
|
-
|
|
894
|
-
const res = await sdk.commerce.patchCommerceLocation({
|
|
895
|
-
commerceLocation: {
|
|
896
|
-
address: {},
|
|
897
|
-
name: "<value>",
|
|
898
|
-
raw: {
|
|
899
|
-
"key": "<value>",
|
|
900
|
-
},
|
|
901
|
-
},
|
|
902
|
-
connectionId: "<value>",
|
|
903
|
-
id: "<id>",
|
|
904
|
-
});
|
|
905
|
-
|
|
906
|
-
if (res.statusCode == 200) {
|
|
907
|
-
// handle response
|
|
908
|
-
}
|
|
909
|
-
}
|
|
910
|
-
|
|
911
|
-
run();
|
|
912
|
-
```
|
|
913
|
-
|
|
914
|
-
### Parameters
|
|
915
|
-
|
|
916
|
-
| Parameter | Type | Required | Description |
|
|
917
|
-
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
918
|
-
| `request` | [operations.PatchCommerceLocationRequest](../../sdk/models/operations/patchcommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
919
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
### Response
|
|
923
|
-
|
|
924
|
-
**Promise<[operations.PatchCommerceLocationResponse](../../sdk/models/operations/patchcommercelocationresponse.md)>**
|
|
925
|
-
### Errors
|
|
926
|
-
|
|
927
|
-
| Error Object | Status Code | Content Type |
|
|
928
|
-
| --------------- | --------------- | --------------- |
|
|
929
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
930
|
-
|
|
931
|
-
## removeCommerceCollection
|
|
932
|
-
|
|
933
|
-
Remove a collection
|
|
934
|
-
|
|
935
|
-
### Example Usage
|
|
936
|
-
|
|
937
|
-
```typescript
|
|
938
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
939
|
-
|
|
940
|
-
async function run() {
|
|
941
|
-
const sdk = new UnifiedTo({
|
|
942
|
-
security: {
|
|
943
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
944
|
-
},
|
|
945
|
-
});
|
|
946
|
-
|
|
947
|
-
const res = await sdk.commerce.removeCommerceCollection({
|
|
948
|
-
connectionId: "<value>",
|
|
949
|
-
id: "<id>",
|
|
950
|
-
});
|
|
951
|
-
|
|
952
|
-
if (res.statusCode == 200) {
|
|
953
|
-
// handle response
|
|
954
|
-
}
|
|
955
|
-
}
|
|
956
|
-
|
|
957
|
-
run();
|
|
958
|
-
```
|
|
959
|
-
|
|
960
|
-
### Parameters
|
|
961
|
-
|
|
962
|
-
| Parameter | Type | Required | Description |
|
|
963
|
-
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
964
|
-
| `request` | [operations.RemoveCommerceCollectionRequest](../../sdk/models/operations/removecommercecollectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
965
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
### Response
|
|
969
|
-
|
|
970
|
-
**Promise<[operations.RemoveCommerceCollectionResponse](../../sdk/models/operations/removecommercecollectionresponse.md)>**
|
|
971
|
-
### Errors
|
|
972
|
-
|
|
973
|
-
| Error Object | Status Code | Content Type |
|
|
974
|
-
| --------------- | --------------- | --------------- |
|
|
975
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
976
|
-
|
|
977
|
-
## removeCommerceInventory
|
|
978
|
-
|
|
979
|
-
Remove an inventory
|
|
980
|
-
|
|
981
|
-
### Example Usage
|
|
982
|
-
|
|
983
|
-
```typescript
|
|
984
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
985
|
-
|
|
986
|
-
async function run() {
|
|
987
|
-
const sdk = new UnifiedTo({
|
|
988
|
-
security: {
|
|
989
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
990
|
-
},
|
|
991
|
-
});
|
|
992
|
-
|
|
993
|
-
const res = await sdk.commerce.removeCommerceInventory({
|
|
994
|
-
connectionId: "<value>",
|
|
995
|
-
id: "<id>",
|
|
996
|
-
});
|
|
997
|
-
|
|
998
|
-
if (res.statusCode == 200) {
|
|
999
|
-
// handle response
|
|
1000
|
-
}
|
|
1001
|
-
}
|
|
1002
|
-
|
|
1003
|
-
run();
|
|
1004
|
-
```
|
|
1005
|
-
|
|
1006
|
-
### Parameters
|
|
1007
|
-
|
|
1008
|
-
| Parameter | Type | Required | Description |
|
|
1009
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
1010
|
-
| `request` | [operations.RemoveCommerceInventoryRequest](../../sdk/models/operations/removecommerceinventoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1011
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
### Response
|
|
1015
|
-
|
|
1016
|
-
**Promise<[operations.RemoveCommerceInventoryResponse](../../sdk/models/operations/removecommerceinventoryresponse.md)>**
|
|
1017
|
-
### Errors
|
|
1018
|
-
|
|
1019
|
-
| Error Object | Status Code | Content Type |
|
|
1020
|
-
| --------------- | --------------- | --------------- |
|
|
1021
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
1022
|
-
|
|
1023
|
-
## removeCommerceItem
|
|
1024
|
-
|
|
1025
|
-
Remove an item
|
|
1026
|
-
|
|
1027
|
-
### Example Usage
|
|
1028
|
-
|
|
1029
|
-
```typescript
|
|
1030
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1031
|
-
|
|
1032
|
-
async function run() {
|
|
1033
|
-
const sdk = new UnifiedTo({
|
|
1034
|
-
security: {
|
|
1035
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1036
|
-
},
|
|
1037
|
-
});
|
|
1038
|
-
|
|
1039
|
-
const res = await sdk.commerce.removeCommerceItem({
|
|
1040
|
-
connectionId: "<value>",
|
|
1041
|
-
id: "<id>",
|
|
1042
|
-
});
|
|
1043
|
-
|
|
1044
|
-
if (res.statusCode == 200) {
|
|
1045
|
-
// handle response
|
|
1046
|
-
}
|
|
1047
|
-
}
|
|
1048
|
-
|
|
1049
|
-
run();
|
|
1050
|
-
```
|
|
1051
|
-
|
|
1052
|
-
### Parameters
|
|
1053
|
-
|
|
1054
|
-
| Parameter | Type | Required | Description |
|
|
1055
|
-
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
1056
|
-
| `request` | [operations.RemoveCommerceItemRequest](../../sdk/models/operations/removecommerceitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1057
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
### Response
|
|
1061
|
-
|
|
1062
|
-
**Promise<[operations.RemoveCommerceItemResponse](../../sdk/models/operations/removecommerceitemresponse.md)>**
|
|
1063
|
-
### Errors
|
|
1064
|
-
|
|
1065
|
-
| Error Object | Status Code | Content Type |
|
|
1066
|
-
| --------------- | --------------- | --------------- |
|
|
1067
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
1068
|
-
|
|
1069
|
-
## removeCommerceLocation
|
|
1070
|
-
|
|
1071
|
-
Remove a location
|
|
1072
|
-
|
|
1073
|
-
### Example Usage
|
|
1074
|
-
|
|
1075
|
-
```typescript
|
|
1076
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1077
|
-
|
|
1078
|
-
async function run() {
|
|
1079
|
-
const sdk = new UnifiedTo({
|
|
1080
|
-
security: {
|
|
1081
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1082
|
-
},
|
|
1083
|
-
});
|
|
1084
|
-
|
|
1085
|
-
const res = await sdk.commerce.removeCommerceLocation({
|
|
1086
|
-
connectionId: "<value>",
|
|
1087
|
-
id: "<id>",
|
|
1088
|
-
});
|
|
1089
|
-
|
|
1090
|
-
if (res.statusCode == 200) {
|
|
1091
|
-
// handle response
|
|
1092
|
-
}
|
|
1093
|
-
}
|
|
1094
|
-
|
|
1095
|
-
run();
|
|
1096
|
-
```
|
|
1097
|
-
|
|
1098
|
-
### Parameters
|
|
1099
|
-
|
|
1100
|
-
| Parameter | Type | Required | Description |
|
|
1101
|
-
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1102
|
-
| `request` | [operations.RemoveCommerceLocationRequest](../../sdk/models/operations/removecommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1103
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
### Response
|
|
1107
|
-
|
|
1108
|
-
**Promise<[operations.RemoveCommerceLocationResponse](../../sdk/models/operations/removecommercelocationresponse.md)>**
|
|
1109
|
-
### Errors
|
|
1110
|
-
|
|
1111
|
-
| Error Object | Status Code | Content Type |
|
|
1112
|
-
| --------------- | --------------- | --------------- |
|
|
1113
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
1114
|
-
|
|
1115
|
-
## updateCommerceCollection
|
|
1116
|
-
|
|
1117
|
-
Update a collection
|
|
1118
|
-
|
|
1119
|
-
### Example Usage
|
|
1120
|
-
|
|
1121
|
-
```typescript
|
|
1122
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1123
|
-
import { CommerceItemMediaType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
|
|
1124
|
-
|
|
1125
|
-
async function run() {
|
|
1126
|
-
const sdk = new UnifiedTo({
|
|
1127
|
-
security: {
|
|
1128
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1129
|
-
},
|
|
1130
|
-
});
|
|
1131
|
-
|
|
1132
|
-
const res = await sdk.commerce.updateCommerceCollection({
|
|
1133
|
-
commerceCollection: {
|
|
1134
|
-
id: "<id>",
|
|
1135
|
-
itemIds: [
|
|
1136
|
-
"<value>",
|
|
1137
|
-
],
|
|
1138
|
-
media: [
|
|
1139
|
-
{
|
|
1140
|
-
url: "https://stupid-entity.org",
|
|
1141
|
-
},
|
|
1142
|
-
],
|
|
1143
|
-
name: "<value>",
|
|
1144
|
-
raw: {
|
|
1145
|
-
"key": "<value>",
|
|
1146
|
-
},
|
|
1147
|
-
tags: [
|
|
1148
|
-
"<value>",
|
|
1149
|
-
],
|
|
1150
|
-
},
|
|
1151
|
-
connectionId: "<value>",
|
|
1152
|
-
id: "<id>",
|
|
1153
|
-
});
|
|
1154
|
-
|
|
1155
|
-
if (res.statusCode == 200) {
|
|
1156
|
-
// handle response
|
|
1157
|
-
}
|
|
1158
|
-
}
|
|
1159
|
-
|
|
1160
|
-
run();
|
|
1161
|
-
```
|
|
1162
|
-
|
|
1163
|
-
### Parameters
|
|
1164
|
-
|
|
1165
|
-
| Parameter | Type | Required | Description |
|
|
1166
|
-
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
1167
|
-
| `request` | [operations.UpdateCommerceCollectionRequest](../../sdk/models/operations/updatecommercecollectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1168
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
### Response
|
|
1172
|
-
|
|
1173
|
-
**Promise<[operations.UpdateCommerceCollectionResponse](../../sdk/models/operations/updatecommercecollectionresponse.md)>**
|
|
1174
|
-
### Errors
|
|
1175
|
-
|
|
1176
|
-
| Error Object | Status Code | Content Type |
|
|
1177
|
-
| --------------- | --------------- | --------------- |
|
|
1178
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
1179
|
-
|
|
1180
|
-
## updateCommerceInventory
|
|
1181
|
-
|
|
1182
|
-
Update an inventory
|
|
1183
|
-
|
|
1184
|
-
### Example Usage
|
|
1185
|
-
|
|
1186
|
-
```typescript
|
|
1187
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1188
|
-
|
|
1189
|
-
async function run() {
|
|
1190
|
-
const sdk = new UnifiedTo({
|
|
1191
|
-
security: {
|
|
1192
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1193
|
-
},
|
|
1194
|
-
});
|
|
1195
|
-
|
|
1196
|
-
const res = await sdk.commerce.updateCommerceInventory({
|
|
1197
|
-
commerceInventory: {
|
|
1198
|
-
available: 9360.02,
|
|
1199
|
-
raw: {
|
|
1200
|
-
"key": "<value>",
|
|
1201
|
-
},
|
|
1202
|
-
},
|
|
1203
|
-
connectionId: "<value>",
|
|
1204
|
-
id: "<id>",
|
|
1205
|
-
});
|
|
1206
|
-
|
|
1207
|
-
if (res.statusCode == 200) {
|
|
1208
|
-
// handle response
|
|
1209
|
-
}
|
|
1210
|
-
}
|
|
1211
|
-
|
|
1212
|
-
run();
|
|
1213
|
-
```
|
|
1214
|
-
|
|
1215
|
-
### Parameters
|
|
1216
|
-
|
|
1217
|
-
| Parameter | Type | Required | Description |
|
|
1218
|
-
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
1219
|
-
| `request` | [operations.UpdateCommerceInventoryRequest](../../sdk/models/operations/updatecommerceinventoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1220
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
### Response
|
|
1224
|
-
|
|
1225
|
-
**Promise<[operations.UpdateCommerceInventoryResponse](../../sdk/models/operations/updatecommerceinventoryresponse.md)>**
|
|
1226
|
-
### Errors
|
|
1227
|
-
|
|
1228
|
-
| Error Object | Status Code | Content Type |
|
|
1229
|
-
| --------------- | --------------- | --------------- |
|
|
1230
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
1231
|
-
|
|
1232
|
-
## updateCommerceItem
|
|
1233
|
-
|
|
1234
|
-
Update an item
|
|
1235
|
-
|
|
1236
|
-
### Example Usage
|
|
1237
|
-
|
|
1238
|
-
```typescript
|
|
1239
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1240
|
-
import { CommerceItemMediaType, SizeUnit, WeightUnit } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
|
|
1241
|
-
|
|
1242
|
-
async function run() {
|
|
1243
|
-
const sdk = new UnifiedTo({
|
|
1244
|
-
security: {
|
|
1245
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1246
|
-
},
|
|
1247
|
-
});
|
|
1248
|
-
|
|
1249
|
-
const res = await sdk.commerce.updateCommerceItem({
|
|
1250
|
-
commerceItem: {
|
|
1251
|
-
media: [
|
|
1252
|
-
{
|
|
1253
|
-
url: "https://aggressive-major-league.org",
|
|
1254
|
-
},
|
|
1255
|
-
],
|
|
1256
|
-
name: "<value>",
|
|
1257
|
-
raw: {
|
|
1258
|
-
"key": "<value>",
|
|
1259
|
-
},
|
|
1260
|
-
tags: [
|
|
1261
|
-
"<value>",
|
|
1262
|
-
],
|
|
1263
|
-
variants: [
|
|
1264
|
-
{
|
|
1265
|
-
media: [
|
|
1266
|
-
{
|
|
1267
|
-
url: "https://reasonable-cast.biz",
|
|
1268
|
-
},
|
|
1269
|
-
],
|
|
1270
|
-
name: "<value>",
|
|
1271
|
-
options: [
|
|
1272
|
-
{
|
|
1273
|
-
id: "<id>",
|
|
1274
|
-
name: "<value>",
|
|
1275
|
-
values: [
|
|
1276
|
-
"<value>",
|
|
1277
|
-
],
|
|
1278
|
-
},
|
|
1279
|
-
],
|
|
1280
|
-
prices: [
|
|
1281
|
-
{
|
|
1282
|
-
price: 8467.25,
|
|
1283
|
-
},
|
|
1284
|
-
],
|
|
1285
|
-
tags: [
|
|
1286
|
-
"<value>",
|
|
1287
|
-
],
|
|
1288
|
-
},
|
|
1289
|
-
],
|
|
1290
|
-
},
|
|
1291
|
-
connectionId: "<value>",
|
|
1292
|
-
id: "<id>",
|
|
1293
|
-
});
|
|
1294
|
-
|
|
1295
|
-
if (res.statusCode == 200) {
|
|
1296
|
-
// handle response
|
|
1297
|
-
}
|
|
1298
|
-
}
|
|
1299
|
-
|
|
1300
|
-
run();
|
|
1301
|
-
```
|
|
1302
|
-
|
|
1303
|
-
### Parameters
|
|
1304
|
-
|
|
1305
|
-
| Parameter | Type | Required | Description |
|
|
1306
|
-
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
1307
|
-
| `request` | [operations.UpdateCommerceItemRequest](../../sdk/models/operations/updatecommerceitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1308
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
### Response
|
|
1312
|
-
|
|
1313
|
-
**Promise<[operations.UpdateCommerceItemResponse](../../sdk/models/operations/updatecommerceitemresponse.md)>**
|
|
1314
|
-
### Errors
|
|
1315
|
-
|
|
1316
|
-
| Error Object | Status Code | Content Type |
|
|
1317
|
-
| --------------- | --------------- | --------------- |
|
|
1318
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
1319
|
-
|
|
1320
|
-
## updateCommerceLocation
|
|
1321
|
-
|
|
1322
|
-
Update a location
|
|
1323
|
-
|
|
1324
|
-
### Example Usage
|
|
1325
|
-
|
|
1326
|
-
```typescript
|
|
1327
|
-
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1328
|
-
|
|
1329
|
-
async function run() {
|
|
1330
|
-
const sdk = new UnifiedTo({
|
|
1331
|
-
security: {
|
|
1332
|
-
jwt: "<YOUR_API_KEY_HERE>",
|
|
1333
|
-
},
|
|
1334
|
-
});
|
|
1335
|
-
|
|
1336
|
-
const res = await sdk.commerce.updateCommerceLocation({
|
|
1337
|
-
commerceLocation: {
|
|
1338
|
-
address: {},
|
|
1339
|
-
name: "<value>",
|
|
1340
|
-
raw: {
|
|
1341
|
-
"key": "<value>",
|
|
1342
|
-
},
|
|
1343
|
-
},
|
|
1344
|
-
connectionId: "<value>",
|
|
1345
|
-
id: "<id>",
|
|
1346
|
-
});
|
|
1347
|
-
|
|
1348
|
-
if (res.statusCode == 200) {
|
|
1349
|
-
// handle response
|
|
1350
|
-
}
|
|
1351
|
-
}
|
|
1352
|
-
|
|
1353
|
-
run();
|
|
1354
|
-
```
|
|
1355
|
-
|
|
1356
|
-
### Parameters
|
|
1357
|
-
|
|
1358
|
-
| Parameter | Type | Required | Description |
|
|
1359
|
-
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1360
|
-
| `request` | [operations.UpdateCommerceLocationRequest](../../sdk/models/operations/updatecommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1361
|
-
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
### Response
|
|
1365
|
-
|
|
1366
|
-
**Promise<[operations.UpdateCommerceLocationResponse](../../sdk/models/operations/updatecommercelocationresponse.md)>**
|
|
1367
|
-
### Errors
|
|
1368
|
-
|
|
1369
|
-
| Error Object | Status Code | Content Type |
|
|
1370
|
-
| --------------- | --------------- | --------------- |
|
|
1371
|
-
| errors.SDKError | 4xx-5xx | */* |
|