@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,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,54 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Zippendo Public API
|
|
5
|
+
* 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`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@zippendo.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON, ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON, } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the UpdateShipmentRequestDroppoint interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfUpdateShipmentRequestDroppoint(value) {
|
|
19
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('address' in value) || value['address'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
export function UpdateShipmentRequestDroppointFromJSON(json) {
|
|
28
|
+
return UpdateShipmentRequestDroppointFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
export function UpdateShipmentRequestDroppointFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'id': json['id'],
|
|
36
|
+
'name': json['name'],
|
|
37
|
+
'address': json['address'],
|
|
38
|
+
'coordinates': json['coordinates'] == null ? undefined : (json['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON)),
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
export function UpdateShipmentRequestDroppointToJSON(json) {
|
|
42
|
+
return UpdateShipmentRequestDroppointToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
export function UpdateShipmentRequestDroppointToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'id': value['id'],
|
|
50
|
+
'name': value['name'],
|
|
51
|
+
'address': value['address'],
|
|
52
|
+
'coordinates': value['coordinates'] == null ? undefined : (value['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON)),
|
|
53
|
+
};
|
|
54
|
+
}
|
|
@@ -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/esm/models/index.js
CHANGED
|
@@ -37,6 +37,7 @@ export * from './CreateShipment201ResponseShippingRule';
|
|
|
37
37
|
export * from './CreateShipment201ResponseTracking';
|
|
38
38
|
export * from './CreateShipmentRequest';
|
|
39
39
|
export * from './CreateShipmentRequestCarrierSettings';
|
|
40
|
+
export * from './CreateShipmentRequestDroppoint';
|
|
40
41
|
export * from './CreateShipmentRequestParcelsInner';
|
|
41
42
|
export * from './CreateShipmentRequestParcelsInnerDimensions';
|
|
42
43
|
export * from './CreateShipmentRequestParcelsInnerOrderLinesInner';
|
|
@@ -143,6 +144,8 @@ export * from './UpdateOrgBrandingRequest';
|
|
|
143
144
|
export * from './UpdateOrgRequest';
|
|
144
145
|
export * from './UpdateOrgWebhookRequest';
|
|
145
146
|
export * from './UpdateShipmentRequest';
|
|
147
|
+
export * from './UpdateShipmentRequestCarrierSettings';
|
|
148
|
+
export * from './UpdateShipmentRequestDroppoint';
|
|
146
149
|
export * from './UpdateShippingRuleRequest';
|
|
147
150
|
export * from './VerifyApiToken200Response';
|
|
148
151
|
export * from './VerifyApiTokenRequest';
|
|
@@ -123,6 +123,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
|
|
|
123
123
|
readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
|
|
124
124
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
125
125
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
126
|
+
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
126
127
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
127
128
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
128
129
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -95,6 +95,7 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
|
|
|
95
95
|
ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
|
|
96
96
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
97
97
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
98
|
+
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
98
99
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
99
100
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
100
101
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -22,11 +22,11 @@ export interface CreateShipment201ResponseParcelsInnerOrderLinesInner {
|
|
|
22
22
|
*/
|
|
23
23
|
id?: string;
|
|
24
24
|
/**
|
|
25
|
-
* Stock keeping unit of the product.
|
|
25
|
+
* Stock keeping unit of the product. Optional — not every webshop assigns SKUs.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof CreateShipment201ResponseParcelsInnerOrderLinesInner
|
|
28
28
|
*/
|
|
29
|
-
sku
|
|
29
|
+
sku?: string | null;
|
|
30
30
|
/**
|
|
31
31
|
* Number of units in this order line.
|
|
32
32
|
* @type {number}
|
|
@@ -22,8 +22,6 @@ exports.CreateShipment201ResponseParcelsInnerOrderLinesInnerToJSONTyped = Create
|
|
|
22
22
|
* Check if a given object implements the CreateShipment201ResponseParcelsInnerOrderLinesInner interface.
|
|
23
23
|
*/
|
|
24
24
|
function instanceOfCreateShipment201ResponseParcelsInnerOrderLinesInner(value) {
|
|
25
|
-
if (!('sku' in value) || value['sku'] === undefined)
|
|
26
|
-
return false;
|
|
27
25
|
if (!('quantity' in value) || value['quantity'] === undefined)
|
|
28
26
|
return false;
|
|
29
27
|
return true;
|
|
@@ -37,7 +35,7 @@ function CreateShipment201ResponseParcelsInnerOrderLinesInnerFromJSONTyped(json,
|
|
|
37
35
|
}
|
|
38
36
|
return {
|
|
39
37
|
'id': json['id'] == null ? undefined : json['id'],
|
|
40
|
-
'sku': json['sku'],
|
|
38
|
+
'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
|
|
41
39
|
'quantity': json['quantity'],
|
|
42
40
|
'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
|
|
43
41
|
'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { CreateShipmentRequestPickupDetails } from './CreateShipmentRequestPickupDetails';
|
|
13
13
|
import type { CreateShipmentRequestCarrierSettings } from './CreateShipmentRequestCarrierSettings';
|
|
14
|
+
import type { CreateShipmentRequestDroppoint } from './CreateShipmentRequestDroppoint';
|
|
14
15
|
import type { CreateShipmentRequestPartiesInner } from './CreateShipmentRequestPartiesInner';
|
|
15
16
|
import type { CreateShipmentRequestParcelsInner } from './CreateShipmentRequestParcelsInner';
|
|
16
17
|
/**
|
|
@@ -54,7 +55,7 @@ export interface CreateShipmentRequest {
|
|
|
54
55
|
* @type {CreateShipmentRequestCarrierSettings}
|
|
55
56
|
* @memberof CreateShipmentRequest
|
|
56
57
|
*/
|
|
57
|
-
carrierSettings
|
|
58
|
+
carrierSettings?: CreateShipmentRequestCarrierSettings;
|
|
58
59
|
/**
|
|
59
60
|
* Parcels to include. Optional when orderId is provided.
|
|
60
61
|
* @type {Array<CreateShipmentRequestParcelsInner>}
|
|
@@ -97,6 +98,18 @@ export interface CreateShipmentRequest {
|
|
|
97
98
|
* @memberof CreateShipmentRequest
|
|
98
99
|
*/
|
|
99
100
|
documentPrinterId?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
* Create the shipment from this shipping rule: carrier settings and the sender address derive from the rule (explicit carrierSettings and addressId are then ignored).
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof CreateShipmentRequest
|
|
105
|
+
*/
|
|
106
|
+
shippingRuleId?: string;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @type {CreateShipmentRequestDroppoint}
|
|
110
|
+
* @memberof CreateShipmentRequest
|
|
111
|
+
*/
|
|
112
|
+
droppoint?: CreateShipmentRequestDroppoint;
|
|
100
113
|
}
|
|
101
114
|
/**
|
|
102
115
|
* @export
|
|
@@ -21,6 +21,7 @@ exports.CreateShipmentRequestToJSON = CreateShipmentRequestToJSON;
|
|
|
21
21
|
exports.CreateShipmentRequestToJSONTyped = CreateShipmentRequestToJSONTyped;
|
|
22
22
|
const CreateShipmentRequestPickupDetails_1 = require("./CreateShipmentRequestPickupDetails");
|
|
23
23
|
const CreateShipmentRequestCarrierSettings_1 = require("./CreateShipmentRequestCarrierSettings");
|
|
24
|
+
const CreateShipmentRequestDroppoint_1 = require("./CreateShipmentRequestDroppoint");
|
|
24
25
|
const CreateShipmentRequestPartiesInner_1 = require("./CreateShipmentRequestPartiesInner");
|
|
25
26
|
const CreateShipmentRequestParcelsInner_1 = require("./CreateShipmentRequestParcelsInner");
|
|
26
27
|
/**
|
|
@@ -49,8 +50,6 @@ exports.CreateShipmentRequestStatusEnum = {
|
|
|
49
50
|
function instanceOfCreateShipmentRequest(value) {
|
|
50
51
|
if (!('type' in value) || value['type'] === undefined)
|
|
51
52
|
return false;
|
|
52
|
-
if (!('carrierSettings' in value) || value['carrierSettings'] === undefined)
|
|
53
|
-
return false;
|
|
54
53
|
return true;
|
|
55
54
|
}
|
|
56
55
|
function CreateShipmentRequestFromJSON(json) {
|
|
@@ -66,7 +65,7 @@ function CreateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
66
65
|
'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
|
|
67
66
|
'parties': json['parties'] == null ? undefined : (json['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerFromJSON)),
|
|
68
67
|
'type': json['type'],
|
|
69
|
-
'carrierSettings': (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
|
|
68
|
+
'carrierSettings': json['carrierSettings'] == null ? undefined : (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
|
|
70
69
|
'parcels': json['parcels'] == null ? undefined : (json['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerFromJSON)),
|
|
71
70
|
'pickupDetails': json['pickupDetails'] === undefined ? undefined : json['pickupDetails'] === null ? null : (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsFromJSON)(json['pickupDetails']),
|
|
72
71
|
'termOfTrade': json['termOfTrade'] == null ? undefined : json['termOfTrade'],
|
|
@@ -74,6 +73,8 @@ function CreateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
74
73
|
'orderId': json['orderId'] === undefined ? undefined : json['orderId'] === null ? null : json['orderId'],
|
|
75
74
|
'labelPrinterId': json['labelPrinterId'] === undefined ? undefined : json['labelPrinterId'] === null ? null : json['labelPrinterId'],
|
|
76
75
|
'documentPrinterId': json['documentPrinterId'] === undefined ? undefined : json['documentPrinterId'] === null ? null : json['documentPrinterId'],
|
|
76
|
+
'shippingRuleId': json['shippingRuleId'] == null ? undefined : json['shippingRuleId'],
|
|
77
|
+
'droppoint': json['droppoint'] == null ? undefined : (0, CreateShipmentRequestDroppoint_1.CreateShipmentRequestDroppointFromJSON)(json['droppoint']),
|
|
77
78
|
};
|
|
78
79
|
}
|
|
79
80
|
function CreateShipmentRequestToJSON(json) {
|
|
@@ -97,5 +98,7 @@ function CreateShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
97
98
|
'orderId': value['orderId'],
|
|
98
99
|
'labelPrinterId': value['labelPrinterId'],
|
|
99
100
|
'documentPrinterId': value['documentPrinterId'],
|
|
101
|
+
'shippingRuleId': value['shippingRuleId'],
|
|
102
|
+
'droppoint': (0, CreateShipmentRequestDroppoint_1.CreateShipmentRequestDroppointToJSON)(value['droppoint']),
|
|
100
103
|
};
|
|
101
104
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { CreateShippingRuleRequestAdditionalParametersValue } from './CreateShippingRuleRequestAdditionalParametersValue';
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Carrier configuration for the shipment. Optional when shippingRuleId is provided.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface CreateShipmentRequestCarrierSettings
|
|
17
17
|
*/
|
|
@@ -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 with a service-point shipping rule.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface CreateShipmentRequestDroppoint
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateShipmentRequestDroppoint {
|
|
19
|
+
/**
|
|
20
|
+
* Identifier of the selected service point.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof CreateShipmentRequestDroppoint
|
|
23
|
+
*/
|
|
24
|
+
id: string;
|
|
25
|
+
/**
|
|
26
|
+
* Display name of the service point.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof CreateShipmentRequestDroppoint
|
|
29
|
+
*/
|
|
30
|
+
name: string;
|
|
31
|
+
/**
|
|
32
|
+
* Formatted address of the service point.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof CreateShipmentRequestDroppoint
|
|
35
|
+
*/
|
|
36
|
+
address: string;
|
|
37
|
+
/**
|
|
38
|
+
* Latitude/longitude of the service point.
|
|
39
|
+
* @type {Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>}
|
|
40
|
+
* @memberof CreateShipmentRequestDroppoint
|
|
41
|
+
*/
|
|
42
|
+
coordinates?: Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the CreateShipmentRequestDroppoint interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfCreateShipmentRequestDroppoint(value: object): value is CreateShipmentRequestDroppoint;
|
|
48
|
+
export declare function CreateShipmentRequestDroppointFromJSON(json: any): CreateShipmentRequestDroppoint;
|
|
49
|
+
export declare function CreateShipmentRequestDroppointFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestDroppoint;
|
|
50
|
+
export declare function CreateShipmentRequestDroppointToJSON(json: any): CreateShipmentRequestDroppoint;
|
|
51
|
+
export declare function CreateShipmentRequestDroppointToJSONTyped(value?: CreateShipmentRequestDroppoint | 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.instanceOfCreateShipmentRequestDroppoint = instanceOfCreateShipmentRequestDroppoint;
|
|
17
|
+
exports.CreateShipmentRequestDroppointFromJSON = CreateShipmentRequestDroppointFromJSON;
|
|
18
|
+
exports.CreateShipmentRequestDroppointFromJSONTyped = CreateShipmentRequestDroppointFromJSONTyped;
|
|
19
|
+
exports.CreateShipmentRequestDroppointToJSON = CreateShipmentRequestDroppointToJSON;
|
|
20
|
+
exports.CreateShipmentRequestDroppointToJSONTyped = CreateShipmentRequestDroppointToJSONTyped;
|
|
21
|
+
const ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1 = require("./ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the CreateShipmentRequestDroppoint interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfCreateShipmentRequestDroppoint(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 CreateShipmentRequestDroppointFromJSON(json) {
|
|
35
|
+
return CreateShipmentRequestDroppointFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
function CreateShipmentRequestDroppointFromJSONTyped(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 CreateShipmentRequestDroppointToJSON(json) {
|
|
49
|
+
return CreateShipmentRequestDroppointToJSONTyped(json, false);
|
|
50
|
+
}
|
|
51
|
+
function CreateShipmentRequestDroppointToJSONTyped(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
|
+
}
|
|
@@ -22,11 +22,11 @@ export interface CreateShipmentRequestParcelsInnerOrderLinesInner {
|
|
|
22
22
|
*/
|
|
23
23
|
id?: string;
|
|
24
24
|
/**
|
|
25
|
-
* Stock keeping unit of the product.
|
|
25
|
+
* Stock keeping unit of the product. Optional — not every webshop assigns SKUs.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
|
|
28
28
|
*/
|
|
29
|
-
sku
|
|
29
|
+
sku?: string | null;
|
|
30
30
|
/**
|
|
31
31
|
* Number of units in this order line.
|
|
32
32
|
* @type {number}
|
|
@@ -22,8 +22,6 @@ exports.CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped = CreateShip
|
|
|
22
22
|
* Check if a given object implements the CreateShipmentRequestParcelsInnerOrderLinesInner interface.
|
|
23
23
|
*/
|
|
24
24
|
function instanceOfCreateShipmentRequestParcelsInnerOrderLinesInner(value) {
|
|
25
|
-
if (!('sku' in value) || value['sku'] === undefined)
|
|
26
|
-
return false;
|
|
27
25
|
if (!('quantity' in value) || value['quantity'] === undefined)
|
|
28
26
|
return false;
|
|
29
27
|
return true;
|
|
@@ -37,7 +35,7 @@ function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(json, ign
|
|
|
37
35
|
}
|
|
38
36
|
return {
|
|
39
37
|
'id': json['id'] == null ? undefined : json['id'],
|
|
40
|
-
'sku': json['sku'],
|
|
38
|
+
'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
|
|
41
39
|
'quantity': json['quantity'],
|
|
42
40
|
'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
|
|
43
41
|
'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],
|
|
@@ -54,6 +54,12 @@ export interface GetOrder200ResponseShipmentsInner {
|
|
|
54
54
|
* @memberof GetOrder200ResponseShipmentsInner
|
|
55
55
|
*/
|
|
56
56
|
carrierSettings: ListShipments200ResponseDataInnerCarrierSettings;
|
|
57
|
+
/**
|
|
58
|
+
* Selected carrier service point identifier.
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof GetOrder200ResponseShipmentsInner
|
|
61
|
+
*/
|
|
62
|
+
servicePointId?: string | null;
|
|
57
63
|
/**
|
|
58
64
|
* Timestamp when the shipment was created.
|
|
59
65
|
* @type {string}
|
|
@@ -76,6 +76,7 @@ function GetOrder200ResponseShipmentsInnerFromJSONTyped(json, ignoreDiscriminato
|
|
|
76
76
|
'type': json['type'],
|
|
77
77
|
'tracking': json['tracking'] === undefined ? undefined : json['tracking'] === null ? null : (0, CreateShipment201ResponseTracking_1.CreateShipment201ResponseTrackingFromJSON)(json['tracking']),
|
|
78
78
|
'carrierSettings': (0, ListShipments200ResponseDataInnerCarrierSettings_1.ListShipments200ResponseDataInnerCarrierSettingsFromJSON)(json['carrierSettings']),
|
|
79
|
+
'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
|
|
79
80
|
'createdAt': json['createdAt'],
|
|
80
81
|
'updatedAt': json['updatedAt'],
|
|
81
82
|
'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
|
|
@@ -96,6 +97,7 @@ function GetOrder200ResponseShipmentsInnerToJSONTyped(value, ignoreDiscriminator
|
|
|
96
97
|
'type': value['type'],
|
|
97
98
|
'tracking': (0, CreateShipment201ResponseTracking_1.CreateShipment201ResponseTrackingToJSON)(value['tracking']),
|
|
98
99
|
'carrierSettings': (0, ListShipments200ResponseDataInnerCarrierSettings_1.ListShipments200ResponseDataInnerCarrierSettingsToJSON)(value['carrierSettings']),
|
|
100
|
+
'servicePointId': value['servicePointId'],
|
|
99
101
|
'createdAt': value['createdAt'],
|
|
100
102
|
'updatedAt': value['updatedAt'],
|
|
101
103
|
'shippingRuleId': value['shippingRuleId'],
|
|
@@ -102,6 +102,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
|
|
|
102
102
|
readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
|
|
103
103
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
104
104
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
105
|
+
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
105
106
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
106
107
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
107
108
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -87,6 +87,7 @@ exports.ListApiTokens401ResponseCodeEnum = {
|
|
|
87
87
|
ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
|
|
88
88
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
89
89
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
90
|
+
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
90
91
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
91
92
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
92
93
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -109,6 +109,7 @@ export declare const SendShipment422ResponseCodeEnum: {
|
|
|
109
109
|
readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
|
|
110
110
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
111
111
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
112
|
+
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
112
113
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
113
114
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
114
115
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -88,6 +88,7 @@ exports.SendShipment422ResponseCodeEnum = {
|
|
|
88
88
|
ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
|
|
89
89
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
90
90
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
91
|
+
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
91
92
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
92
93
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
93
94
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -10,8 +10,9 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { CreateShipmentRequestPickupDetails } from './CreateShipmentRequestPickupDetails';
|
|
13
|
-
import type {
|
|
13
|
+
import type { UpdateShipmentRequestDroppoint } from './UpdateShipmentRequestDroppoint';
|
|
14
14
|
import type { CreateShipmentRequestPartiesInner } from './CreateShipmentRequestPartiesInner';
|
|
15
|
+
import type { UpdateShipmentRequestCarrierSettings } from './UpdateShipmentRequestCarrierSettings';
|
|
15
16
|
import type { CreateShipmentRequestParcelsInner } from './CreateShipmentRequestParcelsInner';
|
|
16
17
|
/**
|
|
17
18
|
*
|
|
@@ -51,10 +52,10 @@ export interface UpdateShipmentRequest {
|
|
|
51
52
|
type?: UpdateShipmentRequestTypeEnum;
|
|
52
53
|
/**
|
|
53
54
|
*
|
|
54
|
-
* @type {
|
|
55
|
+
* @type {UpdateShipmentRequestCarrierSettings}
|
|
55
56
|
* @memberof UpdateShipmentRequest
|
|
56
57
|
*/
|
|
57
|
-
carrierSettings?:
|
|
58
|
+
carrierSettings?: UpdateShipmentRequestCarrierSettings;
|
|
58
59
|
/**
|
|
59
60
|
* Parcels to include. Optional when orderId is provided.
|
|
60
61
|
* @type {Array<CreateShipmentRequestParcelsInner>}
|
|
@@ -103,6 +104,12 @@ export interface UpdateShipmentRequest {
|
|
|
103
104
|
* @memberof UpdateShipmentRequest
|
|
104
105
|
*/
|
|
105
106
|
shippingRuleId?: string | null;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @type {UpdateShipmentRequestDroppoint}
|
|
110
|
+
* @memberof UpdateShipmentRequest
|
|
111
|
+
*/
|
|
112
|
+
droppoint?: UpdateShipmentRequestDroppoint;
|
|
106
113
|
}
|
|
107
114
|
/**
|
|
108
115
|
* @export
|
|
@@ -20,8 +20,9 @@ exports.UpdateShipmentRequestFromJSONTyped = UpdateShipmentRequestFromJSONTyped;
|
|
|
20
20
|
exports.UpdateShipmentRequestToJSON = UpdateShipmentRequestToJSON;
|
|
21
21
|
exports.UpdateShipmentRequestToJSONTyped = UpdateShipmentRequestToJSONTyped;
|
|
22
22
|
const CreateShipmentRequestPickupDetails_1 = require("./CreateShipmentRequestPickupDetails");
|
|
23
|
-
const
|
|
23
|
+
const UpdateShipmentRequestDroppoint_1 = require("./UpdateShipmentRequestDroppoint");
|
|
24
24
|
const CreateShipmentRequestPartiesInner_1 = require("./CreateShipmentRequestPartiesInner");
|
|
25
|
+
const UpdateShipmentRequestCarrierSettings_1 = require("./UpdateShipmentRequestCarrierSettings");
|
|
25
26
|
const CreateShipmentRequestParcelsInner_1 = require("./CreateShipmentRequestParcelsInner");
|
|
26
27
|
/**
|
|
27
28
|
* @export
|
|
@@ -62,7 +63,7 @@ function UpdateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
62
63
|
'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
|
|
63
64
|
'parties': json['parties'] == null ? undefined : (json['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerFromJSON)),
|
|
64
65
|
'type': json['type'] == null ? undefined : json['type'],
|
|
65
|
-
'carrierSettings': json['carrierSettings'] == null ? undefined : (0,
|
|
66
|
+
'carrierSettings': json['carrierSettings'] == null ? undefined : (0, UpdateShipmentRequestCarrierSettings_1.UpdateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
|
|
66
67
|
'parcels': json['parcels'] == null ? undefined : (json['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerFromJSON)),
|
|
67
68
|
'pickupDetails': json['pickupDetails'] === undefined ? undefined : json['pickupDetails'] === null ? null : (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsFromJSON)(json['pickupDetails']),
|
|
68
69
|
'termOfTrade': json['termOfTrade'] == null ? undefined : json['termOfTrade'],
|
|
@@ -71,6 +72,7 @@ function UpdateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
71
72
|
'labelPrinterId': json['labelPrinterId'] === undefined ? undefined : json['labelPrinterId'] === null ? null : json['labelPrinterId'],
|
|
72
73
|
'documentPrinterId': json['documentPrinterId'] === undefined ? undefined : json['documentPrinterId'] === null ? null : json['documentPrinterId'],
|
|
73
74
|
'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
|
|
75
|
+
'droppoint': json['droppoint'] == null ? undefined : (0, UpdateShipmentRequestDroppoint_1.UpdateShipmentRequestDroppointFromJSON)(json['droppoint']),
|
|
74
76
|
};
|
|
75
77
|
}
|
|
76
78
|
function UpdateShipmentRequestToJSON(json) {
|
|
@@ -86,7 +88,7 @@ function UpdateShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
86
88
|
'servicePointId': value['servicePointId'],
|
|
87
89
|
'parties': value['parties'] == null ? undefined : (value['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerToJSON)),
|
|
88
90
|
'type': value['type'],
|
|
89
|
-
'carrierSettings': (0,
|
|
91
|
+
'carrierSettings': (0, UpdateShipmentRequestCarrierSettings_1.UpdateShipmentRequestCarrierSettingsToJSON)(value['carrierSettings']),
|
|
90
92
|
'parcels': value['parcels'] == null ? undefined : (value['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerToJSON)),
|
|
91
93
|
'pickupDetails': (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsToJSON)(value['pickupDetails']),
|
|
92
94
|
'termOfTrade': value['termOfTrade'],
|
|
@@ -95,5 +97,6 @@ function UpdateShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
95
97
|
'labelPrinterId': value['labelPrinterId'],
|
|
96
98
|
'documentPrinterId': value['documentPrinterId'],
|
|
97
99
|
'shippingRuleId': value['shippingRuleId'],
|
|
100
|
+
'droppoint': (0, UpdateShipmentRequestDroppoint_1.UpdateShipmentRequestDroppointToJSON)(value['droppoint']),
|
|
98
101
|
};
|
|
99
102
|
}
|