@zippendo/sdk 1.2.4 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/OrderChannelsApi.d.ts +195 -0
- package/dist/apis/OrderChannelsApi.js +496 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/OrderChannelsApi.d.ts +195 -0
- package/dist/esm/apis/OrderChannelsApi.js +492 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -0
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +1 -0
- package/dist/esm/models/CreateOrderChannelRequest.d.ts +65 -0
- package/dist/esm/models/CreateOrderChannelRequest.js +61 -0
- package/dist/esm/models/CreateOrderChannelRequestSettings.d.ts +105 -0
- package/dist/esm/models/CreateOrderChannelRequestSettings.js +66 -0
- package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +52 -0
- package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.js +56 -0
- package/dist/esm/models/CreateOrderChannelWebhookSecret201Response.d.ts +44 -0
- package/dist/esm/models/CreateOrderChannelWebhookSecret201Response.js +51 -0
- package/dist/esm/models/CreateOrderRequest.d.ts +12 -0
- package/dist/esm/models/CreateOrderRequest.js +4 -0
- package/dist/esm/models/GetOrderChannelWebhookStatus200Response.d.ts +45 -0
- package/dist/esm/models/GetOrderChannelWebhookStatus200Response.js +52 -0
- package/dist/esm/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.d.ts +62 -0
- package/dist/esm/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.js +59 -0
- package/dist/esm/models/ListApiTokens401Response.d.ts +1 -0
- package/dist/esm/models/ListApiTokens401Response.js +1 -0
- package/dist/esm/models/ListOrderChannels200Response.d.ts +57 -0
- package/dist/esm/models/ListOrderChannels200Response.js +60 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInner.d.ts +121 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInner.js +97 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettings.d.ts +129 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettings.js +86 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +52 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.js +56 -0
- package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -0
- package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.js +2 -1
- package/dist/esm/models/RevokeOrderChannelWebhookSecret200Response.d.ts +32 -0
- package/dist/esm/models/RevokeOrderChannelWebhookSecret200Response.js +43 -0
- package/dist/esm/models/SendShipment422Response.d.ts +1 -0
- package/dist/esm/models/SendShipment422Response.js +1 -0
- package/dist/esm/models/UpdateOrderChannelRequest.d.ts +65 -0
- package/dist/esm/models/UpdateOrderChannelRequest.js +52 -0
- package/dist/esm/models/UpdateOrderChannelRequestSettings.d.ts +105 -0
- package/dist/esm/models/UpdateOrderChannelRequestSettings.js +66 -0
- package/dist/esm/models/index.d.ts +13 -0
- package/dist/esm/models/index.js +13 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +1 -0
- package/dist/models/CreateOrderChannelRequest.d.ts +65 -0
- package/dist/models/CreateOrderChannelRequest.js +69 -0
- package/dist/models/CreateOrderChannelRequestSettings.d.ts +105 -0
- package/dist/models/CreateOrderChannelRequestSettings.js +73 -0
- package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +52 -0
- package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.js +64 -0
- package/dist/models/CreateOrderChannelWebhookSecret201Response.d.ts +44 -0
- package/dist/models/CreateOrderChannelWebhookSecret201Response.js +58 -0
- package/dist/models/CreateOrderRequest.d.ts +12 -0
- package/dist/models/CreateOrderRequest.js +4 -0
- package/dist/models/GetOrderChannelWebhookStatus200Response.d.ts +45 -0
- package/dist/models/GetOrderChannelWebhookStatus200Response.js +59 -0
- package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.d.ts +62 -0
- package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.js +66 -0
- package/dist/models/ListApiTokens401Response.d.ts +1 -0
- package/dist/models/ListApiTokens401Response.js +1 -0
- package/dist/models/ListOrderChannels200Response.d.ts +57 -0
- package/dist/models/ListOrderChannels200Response.js +67 -0
- package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +121 -0
- package/dist/models/ListOrderChannels200ResponseDataInner.js +105 -0
- package/dist/models/ListOrderChannels200ResponseDataInnerSettings.d.ts +129 -0
- package/dist/models/ListOrderChannels200ResponseDataInnerSettings.js +93 -0
- package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +52 -0
- package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.js +64 -0
- package/dist/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -0
- package/dist/models/ListOrders200ResponseDataInnerOrderChannel.js +2 -1
- package/dist/models/RevokeOrderChannelWebhookSecret200Response.d.ts +32 -0
- package/dist/models/RevokeOrderChannelWebhookSecret200Response.js +50 -0
- package/dist/models/SendShipment422Response.d.ts +1 -0
- package/dist/models/SendShipment422Response.js +1 -0
- package/dist/models/UpdateOrderChannelRequest.d.ts +65 -0
- package/dist/models/UpdateOrderChannelRequest.js +59 -0
- package/dist/models/UpdateOrderChannelRequestSettings.d.ts +105 -0
- package/dist/models/UpdateOrderChannelRequestSettings.js +73 -0
- package/dist/models/index.d.ts +13 -0
- package/dist/models/index.js +13 -0
- package/docs/CreateOrderChannelRequest.md +42 -0
- package/docs/CreateOrderChannelRequestSettings.md +58 -0
- package/docs/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md +38 -0
- package/docs/CreateOrderChannelWebhookSecret201Response.md +38 -0
- package/docs/CreateOrderRequest.md +4 -0
- package/docs/GetOrderChannelWebhookStatus200Response.md +38 -0
- package/docs/GetOrderChannelWebhookStatus200ResponseWebhooksInner.md +44 -0
- package/docs/ListOrderChannels200Response.md +42 -0
- package/docs/ListOrderChannels200ResponseDataInner.md +60 -0
- package/docs/ListOrderChannels200ResponseDataInnerSettings.md +67 -0
- package/docs/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md +38 -0
- package/docs/OrderChannelsApi.md +650 -0
- package/docs/OrdersApi.md +1 -0
- package/docs/RevokeOrderChannelWebhookSecret200Response.md +34 -0
- package/docs/UpdateOrderChannelRequest.md +44 -0
- package/docs/UpdateOrderChannelRequestSettings.md +59 -0
- package/package.json +1 -1
- package/src/apis/OrderChannelsApi.ts +670 -0
- package/src/apis/index.ts +1 -0
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +1 -0
- package/src/models/CreateOrderChannelRequest.ts +118 -0
- package/src/models/CreateOrderChannelRequestSettings.ts +169 -0
- package/src/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.ts +94 -0
- package/src/models/CreateOrderChannelWebhookSecret201Response.ts +84 -0
- package/src/models/CreateOrderRequest.ts +16 -0
- package/src/models/GetOrderChannelWebhookStatus200Response.ts +92 -0
- package/src/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.ts +109 -0
- package/src/models/ListApiTokens401Response.ts +1 -0
- package/src/models/ListOrderChannels200Response.ts +110 -0
- package/src/models/ListOrderChannels200ResponseDataInner.ts +200 -0
- package/src/models/ListOrderChannels200ResponseDataInnerSettings.ts +207 -0
- package/src/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.ts +94 -0
- package/src/models/ListOrders200ResponseDataInnerOrderChannel.ts +2 -1
- package/src/models/RevokeOrderChannelWebhookSecret200Response.ts +66 -0
- package/src/models/SendShipment422Response.ts +1 -0
- package/src/models/UpdateOrderChannelRequest.ts +113 -0
- package/src/models/UpdateOrderChannelRequestSettings.ts +169 -0
- package/src/models/index.ts +13 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Zippendo Public API
|
|
3
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: support@zippendo.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { CreateOrderChannelRequestSettingsShippingMethodMappingsInner } from './CreateOrderChannelRequestSettingsShippingMethodMappingsInner';
|
|
13
|
+
/**
|
|
14
|
+
* Partial channel settings to merge into existing settings. Server-managed fields (webhook secret/ids, checkout token) cannot be set here.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface UpdateOrderChannelRequestSettings
|
|
17
|
+
*/
|
|
18
|
+
export interface UpdateOrderChannelRequestSettings {
|
|
19
|
+
/**
|
|
20
|
+
* Use webhooks for real-time order sync.
|
|
21
|
+
* @type {boolean}
|
|
22
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
23
|
+
*/
|
|
24
|
+
useWebhooks?: boolean;
|
|
25
|
+
/**
|
|
26
|
+
* WooCommerce store URL.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
29
|
+
*/
|
|
30
|
+
siteUrl?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Push tracking back to the platform when a shipment is dispatched. Enabled by default (opt-out) — set to false to disable write-back; an unset value still syncs.
|
|
33
|
+
* @type {boolean}
|
|
34
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
35
|
+
*/
|
|
36
|
+
autoFulfill?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* Periodically poll the channel for new orders.
|
|
39
|
+
* @type {boolean}
|
|
40
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
41
|
+
*/
|
|
42
|
+
autoSync?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Polling interval in minutes (5-1440).
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
47
|
+
*/
|
|
48
|
+
syncIntervalMinutes?: number;
|
|
49
|
+
/**
|
|
50
|
+
* Create a shipment automatically when an order arrives.
|
|
51
|
+
* @type {boolean}
|
|
52
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
53
|
+
*/
|
|
54
|
+
autoShipOnCreate?: boolean;
|
|
55
|
+
/**
|
|
56
|
+
* Default carrier ID for auto-shipping.
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
59
|
+
*/
|
|
60
|
+
defaultCarrierId?: string | null;
|
|
61
|
+
/**
|
|
62
|
+
* Default carrier product ID for auto-shipping.
|
|
63
|
+
* @type {string}
|
|
64
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
65
|
+
*/
|
|
66
|
+
defaultProductId?: string | null;
|
|
67
|
+
/**
|
|
68
|
+
* Default sender address ID for auto-shipping.
|
|
69
|
+
* @type {string}
|
|
70
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
71
|
+
*/
|
|
72
|
+
defaultAddressId?: string | null;
|
|
73
|
+
/**
|
|
74
|
+
* Map imported shipping-method titles to shipping rules, for channels without checkout rate integration.
|
|
75
|
+
* @type {Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>}
|
|
76
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
77
|
+
*/
|
|
78
|
+
shippingMethodMappings?: Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>;
|
|
79
|
+
/**
|
|
80
|
+
* Only import orders that are not yet fulfilled.
|
|
81
|
+
* @type {boolean}
|
|
82
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
83
|
+
*/
|
|
84
|
+
syncOnlyUnfulfilled?: boolean;
|
|
85
|
+
/**
|
|
86
|
+
* Only sync orders placed at or after this timestamp.
|
|
87
|
+
* @type {Date}
|
|
88
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
89
|
+
*/
|
|
90
|
+
syncOrdersSince?: Date | null;
|
|
91
|
+
/**
|
|
92
|
+
* Number of service points to show at checkout (1-20).
|
|
93
|
+
* @type {number}
|
|
94
|
+
* @memberof UpdateOrderChannelRequestSettings
|
|
95
|
+
*/
|
|
96
|
+
servicePointCount?: number;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Check if a given object implements the UpdateOrderChannelRequestSettings interface.
|
|
100
|
+
*/
|
|
101
|
+
export declare function instanceOfUpdateOrderChannelRequestSettings(value: object): value is UpdateOrderChannelRequestSettings;
|
|
102
|
+
export declare function UpdateOrderChannelRequestSettingsFromJSON(json: any): UpdateOrderChannelRequestSettings;
|
|
103
|
+
export declare function UpdateOrderChannelRequestSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrderChannelRequestSettings;
|
|
104
|
+
export declare function UpdateOrderChannelRequestSettingsToJSON(json: any): UpdateOrderChannelRequestSettings;
|
|
105
|
+
export declare function UpdateOrderChannelRequestSettingsToJSONTyped(value?: UpdateOrderChannelRequestSettings | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Zippendo Public API
|
|
6
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: support@zippendo.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfUpdateOrderChannelRequestSettings = instanceOfUpdateOrderChannelRequestSettings;
|
|
17
|
+
exports.UpdateOrderChannelRequestSettingsFromJSON = UpdateOrderChannelRequestSettingsFromJSON;
|
|
18
|
+
exports.UpdateOrderChannelRequestSettingsFromJSONTyped = UpdateOrderChannelRequestSettingsFromJSONTyped;
|
|
19
|
+
exports.UpdateOrderChannelRequestSettingsToJSON = UpdateOrderChannelRequestSettingsToJSON;
|
|
20
|
+
exports.UpdateOrderChannelRequestSettingsToJSONTyped = UpdateOrderChannelRequestSettingsToJSONTyped;
|
|
21
|
+
const CreateOrderChannelRequestSettingsShippingMethodMappingsInner_1 = require("./CreateOrderChannelRequestSettingsShippingMethodMappingsInner");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the UpdateOrderChannelRequestSettings interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfUpdateOrderChannelRequestSettings(value) {
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
function UpdateOrderChannelRequestSettingsFromJSON(json) {
|
|
29
|
+
return UpdateOrderChannelRequestSettingsFromJSONTyped(json, false);
|
|
30
|
+
}
|
|
31
|
+
function UpdateOrderChannelRequestSettingsFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if (json == null) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'useWebhooks': json['useWebhooks'] == null ? undefined : json['useWebhooks'],
|
|
37
|
+
'siteUrl': json['siteUrl'] == null ? undefined : json['siteUrl'],
|
|
38
|
+
'autoFulfill': json['autoFulfill'] == null ? undefined : json['autoFulfill'],
|
|
39
|
+
'autoSync': json['autoSync'] == null ? undefined : json['autoSync'],
|
|
40
|
+
'syncIntervalMinutes': json['syncIntervalMinutes'] == null ? undefined : json['syncIntervalMinutes'],
|
|
41
|
+
'autoShipOnCreate': json['autoShipOnCreate'] == null ? undefined : json['autoShipOnCreate'],
|
|
42
|
+
'defaultCarrierId': json['defaultCarrierId'] === undefined ? undefined : json['defaultCarrierId'] === null ? null : json['defaultCarrierId'],
|
|
43
|
+
'defaultProductId': json['defaultProductId'] === undefined ? undefined : json['defaultProductId'] === null ? null : json['defaultProductId'],
|
|
44
|
+
'defaultAddressId': json['defaultAddressId'] === undefined ? undefined : json['defaultAddressId'] === null ? null : json['defaultAddressId'],
|
|
45
|
+
'shippingMethodMappings': json['shippingMethodMappings'] == null ? undefined : (json['shippingMethodMappings'].map(CreateOrderChannelRequestSettingsShippingMethodMappingsInner_1.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON)),
|
|
46
|
+
'syncOnlyUnfulfilled': json['syncOnlyUnfulfilled'] == null ? undefined : json['syncOnlyUnfulfilled'],
|
|
47
|
+
'syncOrdersSince': json['syncOrdersSince'] === undefined ? undefined : json['syncOrdersSince'] === null ? null : (new Date(json['syncOrdersSince'])),
|
|
48
|
+
'servicePointCount': json['servicePointCount'] == null ? undefined : json['servicePointCount'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function UpdateOrderChannelRequestSettingsToJSON(json) {
|
|
52
|
+
return UpdateOrderChannelRequestSettingsToJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function UpdateOrderChannelRequestSettingsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
55
|
+
if (value == null) {
|
|
56
|
+
return value;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'useWebhooks': value['useWebhooks'],
|
|
60
|
+
'siteUrl': value['siteUrl'],
|
|
61
|
+
'autoFulfill': value['autoFulfill'],
|
|
62
|
+
'autoSync': value['autoSync'],
|
|
63
|
+
'syncIntervalMinutes': value['syncIntervalMinutes'],
|
|
64
|
+
'autoShipOnCreate': value['autoShipOnCreate'],
|
|
65
|
+
'defaultCarrierId': value['defaultCarrierId'],
|
|
66
|
+
'defaultProductId': value['defaultProductId'],
|
|
67
|
+
'defaultAddressId': value['defaultAddressId'],
|
|
68
|
+
'shippingMethodMappings': value['shippingMethodMappings'] == null ? undefined : (value['shippingMethodMappings'].map(CreateOrderChannelRequestSettingsShippingMethodMappingsInner_1.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON)),
|
|
69
|
+
'syncOnlyUnfulfilled': value['syncOnlyUnfulfilled'],
|
|
70
|
+
'syncOrdersSince': value['syncOrdersSince'] == null ? value['syncOrdersSince'] : value['syncOrdersSince'].toISOString(),
|
|
71
|
+
'servicePointCount': value['servicePointCount'],
|
|
72
|
+
};
|
|
73
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -14,6 +14,10 @@ export * from './CreateApiTokenRequest';
|
|
|
14
14
|
export * from './CreateOrder201Response';
|
|
15
15
|
export * from './CreateOrder201ResponseOrderLinesInner';
|
|
16
16
|
export * from './CreateOrder201ResponseShippingAddress';
|
|
17
|
+
export * from './CreateOrderChannelRequest';
|
|
18
|
+
export * from './CreateOrderChannelRequestSettings';
|
|
19
|
+
export * from './CreateOrderChannelRequestSettingsShippingMethodMappingsInner';
|
|
20
|
+
export * from './CreateOrderChannelWebhookSecret201Response';
|
|
17
21
|
export * from './CreateOrderRequest';
|
|
18
22
|
export * from './CreateOrderRequestOrderLinesInner';
|
|
19
23
|
export * from './CreateOrderRequestShippingAddress';
|
|
@@ -71,6 +75,8 @@ export * from './GetBillingUsage200ResponseZippyMessages';
|
|
|
71
75
|
export * from './GetOrder200Response';
|
|
72
76
|
export * from './GetOrder200ResponseShipmentsInner';
|
|
73
77
|
export * from './GetOrder200ResponseShippingRule';
|
|
78
|
+
export * from './GetOrderChannelWebhookStatus200Response';
|
|
79
|
+
export * from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';
|
|
74
80
|
export * from './GetOrg200Response';
|
|
75
81
|
export * from './GetOrg200ResponseCount';
|
|
76
82
|
export * from './GetOrgBranding200Response';
|
|
@@ -94,6 +100,10 @@ export * from './ListCarrierProducts200ResponseInnerWeightLimits';
|
|
|
94
100
|
export * from './ListCarriers200Response';
|
|
95
101
|
export * from './ListCarriers200ResponseDataInner';
|
|
96
102
|
export * from './ListCarriers200ResponseDataInnerConfigValue';
|
|
103
|
+
export * from './ListOrderChannels200Response';
|
|
104
|
+
export * from './ListOrderChannels200ResponseDataInner';
|
|
105
|
+
export * from './ListOrderChannels200ResponseDataInnerSettings';
|
|
106
|
+
export * from './ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner';
|
|
97
107
|
export * from './ListOrders200Response';
|
|
98
108
|
export * from './ListOrders200ResponseDataInner';
|
|
99
109
|
export * from './ListOrders200ResponseDataInnerOrderChannel';
|
|
@@ -122,6 +132,7 @@ export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf4';
|
|
|
122
132
|
export * from './ListShippingRules200ResponseDataInnerLabelPrinter';
|
|
123
133
|
export * from './ListShippingRules200ResponseDataInnerReturnShippingRule';
|
|
124
134
|
export * from './RevokeApiToken200Response';
|
|
135
|
+
export * from './RevokeOrderChannelWebhookSecret200Response';
|
|
125
136
|
export * from './SendShipment422Response';
|
|
126
137
|
export * from './SendShipment422ResponseErrorsInner';
|
|
127
138
|
export * from './SplitShipment201Response';
|
|
@@ -135,6 +146,8 @@ export * from './TrackShipment200ResponseEventsInner';
|
|
|
135
146
|
export * from './UpdateAddressRequest';
|
|
136
147
|
export * from './UpdateApiTokenRequest';
|
|
137
148
|
export * from './UpdateCarrierRequest';
|
|
149
|
+
export * from './UpdateOrderChannelRequest';
|
|
150
|
+
export * from './UpdateOrderChannelRequestSettings';
|
|
138
151
|
export * from './UpdateOrderRequest';
|
|
139
152
|
export * from './UpdateOrg200Response';
|
|
140
153
|
export * from './UpdateOrgBrandRequest';
|
package/dist/models/index.js
CHANGED
|
@@ -32,6 +32,10 @@ __exportStar(require("./CreateApiTokenRequest"), exports);
|
|
|
32
32
|
__exportStar(require("./CreateOrder201Response"), exports);
|
|
33
33
|
__exportStar(require("./CreateOrder201ResponseOrderLinesInner"), exports);
|
|
34
34
|
__exportStar(require("./CreateOrder201ResponseShippingAddress"), exports);
|
|
35
|
+
__exportStar(require("./CreateOrderChannelRequest"), exports);
|
|
36
|
+
__exportStar(require("./CreateOrderChannelRequestSettings"), exports);
|
|
37
|
+
__exportStar(require("./CreateOrderChannelRequestSettingsShippingMethodMappingsInner"), exports);
|
|
38
|
+
__exportStar(require("./CreateOrderChannelWebhookSecret201Response"), exports);
|
|
35
39
|
__exportStar(require("./CreateOrderRequest"), exports);
|
|
36
40
|
__exportStar(require("./CreateOrderRequestOrderLinesInner"), exports);
|
|
37
41
|
__exportStar(require("./CreateOrderRequestShippingAddress"), exports);
|
|
@@ -89,6 +93,8 @@ __exportStar(require("./GetBillingUsage200ResponseZippyMessages"), exports);
|
|
|
89
93
|
__exportStar(require("./GetOrder200Response"), exports);
|
|
90
94
|
__exportStar(require("./GetOrder200ResponseShipmentsInner"), exports);
|
|
91
95
|
__exportStar(require("./GetOrder200ResponseShippingRule"), exports);
|
|
96
|
+
__exportStar(require("./GetOrderChannelWebhookStatus200Response"), exports);
|
|
97
|
+
__exportStar(require("./GetOrderChannelWebhookStatus200ResponseWebhooksInner"), exports);
|
|
92
98
|
__exportStar(require("./GetOrg200Response"), exports);
|
|
93
99
|
__exportStar(require("./GetOrg200ResponseCount"), exports);
|
|
94
100
|
__exportStar(require("./GetOrgBranding200Response"), exports);
|
|
@@ -112,6 +118,10 @@ __exportStar(require("./ListCarrierProducts200ResponseInnerWeightLimits"), expor
|
|
|
112
118
|
__exportStar(require("./ListCarriers200Response"), exports);
|
|
113
119
|
__exportStar(require("./ListCarriers200ResponseDataInner"), exports);
|
|
114
120
|
__exportStar(require("./ListCarriers200ResponseDataInnerConfigValue"), exports);
|
|
121
|
+
__exportStar(require("./ListOrderChannels200Response"), exports);
|
|
122
|
+
__exportStar(require("./ListOrderChannels200ResponseDataInner"), exports);
|
|
123
|
+
__exportStar(require("./ListOrderChannels200ResponseDataInnerSettings"), exports);
|
|
124
|
+
__exportStar(require("./ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner"), exports);
|
|
115
125
|
__exportStar(require("./ListOrders200Response"), exports);
|
|
116
126
|
__exportStar(require("./ListOrders200ResponseDataInner"), exports);
|
|
117
127
|
__exportStar(require("./ListOrders200ResponseDataInnerOrderChannel"), exports);
|
|
@@ -140,6 +150,7 @@ __exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInnerOneO
|
|
|
140
150
|
__exportStar(require("./ListShippingRules200ResponseDataInnerLabelPrinter"), exports);
|
|
141
151
|
__exportStar(require("./ListShippingRules200ResponseDataInnerReturnShippingRule"), exports);
|
|
142
152
|
__exportStar(require("./RevokeApiToken200Response"), exports);
|
|
153
|
+
__exportStar(require("./RevokeOrderChannelWebhookSecret200Response"), exports);
|
|
143
154
|
__exportStar(require("./SendShipment422Response"), exports);
|
|
144
155
|
__exportStar(require("./SendShipment422ResponseErrorsInner"), exports);
|
|
145
156
|
__exportStar(require("./SplitShipment201Response"), exports);
|
|
@@ -153,6 +164,8 @@ __exportStar(require("./TrackShipment200ResponseEventsInner"), exports);
|
|
|
153
164
|
__exportStar(require("./UpdateAddressRequest"), exports);
|
|
154
165
|
__exportStar(require("./UpdateApiTokenRequest"), exports);
|
|
155
166
|
__exportStar(require("./UpdateCarrierRequest"), exports);
|
|
167
|
+
__exportStar(require("./UpdateOrderChannelRequest"), exports);
|
|
168
|
+
__exportStar(require("./UpdateOrderChannelRequestSettings"), exports);
|
|
156
169
|
__exportStar(require("./UpdateOrderRequest"), exports);
|
|
157
170
|
__exportStar(require("./UpdateOrg200Response"), exports);
|
|
158
171
|
__exportStar(require("./UpdateOrgBrandRequest"), exports);
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateOrderChannelRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`type` | string
|
|
11
|
+
`brandId` | string
|
|
12
|
+
`enabled` | boolean
|
|
13
|
+
`settings` | [CreateOrderChannelRequestSettings](CreateOrderChannelRequestSettings.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { CreateOrderChannelRequest } from '@zippendo/sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"name": Anna's webshop,
|
|
23
|
+
"type": custom,
|
|
24
|
+
"brandId": brnd_8f3kd92ld0,
|
|
25
|
+
"enabled": true,
|
|
26
|
+
"settings": null,
|
|
27
|
+
} satisfies CreateOrderChannelRequest
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateOrderChannelRequest
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateOrderChannelRequestSettings
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`useWebhooks` | boolean
|
|
10
|
+
`siteUrl` | string
|
|
11
|
+
`autoFulfill` | boolean
|
|
12
|
+
`autoSync` | boolean
|
|
13
|
+
`syncIntervalMinutes` | number
|
|
14
|
+
`autoShipOnCreate` | boolean
|
|
15
|
+
`defaultCarrierId` | string
|
|
16
|
+
`defaultProductId` | string
|
|
17
|
+
`defaultAddressId` | string
|
|
18
|
+
`shippingMethodMappings` | [Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>](CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md)
|
|
19
|
+
`syncOnlyUnfulfilled` | boolean
|
|
20
|
+
`syncOrdersSince` | Date
|
|
21
|
+
`servicePointCount` | number
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import type { CreateOrderChannelRequestSettings } from '@zippendo/sdk'
|
|
27
|
+
|
|
28
|
+
// TODO: Update the object below with actual values
|
|
29
|
+
const example = {
|
|
30
|
+
"useWebhooks": true,
|
|
31
|
+
"siteUrl": https://butik.dk,
|
|
32
|
+
"autoFulfill": true,
|
|
33
|
+
"autoSync": false,
|
|
34
|
+
"syncIntervalMinutes": 15,
|
|
35
|
+
"autoShipOnCreate": false,
|
|
36
|
+
"defaultCarrierId": clz9k2f0a0006abcd1357yzab,
|
|
37
|
+
"defaultProductId": postnord-home-delivery,
|
|
38
|
+
"defaultAddressId": clz9k2f0a0005abcd7890uvwx,
|
|
39
|
+
"shippingMethodMappings": [{"match":"GLS Hjemmelevering","shippingRuleId":"clz9k2f0a0007abcd2468qrst"}],
|
|
40
|
+
"syncOnlyUnfulfilled": true,
|
|
41
|
+
"syncOrdersSince": 2026-05-22T00:00Z,
|
|
42
|
+
"servicePointCount": 6,
|
|
43
|
+
} satisfies CreateOrderChannelRequestSettings
|
|
44
|
+
|
|
45
|
+
console.log(example)
|
|
46
|
+
|
|
47
|
+
// Convert the instance to a JSON string
|
|
48
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
49
|
+
console.log(exampleJSON)
|
|
50
|
+
|
|
51
|
+
// Parse the JSON string back to an object
|
|
52
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateOrderChannelRequestSettings
|
|
53
|
+
console.log(exampleParsed)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
57
|
+
|
|
58
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateOrderChannelRequestSettingsShippingMethodMappingsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`match` | string
|
|
10
|
+
`shippingRuleId` | string
|
|
11
|
+
`servicePointSelection` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { CreateOrderChannelRequestSettingsShippingMethodMappingsInner } from '@zippendo/sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"match": GLS Hjemmelevering,
|
|
21
|
+
"shippingRuleId": clz9k2f0a0007abcd2468qrst,
|
|
22
|
+
"servicePointSelection": nearest,
|
|
23
|
+
} satisfies CreateOrderChannelRequestSettingsShippingMethodMappingsInner
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateOrderChannelRequestSettingsShippingMethodMappingsInner
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateOrderChannelWebhookSecret201Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`secret` | string
|
|
10
|
+
`webhookUrl` | string
|
|
11
|
+
`createdAt` | Date
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { CreateOrderChannelWebhookSecret201Response } from '@zippendo/sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"secret": zwhs_XeVJ1n8vJZbJ0N3mYQ2fV0dK9cA5tR7uW4pL6sH8gB0,
|
|
21
|
+
"webhookUrl": https://api.zippendo.com/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
22
|
+
"createdAt": 2026-09-02T14:30Z,
|
|
23
|
+
} satisfies CreateOrderChannelWebhookSecret201Response
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateOrderChannelWebhookSecret201Response
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -17,6 +17,8 @@ Name | Type
|
|
|
17
17
|
`totalAmount` | number
|
|
18
18
|
`currency` | string
|
|
19
19
|
`notes` | string
|
|
20
|
+
`shippingRuleId` | string
|
|
21
|
+
`shippingMethodTitle` | string
|
|
20
22
|
`externalData` | { [key: string]: any; }
|
|
21
23
|
|
|
22
24
|
## Example
|
|
@@ -37,6 +39,8 @@ const example = {
|
|
|
37
39
|
"totalAmount": 1047,
|
|
38
40
|
"currency": DKK,
|
|
39
41
|
"notes": Leave at front desk,
|
|
42
|
+
"shippingRuleId": clz9k2f0a0007abcd2468qrst,
|
|
43
|
+
"shippingMethodTitle": GLS Hjemmelevering,
|
|
40
44
|
"externalData": null,
|
|
41
45
|
} satisfies CreateOrderRequest
|
|
42
46
|
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# GetOrderChannelWebhookStatus200Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`enabled` | boolean
|
|
10
|
+
`webhookUrl` | string
|
|
11
|
+
`webhooks` | [Array<GetOrderChannelWebhookStatus200ResponseWebhooksInner>](GetOrderChannelWebhookStatus200ResponseWebhooksInner.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { GetOrderChannelWebhookStatus200Response } from '@zippendo/sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"enabled": true,
|
|
21
|
+
"webhookUrl": https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
22
|
+
"webhooks": null,
|
|
23
|
+
} satisfies GetOrderChannelWebhookStatus200Response
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetOrderChannelWebhookStatus200Response
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# GetOrderChannelWebhookStatus200ResponseWebhooksInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`topic` | string
|
|
11
|
+
`address` | string
|
|
12
|
+
`createdAt` | string
|
|
13
|
+
`deliveryUrl` | string
|
|
14
|
+
`status` | string
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { GetOrderChannelWebhookStatus200ResponseWebhooksInner } from '@zippendo/sdk'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"id": 1234567890,
|
|
24
|
+
"topic": ORDERS_CREATE,
|
|
25
|
+
"address": https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
26
|
+
"createdAt": 2026-06-22T14:30:00.000Z,
|
|
27
|
+
"deliveryUrl": https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
28
|
+
"status": active,
|
|
29
|
+
} satisfies GetOrderChannelWebhookStatus200ResponseWebhooksInner
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetOrderChannelWebhookStatus200ResponseWebhooksInner
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# ListOrderChannels200Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ListOrderChannels200ResponseDataInner>](ListOrderChannels200ResponseDataInner.md)
|
|
10
|
+
`total` | number
|
|
11
|
+
`page` | number
|
|
12
|
+
`limit` | number
|
|
13
|
+
`totalPages` | number
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ListOrderChannels200Response } from '@zippendo/sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"data": null,
|
|
23
|
+
"total": 137,
|
|
24
|
+
"page": 1,
|
|
25
|
+
"limit": 20,
|
|
26
|
+
"totalPages": 7,
|
|
27
|
+
} satisfies ListOrderChannels200Response
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListOrderChannels200Response
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
|
|
2
|
+
# ListOrderChannels200ResponseDataInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`name` | string
|
|
11
|
+
`type` | string
|
|
12
|
+
`enabled` | boolean
|
|
13
|
+
`brandId` | string
|
|
14
|
+
`hasCredentials` | boolean
|
|
15
|
+
`settings` | [ListOrderChannels200ResponseDataInnerSettings](ListOrderChannels200ResponseDataInnerSettings.md)
|
|
16
|
+
`webhooksEnabled` | boolean
|
|
17
|
+
`lastSyncAt` | Date
|
|
18
|
+
`lastSyncError` | string
|
|
19
|
+
`shippingRuleIds` | Array<string>
|
|
20
|
+
`orgId` | string
|
|
21
|
+
`createdAt` | string
|
|
22
|
+
`updatedAt` | string
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import type { ListOrderChannels200ResponseDataInner } from '@zippendo/sdk'
|
|
28
|
+
|
|
29
|
+
// TODO: Update the object below with actual values
|
|
30
|
+
const example = {
|
|
31
|
+
"id": clz9k2f0a0001abcd1234efgh,
|
|
32
|
+
"name": Anna's Shopify Store,
|
|
33
|
+
"type": shopify,
|
|
34
|
+
"enabled": true,
|
|
35
|
+
"brandId": brnd_8f3kd92ld0,
|
|
36
|
+
"hasCredentials": true,
|
|
37
|
+
"settings": null,
|
|
38
|
+
"webhooksEnabled": true,
|
|
39
|
+
"lastSyncAt": 2026-06-22T14:30Z,
|
|
40
|
+
"lastSyncError": Invalid API credentials,
|
|
41
|
+
"shippingRuleIds": ["clz9k2f0a0002abcd5678ijkl"],
|
|
42
|
+
"orgId": clz9k2f0a0000abcd0000zzzz,
|
|
43
|
+
"createdAt": 2026-06-22T14:30:00.000Z,
|
|
44
|
+
"updatedAt": 2026-06-22T14:30:00.000Z,
|
|
45
|
+
} satisfies ListOrderChannels200ResponseDataInner
|
|
46
|
+
|
|
47
|
+
console.log(example)
|
|
48
|
+
|
|
49
|
+
// Convert the instance to a JSON string
|
|
50
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
51
|
+
console.log(exampleJSON)
|
|
52
|
+
|
|
53
|
+
// Parse the JSON string back to an object
|
|
54
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListOrderChannels200ResponseDataInner
|
|
55
|
+
console.log(exampleParsed)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
59
|
+
|
|
60
|
+
|