@zippendo/sdk 1.2.5 → 1.2.7
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/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -0
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +4 -0
- package/dist/esm/models/GetOrder200Response.d.ts +4 -4
- package/dist/esm/models/GetOrder200Response.js +3 -3
- package/dist/esm/models/GetOrder200ResponseOrderLinesInner.d.ts +156 -0
- package/dist/esm/models/GetOrder200ResponseOrderLinesInner.js +94 -0
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts +7 -0
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.js +5 -0
- package/dist/esm/models/GetOrder200ResponseShipmentsInnerParcelsInner.d.ts +68 -0
- package/dist/esm/models/GetOrder200ResponseShipmentsInnerParcelsInner.js +70 -0
- package/dist/esm/models/GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.d.ts +50 -0
- package/dist/esm/models/GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.js +51 -0
- package/dist/esm/models/ListApiTokens401Response.d.ts +4 -0
- package/dist/esm/models/ListApiTokens401Response.js +4 -0
- package/dist/esm/models/SendShipment422Response.d.ts +4 -0
- package/dist/esm/models/SendShipment422Response.js +4 -0
- package/dist/esm/models/UpdateOrderRequest.d.ts +6 -0
- package/dist/esm/models/UpdateOrderRequest.js +2 -0
- package/dist/esm/models/UpdateOrgRequest.d.ts +0 -6
- package/dist/esm/models/UpdateOrgRequest.js +0 -2
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +4 -0
- package/dist/models/GetOrder200Response.d.ts +4 -4
- package/dist/models/GetOrder200Response.js +3 -3
- package/dist/models/GetOrder200ResponseOrderLinesInner.d.ts +156 -0
- package/dist/models/GetOrder200ResponseOrderLinesInner.js +102 -0
- package/dist/models/GetOrder200ResponseShipmentsInner.d.ts +7 -0
- package/dist/models/GetOrder200ResponseShipmentsInner.js +5 -0
- package/dist/models/GetOrder200ResponseShipmentsInnerParcelsInner.d.ts +68 -0
- package/dist/models/GetOrder200ResponseShipmentsInnerParcelsInner.js +78 -0
- package/dist/models/GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.d.ts +50 -0
- package/dist/models/GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.js +58 -0
- package/dist/models/ListApiTokens401Response.d.ts +4 -0
- package/dist/models/ListApiTokens401Response.js +4 -0
- package/dist/models/SendShipment422Response.d.ts +4 -0
- package/dist/models/SendShipment422Response.js +4 -0
- package/dist/models/UpdateOrderRequest.d.ts +6 -0
- package/dist/models/UpdateOrderRequest.js +2 -0
- package/dist/models/UpdateOrgRequest.d.ts +0 -6
- package/dist/models/UpdateOrgRequest.js +0 -2
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/GetOrder200Response.md +1 -1
- package/docs/GetOrder200ResponseOrderLinesInner.md +72 -0
- package/docs/GetOrder200ResponseShipmentsInner.md +2 -0
- package/docs/GetOrder200ResponseShipmentsInnerParcelsInner.md +42 -0
- package/docs/GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.md +40 -0
- package/docs/UpdateOrderRequest.md +2 -0
- package/docs/UpdateOrgRequest.md +0 -2
- package/package.json +1 -1
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +4 -0
- package/src/models/GetOrder200Response.ts +12 -12
- package/src/models/GetOrder200ResponseOrderLinesInner.ts +233 -0
- package/src/models/GetOrder200ResponseShipmentsInner.ts +16 -0
- package/src/models/GetOrder200ResponseShipmentsInnerParcelsInner.ts +130 -0
- package/src/models/GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.ts +91 -0
- package/src/models/ListApiTokens401Response.ts +4 -0
- package/src/models/SendShipment422Response.ts +4 -0
- package/src/models/UpdateOrderRequest.ts +8 -0
- package/src/models/UpdateOrgRequest.ts +0 -8
- package/src/models/index.ts +3 -0
|
@@ -0,0 +1,68 @@
|
|
|
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 { GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner } from './GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner';
|
|
13
|
+
import type { CreateShipment201ResponseParcelsInnerDimensions } from './CreateShipment201ResponseParcelsInnerDimensions';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface GetOrder200ResponseShipmentsInnerParcelsInner
|
|
18
|
+
*/
|
|
19
|
+
export interface GetOrder200ResponseShipmentsInnerParcelsInner {
|
|
20
|
+
/**
|
|
21
|
+
* Parcel ID.
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInner
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
* Parcel weight in the given unit.
|
|
28
|
+
* @type {number}
|
|
29
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInner
|
|
30
|
+
*/
|
|
31
|
+
weight: number;
|
|
32
|
+
/**
|
|
33
|
+
* Unit of measurement for parcel weight.
|
|
34
|
+
* @type {GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum}
|
|
35
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInner
|
|
36
|
+
*/
|
|
37
|
+
weightUnit: GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {CreateShipment201ResponseParcelsInnerDimensions}
|
|
41
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInner
|
|
42
|
+
*/
|
|
43
|
+
dimensions: CreateShipment201ResponseParcelsInnerDimensions;
|
|
44
|
+
/**
|
|
45
|
+
* Contents of this parcel.
|
|
46
|
+
* @type {Array<GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner>}
|
|
47
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInner
|
|
48
|
+
*/
|
|
49
|
+
orderLines: Array<GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner>;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* @export
|
|
53
|
+
*/
|
|
54
|
+
export declare const GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum: {
|
|
55
|
+
readonly Kg: "kg";
|
|
56
|
+
readonly G: "g";
|
|
57
|
+
readonly Lb: "lb";
|
|
58
|
+
readonly Oz: "oz";
|
|
59
|
+
};
|
|
60
|
+
export type GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum = typeof GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum[keyof typeof GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum];
|
|
61
|
+
/**
|
|
62
|
+
* Check if a given object implements the GetOrder200ResponseShipmentsInnerParcelsInner interface.
|
|
63
|
+
*/
|
|
64
|
+
export declare function instanceOfGetOrder200ResponseShipmentsInnerParcelsInner(value: object): value is GetOrder200ResponseShipmentsInnerParcelsInner;
|
|
65
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON(json: any): GetOrder200ResponseShipmentsInnerParcelsInner;
|
|
66
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrder200ResponseShipmentsInnerParcelsInner;
|
|
67
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerToJSON(json: any): GetOrder200ResponseShipmentsInnerParcelsInner;
|
|
68
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerToJSONTyped(value?: GetOrder200ResponseShipmentsInnerParcelsInner | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,78 @@
|
|
|
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.GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum = void 0;
|
|
17
|
+
exports.instanceOfGetOrder200ResponseShipmentsInnerParcelsInner = instanceOfGetOrder200ResponseShipmentsInnerParcelsInner;
|
|
18
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON = GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON;
|
|
19
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerFromJSONTyped = GetOrder200ResponseShipmentsInnerParcelsInnerFromJSONTyped;
|
|
20
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerToJSON = GetOrder200ResponseShipmentsInnerParcelsInnerToJSON;
|
|
21
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerToJSONTyped = GetOrder200ResponseShipmentsInnerParcelsInnerToJSONTyped;
|
|
22
|
+
const GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner_1 = require("./GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner");
|
|
23
|
+
const CreateShipment201ResponseParcelsInnerDimensions_1 = require("./CreateShipment201ResponseParcelsInnerDimensions");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerWeightUnitEnum = {
|
|
28
|
+
Kg: 'kg',
|
|
29
|
+
G: 'g',
|
|
30
|
+
Lb: 'lb',
|
|
31
|
+
Oz: 'oz'
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the GetOrder200ResponseShipmentsInnerParcelsInner interface.
|
|
35
|
+
*/
|
|
36
|
+
function instanceOfGetOrder200ResponseShipmentsInnerParcelsInner(value) {
|
|
37
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('weight' in value) || value['weight'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('weightUnit' in value) || value['weightUnit'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('dimensions' in value) || value['dimensions'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('orderLines' in value) || value['orderLines'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
return true;
|
|
48
|
+
}
|
|
49
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerFromJSON(json) {
|
|
50
|
+
return GetOrder200ResponseShipmentsInnerParcelsInnerFromJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
53
|
+
if (json == null) {
|
|
54
|
+
return json;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'id': json['id'],
|
|
58
|
+
'weight': json['weight'],
|
|
59
|
+
'weightUnit': json['weightUnit'],
|
|
60
|
+
'dimensions': (0, CreateShipment201ResponseParcelsInnerDimensions_1.CreateShipment201ResponseParcelsInnerDimensionsFromJSON)(json['dimensions']),
|
|
61
|
+
'orderLines': (json['orderLines'].map(GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner_1.GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSON)),
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerToJSON(json) {
|
|
65
|
+
return GetOrder200ResponseShipmentsInnerParcelsInnerToJSONTyped(json, false);
|
|
66
|
+
}
|
|
67
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
68
|
+
if (value == null) {
|
|
69
|
+
return value;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
'id': value['id'],
|
|
73
|
+
'weight': value['weight'],
|
|
74
|
+
'weightUnit': value['weightUnit'],
|
|
75
|
+
'dimensions': (0, CreateShipment201ResponseParcelsInnerDimensions_1.CreateShipment201ResponseParcelsInnerDimensionsToJSON)(value['dimensions']),
|
|
76
|
+
'orderLines': (value['orderLines'].map(GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner_1.GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSON)),
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
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
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
16
|
+
*/
|
|
17
|
+
export interface GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner {
|
|
18
|
+
/**
|
|
19
|
+
* Parcel content line ID.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* SKU of the packed item.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
28
|
+
*/
|
|
29
|
+
sku?: string | null;
|
|
30
|
+
/**
|
|
31
|
+
* Quantity packed in this parcel.
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
34
|
+
*/
|
|
35
|
+
quantity: number;
|
|
36
|
+
/**
|
|
37
|
+
* Product description.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
40
|
+
*/
|
|
41
|
+
description?: string | null;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner interface.
|
|
45
|
+
*/
|
|
46
|
+
export declare function instanceOfGetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner(value: object): value is GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner;
|
|
47
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSON(json: any): GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner;
|
|
48
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner;
|
|
49
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSON(json: any): GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner;
|
|
50
|
+
export declare function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSONTyped(value?: GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,58 @@
|
|
|
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.instanceOfGetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner = instanceOfGetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner;
|
|
17
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSON = GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSON;
|
|
18
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSONTyped = GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSONTyped;
|
|
19
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSON = GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSON;
|
|
20
|
+
exports.GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSONTyped = GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfGetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner(value) {
|
|
25
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('quantity' in value) || value['quantity'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSON(json) {
|
|
32
|
+
return GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'id': json['id'],
|
|
40
|
+
'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
|
|
41
|
+
'quantity': json['quantity'],
|
|
42
|
+
'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSON(json) {
|
|
46
|
+
return GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
function GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInnerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'id': value['id'],
|
|
54
|
+
'sku': value['sku'],
|
|
55
|
+
'quantity': value['quantity'],
|
|
56
|
+
'description': value['description'],
|
|
57
|
+
};
|
|
58
|
+
}
|
|
@@ -61,6 +61,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
|
|
|
61
61
|
readonly AuthMfaRequired: "AUTH_MFA_REQUIRED";
|
|
62
62
|
readonly AuthMfaInvalidCode: "AUTH_MFA_INVALID_CODE";
|
|
63
63
|
readonly AuthMfaAlreadyEnabled: "AUTH_MFA_ALREADY_ENABLED";
|
|
64
|
+
readonly CaptchaFailed: "CAPTCHA_FAILED";
|
|
65
|
+
readonly EmailDomainBlocked: "EMAIL_DOMAIN_BLOCKED";
|
|
66
|
+
readonly VatInvalid: "VAT_INVALID";
|
|
64
67
|
readonly AuthMfaNotEnabled: "AUTH_MFA_NOT_ENABLED";
|
|
65
68
|
readonly SessionRequired: "SESSION_REQUIRED";
|
|
66
69
|
readonly OrgNotFound: "ORG_NOT_FOUND";
|
|
@@ -113,6 +116,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
|
|
|
113
116
|
readonly CarrierAuthFailed: "CARRIER_AUTH_FAILED";
|
|
114
117
|
readonly CarrierNotFound: "CARRIER_NOT_FOUND";
|
|
115
118
|
readonly CarrierProductNotFound: "CARRIER_PRODUCT_NOT_FOUND";
|
|
119
|
+
readonly CarrierProductRouteUnsupported: "CARRIER_PRODUCT_ROUTE_UNSUPPORTED";
|
|
116
120
|
readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
|
|
117
121
|
readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
|
|
118
122
|
readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
|
|
@@ -46,6 +46,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
|
|
|
46
46
|
AuthMfaRequired: 'AUTH_MFA_REQUIRED',
|
|
47
47
|
AuthMfaInvalidCode: 'AUTH_MFA_INVALID_CODE',
|
|
48
48
|
AuthMfaAlreadyEnabled: 'AUTH_MFA_ALREADY_ENABLED',
|
|
49
|
+
CaptchaFailed: 'CAPTCHA_FAILED',
|
|
50
|
+
EmailDomainBlocked: 'EMAIL_DOMAIN_BLOCKED',
|
|
51
|
+
VatInvalid: 'VAT_INVALID',
|
|
49
52
|
AuthMfaNotEnabled: 'AUTH_MFA_NOT_ENABLED',
|
|
50
53
|
SessionRequired: 'SESSION_REQUIRED',
|
|
51
54
|
OrgNotFound: 'ORG_NOT_FOUND',
|
|
@@ -98,6 +101,7 @@ exports.ListApiTokens401ResponseCodeEnum = {
|
|
|
98
101
|
CarrierAuthFailed: 'CARRIER_AUTH_FAILED',
|
|
99
102
|
CarrierNotFound: 'CARRIER_NOT_FOUND',
|
|
100
103
|
CarrierProductNotFound: 'CARRIER_PRODUCT_NOT_FOUND',
|
|
104
|
+
CarrierProductRouteUnsupported: 'CARRIER_PRODUCT_ROUTE_UNSUPPORTED',
|
|
101
105
|
CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
|
|
102
106
|
CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
|
|
103
107
|
CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
|
|
@@ -68,6 +68,9 @@ export declare const SendShipment422ResponseCodeEnum: {
|
|
|
68
68
|
readonly AuthMfaRequired: "AUTH_MFA_REQUIRED";
|
|
69
69
|
readonly AuthMfaInvalidCode: "AUTH_MFA_INVALID_CODE";
|
|
70
70
|
readonly AuthMfaAlreadyEnabled: "AUTH_MFA_ALREADY_ENABLED";
|
|
71
|
+
readonly CaptchaFailed: "CAPTCHA_FAILED";
|
|
72
|
+
readonly EmailDomainBlocked: "EMAIL_DOMAIN_BLOCKED";
|
|
73
|
+
readonly VatInvalid: "VAT_INVALID";
|
|
71
74
|
readonly AuthMfaNotEnabled: "AUTH_MFA_NOT_ENABLED";
|
|
72
75
|
readonly SessionRequired: "SESSION_REQUIRED";
|
|
73
76
|
readonly OrgNotFound: "ORG_NOT_FOUND";
|
|
@@ -120,6 +123,7 @@ export declare const SendShipment422ResponseCodeEnum: {
|
|
|
120
123
|
readonly CarrierAuthFailed: "CARRIER_AUTH_FAILED";
|
|
121
124
|
readonly CarrierNotFound: "CARRIER_NOT_FOUND";
|
|
122
125
|
readonly CarrierProductNotFound: "CARRIER_PRODUCT_NOT_FOUND";
|
|
126
|
+
readonly CarrierProductRouteUnsupported: "CARRIER_PRODUCT_ROUTE_UNSUPPORTED";
|
|
123
127
|
readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
|
|
124
128
|
readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
|
|
125
129
|
readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
|
|
@@ -47,6 +47,9 @@ exports.SendShipment422ResponseCodeEnum = {
|
|
|
47
47
|
AuthMfaRequired: 'AUTH_MFA_REQUIRED',
|
|
48
48
|
AuthMfaInvalidCode: 'AUTH_MFA_INVALID_CODE',
|
|
49
49
|
AuthMfaAlreadyEnabled: 'AUTH_MFA_ALREADY_ENABLED',
|
|
50
|
+
CaptchaFailed: 'CAPTCHA_FAILED',
|
|
51
|
+
EmailDomainBlocked: 'EMAIL_DOMAIN_BLOCKED',
|
|
52
|
+
VatInvalid: 'VAT_INVALID',
|
|
50
53
|
AuthMfaNotEnabled: 'AUTH_MFA_NOT_ENABLED',
|
|
51
54
|
SessionRequired: 'SESSION_REQUIRED',
|
|
52
55
|
OrgNotFound: 'ORG_NOT_FOUND',
|
|
@@ -99,6 +102,7 @@ exports.SendShipment422ResponseCodeEnum = {
|
|
|
99
102
|
CarrierAuthFailed: 'CARRIER_AUTH_FAILED',
|
|
100
103
|
CarrierNotFound: 'CARRIER_NOT_FOUND',
|
|
101
104
|
CarrierProductNotFound: 'CARRIER_PRODUCT_NOT_FOUND',
|
|
105
|
+
CarrierProductRouteUnsupported: 'CARRIER_PRODUCT_ROUTE_UNSUPPORTED',
|
|
102
106
|
CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
|
|
103
107
|
CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
|
|
104
108
|
CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
|
|
@@ -83,6 +83,12 @@ export interface UpdateOrderRequest {
|
|
|
83
83
|
* @memberof UpdateOrderRequest
|
|
84
84
|
*/
|
|
85
85
|
shippingRuleId?: string | null;
|
|
86
|
+
/**
|
|
87
|
+
* Service point (parcel shop) ID to apply to unsent outbound shipments.
|
|
88
|
+
* @type {string}
|
|
89
|
+
* @memberof UpdateOrderRequest
|
|
90
|
+
*/
|
|
91
|
+
servicePointId?: string | null;
|
|
86
92
|
}
|
|
87
93
|
/**
|
|
88
94
|
* @export
|
|
@@ -57,6 +57,7 @@ function UpdateOrderRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
57
57
|
'notes': json['notes'] === undefined ? undefined : json['notes'] === null ? null : json['notes'],
|
|
58
58
|
'status': json['status'] == null ? undefined : json['status'],
|
|
59
59
|
'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
|
|
60
|
+
'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
|
|
60
61
|
};
|
|
61
62
|
}
|
|
62
63
|
function UpdateOrderRequestToJSON(json) {
|
|
@@ -78,5 +79,6 @@ function UpdateOrderRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
78
79
|
'notes': value['notes'],
|
|
79
80
|
'status': value['status'],
|
|
80
81
|
'shippingRuleId': value['shippingRuleId'],
|
|
82
|
+
'servicePointId': value['servicePointId'],
|
|
81
83
|
};
|
|
82
84
|
}
|
|
@@ -45,12 +45,6 @@ export interface UpdateOrgRequest {
|
|
|
45
45
|
* @memberof UpdateOrgRequest
|
|
46
46
|
*/
|
|
47
47
|
vatNumber?: string | null;
|
|
48
|
-
/**
|
|
49
|
-
* Allow shipments beyond plan limit (overage charges apply)
|
|
50
|
-
* @type {boolean}
|
|
51
|
-
* @memberof UpdateOrgRequest
|
|
52
|
-
*/
|
|
53
|
-
overageEnabled?: boolean;
|
|
54
48
|
/**
|
|
55
49
|
* Billing/contact phone number
|
|
56
50
|
* @type {string}
|
|
@@ -49,7 +49,6 @@ function UpdateOrgRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
49
49
|
'description': json['description'] == null ? undefined : json['description'],
|
|
50
50
|
'currency': json['currency'] == null ? undefined : json['currency'],
|
|
51
51
|
'vatNumber': json['vatNumber'] === undefined ? undefined : json['vatNumber'] === null ? null : json['vatNumber'],
|
|
52
|
-
'overageEnabled': json['overageEnabled'] == null ? undefined : json['overageEnabled'],
|
|
53
52
|
'phone': json['phone'] === undefined ? undefined : json['phone'] === null ? null : json['phone'],
|
|
54
53
|
'billingEmail': json['billingEmail'] === undefined ? undefined : json['billingEmail'] === null ? null : json['billingEmail'],
|
|
55
54
|
'companyName': json['companyName'] === undefined ? undefined : json['companyName'] === null ? null : json['companyName'],
|
|
@@ -74,7 +73,6 @@ function UpdateOrgRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
74
73
|
'description': value['description'],
|
|
75
74
|
'currency': value['currency'],
|
|
76
75
|
'vatNumber': value['vatNumber'],
|
|
77
|
-
'overageEnabled': value['overageEnabled'],
|
|
78
76
|
'phone': value['phone'],
|
|
79
77
|
'billingEmail': value['billingEmail'],
|
|
80
78
|
'companyName': value['companyName'],
|
package/dist/models/index.d.ts
CHANGED
|
@@ -73,7 +73,10 @@ export * from './GetBillingUsage200ResponseLimitsTeamMembers';
|
|
|
73
73
|
export * from './GetBillingUsage200ResponseShipments';
|
|
74
74
|
export * from './GetBillingUsage200ResponseZippyMessages';
|
|
75
75
|
export * from './GetOrder200Response';
|
|
76
|
+
export * from './GetOrder200ResponseOrderLinesInner';
|
|
76
77
|
export * from './GetOrder200ResponseShipmentsInner';
|
|
78
|
+
export * from './GetOrder200ResponseShipmentsInnerParcelsInner';
|
|
79
|
+
export * from './GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner';
|
|
77
80
|
export * from './GetOrder200ResponseShippingRule';
|
|
78
81
|
export * from './GetOrderChannelWebhookStatus200Response';
|
|
79
82
|
export * from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';
|
package/dist/models/index.js
CHANGED
|
@@ -91,7 +91,10 @@ __exportStar(require("./GetBillingUsage200ResponseLimitsTeamMembers"), exports);
|
|
|
91
91
|
__exportStar(require("./GetBillingUsage200ResponseShipments"), exports);
|
|
92
92
|
__exportStar(require("./GetBillingUsage200ResponseZippyMessages"), exports);
|
|
93
93
|
__exportStar(require("./GetOrder200Response"), exports);
|
|
94
|
+
__exportStar(require("./GetOrder200ResponseOrderLinesInner"), exports);
|
|
94
95
|
__exportStar(require("./GetOrder200ResponseShipmentsInner"), exports);
|
|
96
|
+
__exportStar(require("./GetOrder200ResponseShipmentsInnerParcelsInner"), exports);
|
|
97
|
+
__exportStar(require("./GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner"), exports);
|
|
95
98
|
__exportStar(require("./GetOrder200ResponseShippingRule"), exports);
|
|
96
99
|
__exportStar(require("./GetOrderChannelWebhookStatus200Response"), exports);
|
|
97
100
|
__exportStar(require("./GetOrderChannelWebhookStatus200ResponseWebhooksInner"), exports);
|
|
@@ -12,7 +12,7 @@ Name | Type
|
|
|
12
12
|
`customerName` | string
|
|
13
13
|
`customerEmail` | string
|
|
14
14
|
`shippingAddress` | [CreateOrder201ResponseShippingAddress](CreateOrder201ResponseShippingAddress.md)
|
|
15
|
-
`orderLines` | [Array<
|
|
15
|
+
`orderLines` | [Array<GetOrder200ResponseOrderLinesInner>](GetOrder200ResponseOrderLinesInner.md)
|
|
16
16
|
`subtotalAmount` | number
|
|
17
17
|
`totalAmount` | number
|
|
18
18
|
`currency` | string
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
|
|
2
|
+
# GetOrder200ResponseOrderLinesInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`sku` | string
|
|
10
|
+
`name` | string
|
|
11
|
+
`quantity` | number
|
|
12
|
+
`unitPrice` | number
|
|
13
|
+
`totalPrice` | number
|
|
14
|
+
`currency` | string
|
|
15
|
+
`weight` | number
|
|
16
|
+
`weightUnit` | string
|
|
17
|
+
`variantId` | string
|
|
18
|
+
`productId` | string
|
|
19
|
+
`imageUrl` | string
|
|
20
|
+
`hsCode` | string
|
|
21
|
+
`countryOfOrigin` | string
|
|
22
|
+
`provinceOfOrigin` | string
|
|
23
|
+
`barcode` | string
|
|
24
|
+
`requiresShipping` | boolean
|
|
25
|
+
`taxable` | boolean
|
|
26
|
+
`giftCard` | boolean
|
|
27
|
+
`vendor` | string
|
|
28
|
+
`packedQuantity` | number
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import type { GetOrder200ResponseOrderLinesInner } from '@zippendo/sdk'
|
|
34
|
+
|
|
35
|
+
// TODO: Update the object below with actual values
|
|
36
|
+
const example = {
|
|
37
|
+
"sku": SKU-1042-BLK,
|
|
38
|
+
"name": Wool Sweater,
|
|
39
|
+
"quantity": 2,
|
|
40
|
+
"unitPrice": 499,
|
|
41
|
+
"totalPrice": 998,
|
|
42
|
+
"currency": DKK,
|
|
43
|
+
"weight": 0.5,
|
|
44
|
+
"weightUnit": kg,
|
|
45
|
+
"variantId": 44218900291,
|
|
46
|
+
"productId": 8123456789,
|
|
47
|
+
"imageUrl": https://cdn.example.dk/products/sweater.jpg,
|
|
48
|
+
"hsCode": 611020,
|
|
49
|
+
"countryOfOrigin": DK,
|
|
50
|
+
"provinceOfOrigin": DK-84,
|
|
51
|
+
"barcode": 5712345678901,
|
|
52
|
+
"requiresShipping": true,
|
|
53
|
+
"taxable": true,
|
|
54
|
+
"giftCard": false,
|
|
55
|
+
"vendor": Norse Knits,
|
|
56
|
+
"packedQuantity": 1,
|
|
57
|
+
} satisfies GetOrder200ResponseOrderLinesInner
|
|
58
|
+
|
|
59
|
+
console.log(example)
|
|
60
|
+
|
|
61
|
+
// Convert the instance to a JSON string
|
|
62
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
63
|
+
console.log(exampleJSON)
|
|
64
|
+
|
|
65
|
+
// Parse the JSON string back to an object
|
|
66
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetOrder200ResponseOrderLinesInner
|
|
67
|
+
console.log(exampleParsed)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
71
|
+
|
|
72
|
+
|
|
@@ -17,6 +17,7 @@ Name | Type
|
|
|
17
17
|
`updatedAt` | string
|
|
18
18
|
`shippingRuleId` | string
|
|
19
19
|
`documents` | [Array<CreateShipment201ResponseDocumentsInner>](CreateShipment201ResponseDocumentsInner.md)
|
|
20
|
+
`parcels` | [Array<GetOrder200ResponseShipmentsInnerParcelsInner>](GetOrder200ResponseShipmentsInnerParcelsInner.md)
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -36,6 +37,7 @@ const example = {
|
|
|
36
37
|
"updatedAt": 2026-06-22T14:30:00.000Z,
|
|
37
38
|
"shippingRuleId": clz9k2f0a0002abcd5678ijkl,
|
|
38
39
|
"documents": null,
|
|
40
|
+
"parcels": null,
|
|
39
41
|
} satisfies GetOrder200ResponseShipmentsInner
|
|
40
42
|
|
|
41
43
|
console.log(example)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# GetOrder200ResponseShipmentsInnerParcelsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`weight` | number
|
|
11
|
+
`weightUnit` | string
|
|
12
|
+
`dimensions` | [CreateShipment201ResponseParcelsInnerDimensions](CreateShipment201ResponseParcelsInnerDimensions.md)
|
|
13
|
+
`orderLines` | [Array<GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner>](GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { GetOrder200ResponseShipmentsInnerParcelsInner } from '@zippendo/sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": prc_5a6b7c8d,
|
|
23
|
+
"weight": 2.5,
|
|
24
|
+
"weightUnit": kg,
|
|
25
|
+
"dimensions": null,
|
|
26
|
+
"orderLines": null,
|
|
27
|
+
} satisfies GetOrder200ResponseShipmentsInnerParcelsInner
|
|
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 GetOrder200ResponseShipmentsInnerParcelsInner
|
|
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,40 @@
|
|
|
1
|
+
|
|
2
|
+
# GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`sku` | string
|
|
11
|
+
`quantity` | number
|
|
12
|
+
`description` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner } from '@zippendo/sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": ol_9c1d2e3f,
|
|
22
|
+
"sku": SKU-1042-BLK,
|
|
23
|
+
"quantity": 2,
|
|
24
|
+
"description": Wool Sweater,
|
|
25
|
+
} satisfies GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetOrder200ResponseShipmentsInnerParcelsInnerOrderLinesInner
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -17,6 +17,7 @@ Name | Type
|
|
|
17
17
|
`notes` | string
|
|
18
18
|
`status` | string
|
|
19
19
|
`shippingRuleId` | string
|
|
20
|
+
`servicePointId` | string
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -36,6 +37,7 @@ const example = {
|
|
|
36
37
|
"notes": Leave at front desk,
|
|
37
38
|
"status": processing,
|
|
38
39
|
"shippingRuleId": clz9k2f0a0002abcd5678ijkl,
|
|
40
|
+
"servicePointId": SP-1234,
|
|
39
41
|
} satisfies UpdateOrderRequest
|
|
40
42
|
|
|
41
43
|
console.log(example)
|
package/docs/UpdateOrgRequest.md
CHANGED
|
@@ -11,7 +11,6 @@ Name | Type
|
|
|
11
11
|
`description` | string
|
|
12
12
|
`currency` | string
|
|
13
13
|
`vatNumber` | string
|
|
14
|
-
`overageEnabled` | boolean
|
|
15
14
|
`phone` | string
|
|
16
15
|
`billingEmail` | string
|
|
17
16
|
`companyName` | string
|
|
@@ -34,7 +33,6 @@ const example = {
|
|
|
34
33
|
"description": Parcel and freight logistics across the Nordics,
|
|
35
34
|
"currency": DKK,
|
|
36
35
|
"vatNumber": DK12345678,
|
|
37
|
-
"overageEnabled": false,
|
|
38
36
|
"phone": +45 50 47 02 20,
|
|
39
37
|
"billingEmail": billing@nordic-logistics.dk,
|
|
40
38
|
"companyName": Nordic Logistics ApS,
|