hostinger-api-sdk 1.40.2 → 1.41.1
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 +2 -2
- package/api.ts +7281 -3521
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +10985 -8179
- package/dist/api.js +1981 -108
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +10985 -8179
- package/dist/esm/api.js +1977 -117
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/EcommerceDiscountsApi.md +129 -0
- package/docs/EcommerceListDiscountsV1200Response.md +22 -0
- package/docs/EcommerceListProductVariantsV1200Response.md +22 -0
- package/docs/EcommerceListProductsV1200Response.md +22 -0
- package/docs/EcommerceListStoreOrdersV1200Response.md +22 -0
- package/docs/EcommerceOrdersApi.md +269 -0
- package/docs/EcommercePaymentsApi.md +114 -0
- package/docs/EcommerceProductVariantsApi.md +251 -0
- package/docs/EcommerceProductsApi.md +188 -0
- package/docs/EcommerceSalesChannelsApi.md +5 -5
- package/docs/EcommerceV1DiscountCreateDiscountRequest.md +38 -0
- package/docs/EcommerceV1DiscountDiscountResource.md +40 -0
- package/docs/EcommerceV1DiscountDiscountResponseResource.md +20 -0
- package/docs/EcommerceV1OrderCancelRequest.md +20 -0
- package/docs/EcommerceV1OrderFulfillRequest.md +26 -0
- package/docs/EcommerceV1OrderFulfillRequestItemsInner.md +22 -0
- package/docs/EcommerceV1OrderOrderDetailResource.md +60 -0
- package/docs/EcommerceV1OrderOrderDetailResourceBillingAddress.md +37 -0
- package/docs/EcommerceV1OrderOrderDetailResourceFulfillmentsInner.md +28 -0
- package/docs/EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner.md +22 -0
- package/docs/EcommerceV1OrderOrderDetailResourceItemsInner.md +36 -0
- package/docs/EcommerceV1OrderOrderDetailResourceShippingAddress.md +37 -0
- package/docs/EcommerceV1OrderOrderDetailResponseResource.md +20 -0
- package/docs/EcommerceV1OrderOrderResource.md +38 -0
- package/docs/EcommerceV1OrderOrderResponseResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderConnectLinkResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData.md +22 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceData.md +22 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner.md +28 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner.md +30 -0
- package/docs/EcommerceV1ProductProductDeletedResource.md +20 -0
- package/docs/EcommerceV1ProductProductDeletedResourceData.md +24 -0
- package/docs/EcommerceV1ProductProductResource.md +36 -0
- package/docs/EcommerceV1ProductProductResourceMediaInner.md +24 -0
- package/docs/EcommerceV1ProductProductResourcePriceRange.md +25 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInner.md +32 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInnerOptionsInner.md +22 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInnerPricesInner.md +24 -0
- package/docs/EcommerceV1ProductProductResponseResource.md +20 -0
- package/docs/EcommerceV1ProductUpdateRequest.md +24 -0
- package/docs/EcommerceV1SalesChannelStoreRequest.md +3 -3
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequest.md +20 -0
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner.md +28 -0
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner.md +24 -0
- package/docs/EcommerceV1VariantCreateVariantRequest.md +30 -0
- package/docs/EcommerceV1VariantCreateVariantRequestOptionsInner.md +22 -0
- package/docs/EcommerceV1VariantCreateVariantRequestPricesInner.md +24 -0
- package/docs/EcommerceV1VariantVariantDeletedResource.md +20 -0
- package/docs/EcommerceV1VariantVariantDeletedResourceData.md +22 -0
- package/docs/EcommerceV1VariantVariantListResponseResource.md +20 -0
- package/docs/EcommerceV1VariantVariantResource.md +32 -0
- package/docs/EcommerceV1VariantVariantResourceOptionsInner.md +22 -0
- package/docs/EcommerceV1VariantVariantResponseResource.md +20 -0
- package/docs/HostingNodeJSApi.md +2 -2
- package/docs/ReachProfilesApi.md +108 -0
- package/docs/ReachSegmentsApi.md +113 -0
- package/docs/ReachV1ContactsSegmentsProfileFilterContactsRequest.md +33 -0
- package/docs/ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner.md +24 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterAttributeResource.md +27 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterAttributesResource.md +23 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterOperatorResource.md +29 -0
- package/docs/ReachV1ContactsStoreRequest.md +2 -0
- package/docs/ReachV1ProfilesDomainsSendingDomainResource.md +29 -0
- package/docs/ReachV1ProfilesDomainsSuspendedSenderEmailResource.md +25 -0
- package/docs/ReachV1ProfilesFeaturesPlanFeatureResource.md +25 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1DiscountDiscountResponseResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1DiscountDiscountResource**](EcommerceV1DiscountDiscountResource.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1DiscountDiscountResponseResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1DiscountDiscountResponseResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1OrderCancelRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**notify_customer** | **boolean** | Whether to email the customer about the cancellation. Defaults to true. | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1OrderCancelRequest } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1OrderCancelRequest = {
|
|
16
|
+
notify_customer,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# EcommerceV1OrderFulfillRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**items** | [**Array<EcommerceV1OrderFulfillRequestItemsInner>**](EcommerceV1OrderFulfillRequestItemsInner.md) | Line items to fulfil. Omit to fulfil every remaining unfulfilled item. | [optional] [default to undefined]
|
|
9
|
+
**tracking_number** | **string** | Carrier tracking number for the shipment. | [optional] [default to undefined]
|
|
10
|
+
**tracking_url** | **string** | Public tracking URL for the shipment. Requires tracking_number. | [optional] [default to undefined]
|
|
11
|
+
**notify_customer** | **boolean** | Whether to email the customer about the fulfilment. Defaults to true. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { EcommerceV1OrderFulfillRequest } from 'hostinger-api-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: EcommerceV1OrderFulfillRequest = {
|
|
19
|
+
items,
|
|
20
|
+
tracking_number,
|
|
21
|
+
tracking_url,
|
|
22
|
+
notify_customer,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1OrderFulfillRequestItemsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**line_item_id** | **string** | The line item to fulfil, from the order detail items[].id. | [default to undefined]
|
|
9
|
+
**quantity** | **number** | Quantity of the line item to fulfil. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1OrderFulfillRequestItemsInner } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1OrderFulfillRequestItemsInner = {
|
|
17
|
+
line_item_id,
|
|
18
|
+
quantity,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderDetailResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The order ID. | [optional] [default to undefined]
|
|
9
|
+
**display_id** | **number** | The order number. | [optional] [default to undefined]
|
|
10
|
+
**status** | **string** | The order status. | [optional] [default to undefined]
|
|
11
|
+
**payment_status** | **string** | The payment status. | [optional] [default to undefined]
|
|
12
|
+
**fulfillment_status** | **string** | The fulfilment status. | [optional] [default to undefined]
|
|
13
|
+
**total** | **number** | Order total in the smallest currency unit. | [optional] [default to undefined]
|
|
14
|
+
**currency_code** | **string** | The order currency code. | [optional] [default to undefined]
|
|
15
|
+
**customer_email** | **string** | The customer email. | [optional] [default to undefined]
|
|
16
|
+
**item_count** | **number** | Number of distinct line items. | [optional] [default to undefined]
|
|
17
|
+
**created_at** | **string** | ISO timestamp of when the order was created. | [optional] [default to undefined]
|
|
18
|
+
**merchant_note** | **string** | Internal note visible only to the merchant. | [optional] [default to undefined]
|
|
19
|
+
**subtotal** | **number** | Subtotal in the smallest currency unit. | [optional] [default to undefined]
|
|
20
|
+
**discount_total** | **number** | Discount total in the smallest currency unit. | [optional] [default to undefined]
|
|
21
|
+
**tax_total** | **number** | Tax total in the smallest currency unit. | [optional] [default to undefined]
|
|
22
|
+
**shipping_total** | **number** | Shipping total in the smallest currency unit. | [optional] [default to undefined]
|
|
23
|
+
**paid_total** | **number** | Amount paid in the smallest currency unit. | [optional] [default to undefined]
|
|
24
|
+
**refunded_total** | **number** | Amount refunded in the smallest currency unit. | [optional] [default to undefined]
|
|
25
|
+
**shipping_address** | [**EcommerceV1OrderOrderDetailResourceShippingAddress**](EcommerceV1OrderOrderDetailResourceShippingAddress.md) | | [optional] [default to undefined]
|
|
26
|
+
**billing_address** | [**EcommerceV1OrderOrderDetailResourceBillingAddress**](EcommerceV1OrderOrderDetailResourceBillingAddress.md) | | [optional] [default to undefined]
|
|
27
|
+
**items** | [**Array<EcommerceV1OrderOrderDetailResourceItemsInner>**](EcommerceV1OrderOrderDetailResourceItemsInner.md) | The order line items. | [optional] [default to undefined]
|
|
28
|
+
**fulfillments** | [**Array<EcommerceV1OrderOrderDetailResourceFulfillmentsInner>**](EcommerceV1OrderOrderDetailResourceFulfillmentsInner.md) | The order fulfilments with tracking. | [optional] [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { EcommerceV1OrderOrderDetailResource } from 'hostinger-api-sdk';
|
|
34
|
+
|
|
35
|
+
const instance: EcommerceV1OrderOrderDetailResource = {
|
|
36
|
+
id,
|
|
37
|
+
display_id,
|
|
38
|
+
status,
|
|
39
|
+
payment_status,
|
|
40
|
+
fulfillment_status,
|
|
41
|
+
total,
|
|
42
|
+
currency_code,
|
|
43
|
+
customer_email,
|
|
44
|
+
item_count,
|
|
45
|
+
created_at,
|
|
46
|
+
merchant_note,
|
|
47
|
+
subtotal,
|
|
48
|
+
discount_total,
|
|
49
|
+
tax_total,
|
|
50
|
+
shipping_total,
|
|
51
|
+
paid_total,
|
|
52
|
+
refunded_total,
|
|
53
|
+
shipping_address,
|
|
54
|
+
billing_address,
|
|
55
|
+
items,
|
|
56
|
+
fulfillments,
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderDetailResourceBillingAddress
|
|
2
|
+
|
|
3
|
+
The billing address, or null.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**company** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**address_1** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**address_2** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**city** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**province_code** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**postal_code** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**country_code** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { EcommerceV1OrderOrderDetailResourceBillingAddress } from 'hostinger-api-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: EcommerceV1OrderOrderDetailResourceBillingAddress = {
|
|
25
|
+
name,
|
|
26
|
+
company,
|
|
27
|
+
address_1,
|
|
28
|
+
address_2,
|
|
29
|
+
city,
|
|
30
|
+
province_code,
|
|
31
|
+
postal_code,
|
|
32
|
+
country_code,
|
|
33
|
+
phone,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderDetailResourceFulfillmentsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The fulfilment ID. | [optional] [default to undefined]
|
|
9
|
+
**created_at** | **string** | ISO timestamp of when the fulfilment was created. | [optional] [default to undefined]
|
|
10
|
+
**shipped_at** | **string** | ISO timestamp of when the fulfilment shipped, if known. | [optional] [default to undefined]
|
|
11
|
+
**canceled_at** | **string** | ISO timestamp of when the fulfilment was canceled, if any. | [optional] [default to undefined]
|
|
12
|
+
**tracking** | [**Array<EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner>**](EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner.md) | Tracking numbers attached to the fulfilment. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { EcommerceV1OrderOrderDetailResourceFulfillmentsInner } from 'hostinger-api-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: EcommerceV1OrderOrderDetailResourceFulfillmentsInner = {
|
|
20
|
+
id,
|
|
21
|
+
created_at,
|
|
22
|
+
shipped_at,
|
|
23
|
+
canceled_at,
|
|
24
|
+
tracking,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**tracking_number** | **string** | Carrier tracking number. | [optional] [default to undefined]
|
|
9
|
+
**url** | **string** | Public tracking URL, when available. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner = {
|
|
17
|
+
tracking_number,
|
|
18
|
+
url,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderDetailResourceItemsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The line item ID, required by the fulfil endpoint. | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | The line item title. | [optional] [default to undefined]
|
|
10
|
+
**sku** | **string** | The variant SKU. | [optional] [default to undefined]
|
|
11
|
+
**variant_id** | **string** | The variant ID. | [optional] [default to undefined]
|
|
12
|
+
**quantity** | **number** | Quantity ordered. | [optional] [default to undefined]
|
|
13
|
+
**fulfilled_quantity** | **number** | Quantity already fulfilled. | [optional] [default to undefined]
|
|
14
|
+
**returned_quantity** | **number** | Quantity returned. | [optional] [default to undefined]
|
|
15
|
+
**unit_price** | **number** | Unit price in the smallest currency unit. | [optional] [default to undefined]
|
|
16
|
+
**total** | **number** | Line total in the smallest currency unit. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { EcommerceV1OrderOrderDetailResourceItemsInner } from 'hostinger-api-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: EcommerceV1OrderOrderDetailResourceItemsInner = {
|
|
24
|
+
id,
|
|
25
|
+
title,
|
|
26
|
+
sku,
|
|
27
|
+
variant_id,
|
|
28
|
+
quantity,
|
|
29
|
+
fulfilled_quantity,
|
|
30
|
+
returned_quantity,
|
|
31
|
+
unit_price,
|
|
32
|
+
total,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderDetailResourceShippingAddress
|
|
2
|
+
|
|
3
|
+
The shipping address, or null.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**company** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**address_1** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**address_2** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**city** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**province_code** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**postal_code** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**country_code** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { EcommerceV1OrderOrderDetailResourceShippingAddress } from 'hostinger-api-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: EcommerceV1OrderOrderDetailResourceShippingAddress = {
|
|
25
|
+
name,
|
|
26
|
+
company,
|
|
27
|
+
address_1,
|
|
28
|
+
address_2,
|
|
29
|
+
city,
|
|
30
|
+
province_code,
|
|
31
|
+
postal_code,
|
|
32
|
+
country_code,
|
|
33
|
+
phone,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderDetailResponseResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1OrderOrderDetailResource**](EcommerceV1OrderOrderDetailResource.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1OrderOrderDetailResponseResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1OrderOrderDetailResponseResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The order ID, required by every other order endpoint. | [optional] [default to undefined]
|
|
9
|
+
**display_id** | **number** | The order number the merchant and customer see. | [optional] [default to undefined]
|
|
10
|
+
**status** | **string** | The order status. | [optional] [default to undefined]
|
|
11
|
+
**payment_status** | **string** | The payment status. A paid order is \"captured\". | [optional] [default to undefined]
|
|
12
|
+
**fulfillment_status** | **string** | The fulfilment status. | [optional] [default to undefined]
|
|
13
|
+
**total** | **number** | Order total in the smallest currency unit. | [optional] [default to undefined]
|
|
14
|
+
**currency_code** | **string** | The order currency code. | [optional] [default to undefined]
|
|
15
|
+
**customer_email** | **string** | The customer email. | [optional] [default to undefined]
|
|
16
|
+
**item_count** | **number** | Number of distinct line items. Retrieve the order for the items themselves. | [optional] [default to undefined]
|
|
17
|
+
**created_at** | **string** | ISO timestamp of when the order was created. | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { EcommerceV1OrderOrderResource } from 'hostinger-api-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: EcommerceV1OrderOrderResource = {
|
|
25
|
+
id,
|
|
26
|
+
display_id,
|
|
27
|
+
status,
|
|
28
|
+
payment_status,
|
|
29
|
+
fulfillment_status,
|
|
30
|
+
total,
|
|
31
|
+
currency_code,
|
|
32
|
+
customer_email,
|
|
33
|
+
item_count,
|
|
34
|
+
created_at,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1OrderOrderResponseResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1OrderOrderResource**](EcommerceV1OrderOrderResource.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1OrderOrderResponseResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1OrderOrderResponseResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1PaymentProviderPaymentProviderConnectLinkResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData**](EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1PaymentProviderPaymentProviderConnectLinkResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1PaymentProviderPaymentProviderConnectLinkResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**url** | **string** | The gateway onboarding URL for the merchant to open. | [optional] [default to undefined]
|
|
9
|
+
**admin_url** | **string** | A deep-link into the store admin for the provider. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData = {
|
|
17
|
+
url,
|
|
18
|
+
admin_url,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1PaymentProviderPaymentProviderListResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1PaymentProviderPaymentProviderListResourceData**](EcommerceV1PaymentProviderPaymentProviderListResourceData.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1PaymentProviderPaymentProviderListResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1PaymentProviderPaymentProviderListResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EcommerceV1PaymentProviderPaymentProviderListResourceData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**connected** | [**Array<EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner>**](EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner.md) | Payment providers already connected to the store. | [optional] [default to undefined]
|
|
9
|
+
**available** | [**Array<EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner>**](EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner.md) | Payment gateways available to install for the store. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EcommerceV1PaymentProviderPaymentProviderListResourceData } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EcommerceV1PaymentProviderPaymentProviderListResourceData = {
|
|
17
|
+
connected,
|
|
18
|
+
available,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The payment gateway ID, e.g. stripe. | [optional] [default to undefined]
|
|
9
|
+
**is_installed** | **boolean** | Whether the gateway is installed on the store. | [optional] [default to undefined]
|
|
10
|
+
**is_enabled** | **boolean** | Whether the gateway is enabled on the store. | [optional] [default to undefined]
|
|
11
|
+
**is_currency_supported** | **boolean** | Whether the gateway supports the store currency. | [optional] [default to undefined]
|
|
12
|
+
**supported_currencies** | **Array<string>** | Currencies the gateway supports; present only when the store currency is unsupported. | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner } from 'hostinger-api-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner = {
|
|
20
|
+
id,
|
|
21
|
+
is_installed,
|
|
22
|
+
is_enabled,
|
|
23
|
+
is_currency_supported,
|
|
24
|
+
supported_currencies,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The store payment provider row ID. | [optional] [default to undefined]
|
|
9
|
+
**provider_id** | **string** | The payment gateway ID, e.g. stripe. | [optional] [default to undefined]
|
|
10
|
+
**title** | **string** | The provider title, or null. | [optional] [default to undefined]
|
|
11
|
+
**is_enabled** | **boolean** | Whether the provider is enabled for the store. | [optional] [default to undefined]
|
|
12
|
+
**status** | **string** | The connection status. | [optional] [default to undefined]
|
|
13
|
+
**shows_at_checkout** | **boolean** | Whether the provider shows at checkout. | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner } from 'hostinger-api-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner = {
|
|
21
|
+
id,
|
|
22
|
+
provider_id,
|
|
23
|
+
title,
|
|
24
|
+
is_enabled,
|
|
25
|
+
status,
|
|
26
|
+
shows_at_checkout,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EcommerceV1ProductProductDeletedResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**EcommerceV1ProductProductDeletedResourceData**](EcommerceV1ProductProductDeletedResourceData.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EcommerceV1ProductProductDeletedResource } from 'hostinger-api-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EcommerceV1ProductProductDeletedResource = {
|
|
16
|
+
data,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# EcommerceV1ProductProductDeletedResourceData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The ID of the product. | [optional] [default to undefined]
|
|
9
|
+
**is_deleted** | **boolean** | True when the product was deleted. | [optional] [default to undefined]
|
|
10
|
+
**is_archived** | **boolean** | True when the product was archived instead of deleted (a subscription product with active subscribers). | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EcommerceV1ProductProductDeletedResourceData } from 'hostinger-api-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: EcommerceV1ProductProductDeletedResourceData = {
|
|
18
|
+
id,
|
|
19
|
+
is_deleted,
|
|
20
|
+
is_archived,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# EcommerceV1ProductProductResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | The product ID, required by every other product endpoint. | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | The product name. | [optional] [default to undefined]
|
|
10
|
+
**status** | **string** | The product status. | [optional] [default to undefined]
|
|
11
|
+
**thumbnail** | **string** | The product\'s primary image URL, or null. | [optional] [default to undefined]
|
|
12
|
+
**type** | **string** | The product type. | [optional] [default to undefined]
|
|
13
|
+
**variant_count** | **number** | Number of variants. Use include=variants to retrieve them. | [optional] [default to undefined]
|
|
14
|
+
**price_range** | [**EcommerceV1ProductProductResourcePriceRange**](EcommerceV1ProductProductResourcePriceRange.md) | | [optional] [default to undefined]
|
|
15
|
+
**variants** | [**Array<EcommerceV1ProductProductResourceVariantsInner>**](EcommerceV1ProductProductResourceVariantsInner.md) | Present (non-null) only when include=variants is set; null otherwise. | [optional] [default to undefined]
|
|
16
|
+
**media** | [**Array<EcommerceV1ProductProductResourceMediaInner>**](EcommerceV1ProductProductResourceMediaInner.md) | Present (non-null) only when include=media is set; null otherwise. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { EcommerceV1ProductProductResource } from 'hostinger-api-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: EcommerceV1ProductProductResource = {
|
|
24
|
+
id,
|
|
25
|
+
title,
|
|
26
|
+
status,
|
|
27
|
+
thumbnail,
|
|
28
|
+
type,
|
|
29
|
+
variant_count,
|
|
30
|
+
price_range,
|
|
31
|
+
variants,
|
|
32
|
+
media,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# EcommerceV1ProductProductResourceMediaInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**url** | **string** | The media URL. | [optional] [default to undefined]
|
|
9
|
+
**type** | **string** | The media type, e.g. image or video. | [optional] [default to undefined]
|
|
10
|
+
**is_thumbnail** | **boolean** | Whether this media is the product\'s thumbnail. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EcommerceV1ProductProductResourceMediaInner } from 'hostinger-api-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: EcommerceV1ProductProductResourceMediaInner = {
|
|
18
|
+
url,
|
|
19
|
+
type,
|
|
20
|
+
is_thumbnail,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|