@zippendo/sdk 1.1.4 → 1.2.0
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/ShipmentsApi.d.ts +2 -2
- package/dist/apis/ShipmentsApi.js +2 -2
- package/dist/esm/apis/ShipmentsApi.d.ts +2 -2
- package/dist/esm/apis/ShipmentsApi.js +2 -2
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -0
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +1 -0
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +2 -2
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -3
- package/dist/esm/models/CreateShipmentRequest.d.ts +14 -1
- package/dist/esm/models/CreateShipmentRequest.js +6 -3
- package/dist/esm/models/CreateShipmentRequestCarrierSettings.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestDroppoint.d.ts +51 -0
- package/dist/esm/models/CreateShipmentRequestDroppoint.js +54 -0
- package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +2 -2
- package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -3
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts +6 -0
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.js +2 -0
- package/dist/esm/models/ListApiTokens401Response.d.ts +1 -0
- package/dist/esm/models/ListApiTokens401Response.js +1 -0
- package/dist/esm/models/SendShipment422Response.d.ts +1 -0
- package/dist/esm/models/SendShipment422Response.js +1 -0
- package/dist/esm/models/UpdateShipmentRequest.d.ts +10 -3
- package/dist/esm/models/UpdateShipmentRequest.js +6 -3
- package/dist/esm/models/UpdateShipmentRequestCarrierSettings.d.ts +53 -0
- package/dist/esm/models/UpdateShipmentRequestCarrierSettings.js +57 -0
- package/dist/esm/models/UpdateShipmentRequestDroppoint.d.ts +51 -0
- package/dist/esm/models/UpdateShipmentRequestDroppoint.js +54 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +1 -0
- package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +2 -2
- package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -3
- package/dist/models/CreateShipmentRequest.d.ts +14 -1
- package/dist/models/CreateShipmentRequest.js +6 -3
- package/dist/models/CreateShipmentRequestCarrierSettings.d.ts +1 -1
- package/dist/models/CreateShipmentRequestDroppoint.d.ts +51 -0
- package/dist/models/CreateShipmentRequestDroppoint.js +61 -0
- package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +2 -2
- package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -3
- package/dist/models/GetOrder200ResponseShipmentsInner.d.ts +6 -0
- package/dist/models/GetOrder200ResponseShipmentsInner.js +2 -0
- package/dist/models/ListApiTokens401Response.d.ts +1 -0
- package/dist/models/ListApiTokens401Response.js +1 -0
- package/dist/models/SendShipment422Response.d.ts +1 -0
- package/dist/models/SendShipment422Response.js +1 -0
- package/dist/models/UpdateShipmentRequest.d.ts +10 -3
- package/dist/models/UpdateShipmentRequest.js +6 -3
- package/dist/models/UpdateShipmentRequestCarrierSettings.d.ts +53 -0
- package/dist/models/UpdateShipmentRequestCarrierSettings.js +64 -0
- package/dist/models/UpdateShipmentRequestDroppoint.d.ts +51 -0
- package/dist/models/UpdateShipmentRequestDroppoint.js +61 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/CreateShipmentRequest.md +4 -0
- package/docs/CreateShipmentRequestCarrierSettings.md +1 -0
- package/docs/CreateShipmentRequestDroppoint.md +41 -0
- package/docs/GetOrder200ResponseShipmentsInner.md +2 -0
- package/docs/ShipmentsApi.md +1 -1
- package/docs/UpdateShipmentRequest.md +3 -1
- package/docs/UpdateShipmentRequestCarrierSettings.md +40 -0
- package/docs/UpdateShipmentRequestDroppoint.md +41 -0
- package/package.json +1 -1
- package/src/apis/ShipmentsApi.ts +2 -2
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +1 -0
- package/src/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.ts +3 -4
- package/src/models/CreateShipmentRequest.ts +25 -3
- package/src/models/CreateShipmentRequestCarrierSettings.ts +1 -1
- package/src/models/CreateShipmentRequestDroppoint.ts +100 -0
- package/src/models/CreateShipmentRequestParcelsInnerOrderLinesInner.ts +3 -4
- package/src/models/GetOrder200ResponseShipmentsInner.ts +8 -0
- package/src/models/ListApiTokens401Response.ts +1 -0
- package/src/models/SendShipment422Response.ts +1 -0
- package/src/models/UpdateShipmentRequest.ts +25 -10
- package/src/models/UpdateShipmentRequestCarrierSettings.ts +101 -0
- package/src/models/UpdateShipmentRequestDroppoint.ts +100 -0
- package/src/models/index.ts +3 -0
|
@@ -0,0 +1,53 @@
|
|
|
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 { CreateShippingRuleRequestAdditionalParametersValue } from './CreateShippingRuleRequestAdditionalParametersValue';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface UpdateShipmentRequestCarrierSettings
|
|
17
|
+
*/
|
|
18
|
+
export interface UpdateShipmentRequestCarrierSettings {
|
|
19
|
+
/**
|
|
20
|
+
* Identifier of the carrier to use.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof UpdateShipmentRequestCarrierSettings
|
|
23
|
+
*/
|
|
24
|
+
carrierId: string;
|
|
25
|
+
/**
|
|
26
|
+
* Identifier of the carrier product/service.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof UpdateShipmentRequestCarrierSettings
|
|
29
|
+
*/
|
|
30
|
+
productId: string;
|
|
31
|
+
/**
|
|
32
|
+
* Additional service codes requested from the carrier.
|
|
33
|
+
* @type {Array<string>}
|
|
34
|
+
* @memberof UpdateShipmentRequestCarrierSettings
|
|
35
|
+
*/
|
|
36
|
+
services: Array<string>;
|
|
37
|
+
/**
|
|
38
|
+
* Carrier-specific extra parameters as key/value pairs.
|
|
39
|
+
* @type {{ [key: string]: CreateShippingRuleRequestAdditionalParametersValue; }}
|
|
40
|
+
* @memberof UpdateShipmentRequestCarrierSettings
|
|
41
|
+
*/
|
|
42
|
+
additionalParameters: {
|
|
43
|
+
[key: string]: CreateShippingRuleRequestAdditionalParametersValue;
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Check if a given object implements the UpdateShipmentRequestCarrierSettings interface.
|
|
48
|
+
*/
|
|
49
|
+
export declare function instanceOfUpdateShipmentRequestCarrierSettings(value: object): value is UpdateShipmentRequestCarrierSettings;
|
|
50
|
+
export declare function UpdateShipmentRequestCarrierSettingsFromJSON(json: any): UpdateShipmentRequestCarrierSettings;
|
|
51
|
+
export declare function UpdateShipmentRequestCarrierSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestCarrierSettings;
|
|
52
|
+
export declare function UpdateShipmentRequestCarrierSettingsToJSON(json: any): UpdateShipmentRequestCarrierSettings;
|
|
53
|
+
export declare function UpdateShipmentRequestCarrierSettingsToJSONTyped(value?: UpdateShipmentRequestCarrierSettings | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,64 @@
|
|
|
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.instanceOfUpdateShipmentRequestCarrierSettings = instanceOfUpdateShipmentRequestCarrierSettings;
|
|
17
|
+
exports.UpdateShipmentRequestCarrierSettingsFromJSON = UpdateShipmentRequestCarrierSettingsFromJSON;
|
|
18
|
+
exports.UpdateShipmentRequestCarrierSettingsFromJSONTyped = UpdateShipmentRequestCarrierSettingsFromJSONTyped;
|
|
19
|
+
exports.UpdateShipmentRequestCarrierSettingsToJSON = UpdateShipmentRequestCarrierSettingsToJSON;
|
|
20
|
+
exports.UpdateShipmentRequestCarrierSettingsToJSONTyped = UpdateShipmentRequestCarrierSettingsToJSONTyped;
|
|
21
|
+
const runtime_1 = require("../runtime");
|
|
22
|
+
const CreateShippingRuleRequestAdditionalParametersValue_1 = require("./CreateShippingRuleRequestAdditionalParametersValue");
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the UpdateShipmentRequestCarrierSettings interface.
|
|
25
|
+
*/
|
|
26
|
+
function instanceOfUpdateShipmentRequestCarrierSettings(value) {
|
|
27
|
+
if (!('carrierId' in value) || value['carrierId'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('productId' in value) || value['productId'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('services' in value) || value['services'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('additionalParameters' in value) || value['additionalParameters'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function UpdateShipmentRequestCarrierSettingsFromJSON(json) {
|
|
38
|
+
return UpdateShipmentRequestCarrierSettingsFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function UpdateShipmentRequestCarrierSettingsFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'carrierId': json['carrierId'],
|
|
46
|
+
'productId': json['productId'],
|
|
47
|
+
'services': json['services'],
|
|
48
|
+
'additionalParameters': ((0, runtime_1.mapValues)(json['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValue_1.CreateShippingRuleRequestAdditionalParametersValueFromJSON)),
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
function UpdateShipmentRequestCarrierSettingsToJSON(json) {
|
|
52
|
+
return UpdateShipmentRequestCarrierSettingsToJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function UpdateShipmentRequestCarrierSettingsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
55
|
+
if (value == null) {
|
|
56
|
+
return value;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'carrierId': value['carrierId'],
|
|
60
|
+
'productId': value['productId'],
|
|
61
|
+
'services': value['services'],
|
|
62
|
+
'additionalParameters': ((0, runtime_1.mapValues)(value['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValue_1.CreateShippingRuleRequestAdditionalParametersValueToJSON)),
|
|
63
|
+
};
|
|
64
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
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 { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
|
|
13
|
+
/**
|
|
14
|
+
* Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace the stored droppoint).
|
|
15
|
+
* @export
|
|
16
|
+
* @interface UpdateShipmentRequestDroppoint
|
|
17
|
+
*/
|
|
18
|
+
export interface UpdateShipmentRequestDroppoint {
|
|
19
|
+
/**
|
|
20
|
+
* Identifier of the selected service point.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof UpdateShipmentRequestDroppoint
|
|
23
|
+
*/
|
|
24
|
+
id: string;
|
|
25
|
+
/**
|
|
26
|
+
* Display name of the service point.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof UpdateShipmentRequestDroppoint
|
|
29
|
+
*/
|
|
30
|
+
name: string;
|
|
31
|
+
/**
|
|
32
|
+
* Formatted address of the service point.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof UpdateShipmentRequestDroppoint
|
|
35
|
+
*/
|
|
36
|
+
address: string;
|
|
37
|
+
/**
|
|
38
|
+
* Latitude/longitude of the service point.
|
|
39
|
+
* @type {Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>}
|
|
40
|
+
* @memberof UpdateShipmentRequestDroppoint
|
|
41
|
+
*/
|
|
42
|
+
coordinates?: Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the UpdateShipmentRequestDroppoint interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfUpdateShipmentRequestDroppoint(value: object): value is UpdateShipmentRequestDroppoint;
|
|
48
|
+
export declare function UpdateShipmentRequestDroppointFromJSON(json: any): UpdateShipmentRequestDroppoint;
|
|
49
|
+
export declare function UpdateShipmentRequestDroppointFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestDroppoint;
|
|
50
|
+
export declare function UpdateShipmentRequestDroppointToJSON(json: any): UpdateShipmentRequestDroppoint;
|
|
51
|
+
export declare function UpdateShipmentRequestDroppointToJSONTyped(value?: UpdateShipmentRequestDroppoint | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,61 @@
|
|
|
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.instanceOfUpdateShipmentRequestDroppoint = instanceOfUpdateShipmentRequestDroppoint;
|
|
17
|
+
exports.UpdateShipmentRequestDroppointFromJSON = UpdateShipmentRequestDroppointFromJSON;
|
|
18
|
+
exports.UpdateShipmentRequestDroppointFromJSONTyped = UpdateShipmentRequestDroppointFromJSONTyped;
|
|
19
|
+
exports.UpdateShipmentRequestDroppointToJSON = UpdateShipmentRequestDroppointToJSON;
|
|
20
|
+
exports.UpdateShipmentRequestDroppointToJSONTyped = UpdateShipmentRequestDroppointToJSONTyped;
|
|
21
|
+
const ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1 = require("./ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the UpdateShipmentRequestDroppoint interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfUpdateShipmentRequestDroppoint(value) {
|
|
26
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('address' in value) || value['address'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
function UpdateShipmentRequestDroppointFromJSON(json) {
|
|
35
|
+
return UpdateShipmentRequestDroppointFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
function UpdateShipmentRequestDroppointFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
if (json == null) {
|
|
39
|
+
return json;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'id': json['id'],
|
|
43
|
+
'name': json['name'],
|
|
44
|
+
'address': json['address'],
|
|
45
|
+
'coordinates': json['coordinates'] == null ? undefined : (json['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1.ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON)),
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
function UpdateShipmentRequestDroppointToJSON(json) {
|
|
49
|
+
return UpdateShipmentRequestDroppointToJSONTyped(json, false);
|
|
50
|
+
}
|
|
51
|
+
function UpdateShipmentRequestDroppointToJSONTyped(value, ignoreDiscriminator = false) {
|
|
52
|
+
if (value == null) {
|
|
53
|
+
return value;
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
'id': value['id'],
|
|
57
|
+
'name': value['name'],
|
|
58
|
+
'address': value['address'],
|
|
59
|
+
'coordinates': value['coordinates'] == null ? undefined : (value['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1.ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON)),
|
|
60
|
+
};
|
|
61
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -35,6 +35,7 @@ export * from './CreateShipment201ResponseShippingRule';
|
|
|
35
35
|
export * from './CreateShipment201ResponseTracking';
|
|
36
36
|
export * from './CreateShipmentRequest';
|
|
37
37
|
export * from './CreateShipmentRequestCarrierSettings';
|
|
38
|
+
export * from './CreateShipmentRequestDroppoint';
|
|
38
39
|
export * from './CreateShipmentRequestParcelsInner';
|
|
39
40
|
export * from './CreateShipmentRequestParcelsInnerDimensions';
|
|
40
41
|
export * from './CreateShipmentRequestParcelsInnerOrderLinesInner';
|
|
@@ -141,6 +142,8 @@ export * from './UpdateOrgBrandingRequest';
|
|
|
141
142
|
export * from './UpdateOrgRequest';
|
|
142
143
|
export * from './UpdateOrgWebhookRequest';
|
|
143
144
|
export * from './UpdateShipmentRequest';
|
|
145
|
+
export * from './UpdateShipmentRequestCarrierSettings';
|
|
146
|
+
export * from './UpdateShipmentRequestDroppoint';
|
|
144
147
|
export * from './UpdateShippingRuleRequest';
|
|
145
148
|
export * from './VerifyApiToken200Response';
|
|
146
149
|
export * from './VerifyApiTokenRequest';
|
package/dist/models/index.js
CHANGED
|
@@ -53,6 +53,7 @@ __exportStar(require("./CreateShipment201ResponseShippingRule"), exports);
|
|
|
53
53
|
__exportStar(require("./CreateShipment201ResponseTracking"), exports);
|
|
54
54
|
__exportStar(require("./CreateShipmentRequest"), exports);
|
|
55
55
|
__exportStar(require("./CreateShipmentRequestCarrierSettings"), exports);
|
|
56
|
+
__exportStar(require("./CreateShipmentRequestDroppoint"), exports);
|
|
56
57
|
__exportStar(require("./CreateShipmentRequestParcelsInner"), exports);
|
|
57
58
|
__exportStar(require("./CreateShipmentRequestParcelsInnerDimensions"), exports);
|
|
58
59
|
__exportStar(require("./CreateShipmentRequestParcelsInnerOrderLinesInner"), exports);
|
|
@@ -159,6 +160,8 @@ __exportStar(require("./UpdateOrgBrandingRequest"), exports);
|
|
|
159
160
|
__exportStar(require("./UpdateOrgRequest"), exports);
|
|
160
161
|
__exportStar(require("./UpdateOrgWebhookRequest"), exports);
|
|
161
162
|
__exportStar(require("./UpdateShipmentRequest"), exports);
|
|
163
|
+
__exportStar(require("./UpdateShipmentRequestCarrierSettings"), exports);
|
|
164
|
+
__exportStar(require("./UpdateShipmentRequestDroppoint"), exports);
|
|
162
165
|
__exportStar(require("./UpdateShippingRuleRequest"), exports);
|
|
163
166
|
__exportStar(require("./VerifyApiToken200Response"), exports);
|
|
164
167
|
__exportStar(require("./VerifyApiTokenRequest"), exports);
|
|
@@ -19,6 +19,8 @@ Name | Type
|
|
|
19
19
|
`orderId` | string
|
|
20
20
|
`labelPrinterId` | string
|
|
21
21
|
`documentPrinterId` | string
|
|
22
|
+
`shippingRuleId` | string
|
|
23
|
+
`droppoint` | [CreateShipmentRequestDroppoint](CreateShipmentRequestDroppoint.md)
|
|
22
24
|
|
|
23
25
|
## Example
|
|
24
26
|
|
|
@@ -40,6 +42,8 @@ const example = {
|
|
|
40
42
|
"orderId": ord_5e6f7a8b,
|
|
41
43
|
"labelPrinterId": prn_label_01,
|
|
42
44
|
"documentPrinterId": prn_doc_01,
|
|
45
|
+
"shippingRuleId": rule_3c4d5e6f,
|
|
46
|
+
"droppoint": null,
|
|
43
47
|
} satisfies CreateShipmentRequest
|
|
44
48
|
|
|
45
49
|
console.log(example)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateShipmentRequestDroppoint
|
|
3
|
+
|
|
4
|
+
Display details of the selected service point, stored alongside `servicePointId`. Used with a service-point shipping rule.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`address` | string
|
|
13
|
+
`coordinates` | [Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { CreateShipmentRequestDroppoint } from '@zippendo/sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": sp_pn_4521,
|
|
23
|
+
"name": Føtex Nørrebro,
|
|
24
|
+
"address": Nørrebrogade 20, 2200 København N,
|
|
25
|
+
"coordinates": [55.6987,12.5501],
|
|
26
|
+
} satisfies CreateShipmentRequestDroppoint
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateShipmentRequestDroppoint
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`type` | string
|
|
13
13
|
`tracking` | [CreateShipment201ResponseTracking](CreateShipment201ResponseTracking.md)
|
|
14
14
|
`carrierSettings` | [ListShipments200ResponseDataInnerCarrierSettings](ListShipments200ResponseDataInnerCarrierSettings.md)
|
|
15
|
+
`servicePointId` | string
|
|
15
16
|
`createdAt` | string
|
|
16
17
|
`updatedAt` | string
|
|
17
18
|
`shippingRuleId` | string
|
|
@@ -30,6 +31,7 @@ const example = {
|
|
|
30
31
|
"type": outbound,
|
|
31
32
|
"tracking": null,
|
|
32
33
|
"carrierSettings": null,
|
|
34
|
+
"servicePointId": sp_pn_4521,
|
|
33
35
|
"createdAt": 2026-06-22T14:30:00.000Z,
|
|
34
36
|
"updatedAt": 2026-06-22T14:30:00.000Z,
|
|
35
37
|
"shippingRuleId": clz9k2f0a0002abcd5678ijkl,
|
package/docs/ShipmentsApi.md
CHANGED
|
@@ -259,7 +259,7 @@ example().catch(console.error);
|
|
|
259
259
|
|
|
260
260
|
Create shipment
|
|
261
261
|
|
|
262
|
-
Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order.
|
|
262
|
+
Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order. When shippingRuleId is provided, carrier settings and the sender address derive from the rule.
|
|
263
263
|
|
|
264
264
|
### Example
|
|
265
265
|
|
|
@@ -11,7 +11,7 @@ Name | Type
|
|
|
11
11
|
`servicePointId` | string
|
|
12
12
|
`parties` | [Array<CreateShipmentRequestPartiesInner>](CreateShipmentRequestPartiesInner.md)
|
|
13
13
|
`type` | string
|
|
14
|
-
`carrierSettings` | [
|
|
14
|
+
`carrierSettings` | [UpdateShipmentRequestCarrierSettings](UpdateShipmentRequestCarrierSettings.md)
|
|
15
15
|
`parcels` | [Array<CreateShipmentRequestParcelsInner>](CreateShipmentRequestParcelsInner.md)
|
|
16
16
|
`pickupDetails` | [CreateShipmentRequestPickupDetails](CreateShipmentRequestPickupDetails.md)
|
|
17
17
|
`termOfTrade` | string
|
|
@@ -20,6 +20,7 @@ Name | Type
|
|
|
20
20
|
`labelPrinterId` | string
|
|
21
21
|
`documentPrinterId` | string
|
|
22
22
|
`shippingRuleId` | string
|
|
23
|
+
`droppoint` | [UpdateShipmentRequestDroppoint](UpdateShipmentRequestDroppoint.md)
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
@@ -42,6 +43,7 @@ const example = {
|
|
|
42
43
|
"labelPrinterId": prn_label_01,
|
|
43
44
|
"documentPrinterId": prn_doc_01,
|
|
44
45
|
"shippingRuleId": rule_3c4d5e6f,
|
|
46
|
+
"droppoint": null,
|
|
45
47
|
} satisfies UpdateShipmentRequest
|
|
46
48
|
|
|
47
49
|
console.log(example)
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateShipmentRequestCarrierSettings
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`carrierId` | string
|
|
10
|
+
`productId` | string
|
|
11
|
+
`services` | Array<string>
|
|
12
|
+
`additionalParameters` | [{ [key: string]: CreateShippingRuleRequestAdditionalParametersValue; }](CreateShippingRuleRequestAdditionalParametersValue.md)
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { UpdateShipmentRequestCarrierSettings } from '@zippendo/sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"carrierId": car_pn_001,
|
|
22
|
+
"productId": prod_mypack_home,
|
|
23
|
+
"services": ["A7"],
|
|
24
|
+
"additionalParameters": {"notificationEmail":"anna@example.dk"},
|
|
25
|
+
} satisfies UpdateShipmentRequestCarrierSettings
|
|
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 UpdateShipmentRequestCarrierSettings
|
|
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
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateShipmentRequestDroppoint
|
|
3
|
+
|
|
4
|
+
Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace the stored droppoint).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`address` | string
|
|
13
|
+
`coordinates` | [Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>](ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { UpdateShipmentRequestDroppoint } from '@zippendo/sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": sp_pn_4521,
|
|
23
|
+
"name": Føtex Nørrebro,
|
|
24
|
+
"address": Nørrebrogade 20, 2200 København N,
|
|
25
|
+
"coordinates": [55.6987,12.5501],
|
|
26
|
+
} satisfies UpdateShipmentRequestDroppoint
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateShipmentRequestDroppoint
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
package/package.json
CHANGED
package/src/apis/ShipmentsApi.ts
CHANGED
|
@@ -421,7 +421,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
|
|
|
421
421
|
}
|
|
422
422
|
|
|
423
423
|
/**
|
|
424
|
-
* Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order.
|
|
424
|
+
* Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order. When shippingRuleId is provided, carrier settings and the sender address derive from the rule.
|
|
425
425
|
* Create shipment
|
|
426
426
|
*/
|
|
427
427
|
async createShipmentRaw(requestParameters: CreateShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
|
|
@@ -432,7 +432,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
|
|
|
432
432
|
}
|
|
433
433
|
|
|
434
434
|
/**
|
|
435
|
-
* Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order.
|
|
435
|
+
* Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order. When shippingRuleId is provided, carrier settings and the sender address derive from the rule.
|
|
436
436
|
* Create shipment
|
|
437
437
|
*/
|
|
438
438
|
async createShipment(requestParameters: CreateShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
|
|
@@ -137,6 +137,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
|
|
|
137
137
|
ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
|
|
138
138
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
139
139
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
140
|
+
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
140
141
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
141
142
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
142
143
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -26,11 +26,11 @@ export interface CreateShipment201ResponseParcelsInnerOrderLinesInner {
|
|
|
26
26
|
*/
|
|
27
27
|
id?: string;
|
|
28
28
|
/**
|
|
29
|
-
* Stock keeping unit of the product.
|
|
29
|
+
* Stock keeping unit of the product. Optional — not every webshop assigns SKUs.
|
|
30
30
|
* @type {string}
|
|
31
31
|
* @memberof CreateShipment201ResponseParcelsInnerOrderLinesInner
|
|
32
32
|
*/
|
|
33
|
-
sku
|
|
33
|
+
sku?: string | null;
|
|
34
34
|
/**
|
|
35
35
|
* Number of units in this order line.
|
|
36
36
|
* @type {number}
|
|
@@ -85,7 +85,6 @@ export interface CreateShipment201ResponseParcelsInnerOrderLinesInner {
|
|
|
85
85
|
* Check if a given object implements the CreateShipment201ResponseParcelsInnerOrderLinesInner interface.
|
|
86
86
|
*/
|
|
87
87
|
export function instanceOfCreateShipment201ResponseParcelsInnerOrderLinesInner(value: object): value is CreateShipment201ResponseParcelsInnerOrderLinesInner {
|
|
88
|
-
if (!('sku' in value) || value['sku'] === undefined) return false;
|
|
89
88
|
if (!('quantity' in value) || value['quantity'] === undefined) return false;
|
|
90
89
|
return true;
|
|
91
90
|
}
|
|
@@ -101,7 +100,7 @@ export function CreateShipment201ResponseParcelsInnerOrderLinesInnerFromJSONType
|
|
|
101
100
|
return {
|
|
102
101
|
|
|
103
102
|
'id': json['id'] == null ? undefined : json['id'],
|
|
104
|
-
'sku': json['sku'],
|
|
103
|
+
'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
|
|
105
104
|
'quantity': json['quantity'],
|
|
106
105
|
'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
|
|
107
106
|
'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],
|
|
@@ -27,6 +27,13 @@ import {
|
|
|
27
27
|
CreateShipmentRequestCarrierSettingsToJSON,
|
|
28
28
|
CreateShipmentRequestCarrierSettingsToJSONTyped,
|
|
29
29
|
} from './CreateShipmentRequestCarrierSettings';
|
|
30
|
+
import type { CreateShipmentRequestDroppoint } from './CreateShipmentRequestDroppoint';
|
|
31
|
+
import {
|
|
32
|
+
CreateShipmentRequestDroppointFromJSON,
|
|
33
|
+
CreateShipmentRequestDroppointFromJSONTyped,
|
|
34
|
+
CreateShipmentRequestDroppointToJSON,
|
|
35
|
+
CreateShipmentRequestDroppointToJSONTyped,
|
|
36
|
+
} from './CreateShipmentRequestDroppoint';
|
|
30
37
|
import type { CreateShipmentRequestPartiesInner } from './CreateShipmentRequestPartiesInner';
|
|
31
38
|
import {
|
|
32
39
|
CreateShipmentRequestPartiesInnerFromJSON,
|
|
@@ -83,7 +90,7 @@ export interface CreateShipmentRequest {
|
|
|
83
90
|
* @type {CreateShipmentRequestCarrierSettings}
|
|
84
91
|
* @memberof CreateShipmentRequest
|
|
85
92
|
*/
|
|
86
|
-
carrierSettings
|
|
93
|
+
carrierSettings?: CreateShipmentRequestCarrierSettings;
|
|
87
94
|
/**
|
|
88
95
|
* Parcels to include. Optional when orderId is provided.
|
|
89
96
|
* @type {Array<CreateShipmentRequestParcelsInner>}
|
|
@@ -126,6 +133,18 @@ export interface CreateShipmentRequest {
|
|
|
126
133
|
* @memberof CreateShipmentRequest
|
|
127
134
|
*/
|
|
128
135
|
documentPrinterId?: string | null;
|
|
136
|
+
/**
|
|
137
|
+
* Create the shipment from this shipping rule: carrier settings and the sender address derive from the rule (explicit carrierSettings and addressId are then ignored).
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof CreateShipmentRequest
|
|
140
|
+
*/
|
|
141
|
+
shippingRuleId?: string;
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
* @type {CreateShipmentRequestDroppoint}
|
|
145
|
+
* @memberof CreateShipmentRequest
|
|
146
|
+
*/
|
|
147
|
+
droppoint?: CreateShipmentRequestDroppoint;
|
|
129
148
|
}
|
|
130
149
|
|
|
131
150
|
|
|
@@ -159,7 +178,6 @@ export type CreateShipmentRequestStatusEnum = typeof CreateShipmentRequestStatus
|
|
|
159
178
|
*/
|
|
160
179
|
export function instanceOfCreateShipmentRequest(value: object): value is CreateShipmentRequest {
|
|
161
180
|
if (!('type' in value) || value['type'] === undefined) return false;
|
|
162
|
-
if (!('carrierSettings' in value) || value['carrierSettings'] === undefined) return false;
|
|
163
181
|
return true;
|
|
164
182
|
}
|
|
165
183
|
|
|
@@ -178,7 +196,7 @@ export function CreateShipmentRequestFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
178
196
|
'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
|
|
179
197
|
'parties': json['parties'] == null ? undefined : ((json['parties'] as Array<any>).map(CreateShipmentRequestPartiesInnerFromJSON)),
|
|
180
198
|
'type': json['type'],
|
|
181
|
-
'carrierSettings': CreateShipmentRequestCarrierSettingsFromJSON(json['carrierSettings']),
|
|
199
|
+
'carrierSettings': json['carrierSettings'] == null ? undefined : CreateShipmentRequestCarrierSettingsFromJSON(json['carrierSettings']),
|
|
182
200
|
'parcels': json['parcels'] == null ? undefined : ((json['parcels'] as Array<any>).map(CreateShipmentRequestParcelsInnerFromJSON)),
|
|
183
201
|
'pickupDetails': json['pickupDetails'] === undefined ? undefined : json['pickupDetails'] === null ? null : CreateShipmentRequestPickupDetailsFromJSON(json['pickupDetails']),
|
|
184
202
|
'termOfTrade': json['termOfTrade'] == null ? undefined : json['termOfTrade'],
|
|
@@ -186,6 +204,8 @@ export function CreateShipmentRequestFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
186
204
|
'orderId': json['orderId'] === undefined ? undefined : json['orderId'] === null ? null : json['orderId'],
|
|
187
205
|
'labelPrinterId': json['labelPrinterId'] === undefined ? undefined : json['labelPrinterId'] === null ? null : json['labelPrinterId'],
|
|
188
206
|
'documentPrinterId': json['documentPrinterId'] === undefined ? undefined : json['documentPrinterId'] === null ? null : json['documentPrinterId'],
|
|
207
|
+
'shippingRuleId': json['shippingRuleId'] == null ? undefined : json['shippingRuleId'],
|
|
208
|
+
'droppoint': json['droppoint'] == null ? undefined : CreateShipmentRequestDroppointFromJSON(json['droppoint']),
|
|
189
209
|
};
|
|
190
210
|
}
|
|
191
211
|
|
|
@@ -213,6 +233,8 @@ export function CreateShipmentRequestToJSONTyped(value?: CreateShipmentRequest |
|
|
|
213
233
|
'orderId': value['orderId'],
|
|
214
234
|
'labelPrinterId': value['labelPrinterId'],
|
|
215
235
|
'documentPrinterId': value['documentPrinterId'],
|
|
236
|
+
'shippingRuleId': value['shippingRuleId'],
|
|
237
|
+
'droppoint': CreateShipmentRequestDroppointToJSON(value['droppoint']),
|
|
216
238
|
};
|
|
217
239
|
}
|
|
218
240
|
|