@zippendo/sdk 1.3.7 → 1.3.8

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.
Files changed (118) hide show
  1. package/dist/apis/BrandsApi.d.ts +2 -2
  2. package/dist/apis/BrandsApi.js +2 -2
  3. package/dist/apis/CarriersApi.d.ts +2 -2
  4. package/dist/apis/CarriersApi.js +2 -2
  5. package/dist/apis/ShipmentsApi.d.ts +6 -6
  6. package/dist/apis/ShipmentsApi.js +6 -6
  7. package/dist/esm/apis/BrandsApi.d.ts +2 -2
  8. package/dist/esm/apis/BrandsApi.js +2 -2
  9. package/dist/esm/apis/CarriersApi.d.ts +2 -2
  10. package/dist/esm/apis/CarriersApi.js +2 -2
  11. package/dist/esm/apis/ShipmentsApi.d.ts +6 -6
  12. package/dist/esm/apis/ShipmentsApi.js +6 -6
  13. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -2
  14. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +2 -0
  15. package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
  16. package/dist/esm/models/BatchSendShipmentsRequest.d.ts +1 -1
  17. package/dist/esm/models/CreateOrder201Response.d.ts +1 -1
  18. package/dist/esm/models/CreateOrder201ResponseShippingAddress.d.ts +3 -3
  19. package/dist/esm/models/CreateOrderChannelRequest.d.ts +1 -1
  20. package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +1 -1
  21. package/dist/esm/models/CreateOrderRequestShippingAddress.d.ts +3 -3
  22. package/dist/esm/models/CreateOrgBrandRequest.d.ts +2 -2
  23. package/dist/esm/models/CreateShipment201Response.d.ts +1 -1
  24. package/dist/esm/models/CreateShipmentRequest.d.ts +1 -1
  25. package/dist/esm/models/CreateShippingRule201Response.d.ts +3 -3
  26. package/dist/esm/models/CreateShippingRuleRequest.d.ts +3 -3
  27. package/dist/esm/models/GetBillingUsage200ResponseZippyCredits.d.ts +1 -1
  28. package/dist/esm/models/GetOrder200Response.d.ts +1 -1
  29. package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts +2 -2
  30. package/dist/esm/models/ListApiTokens401Response.d.ts +2 -0
  31. package/dist/esm/models/ListApiTokens401Response.js +2 -0
  32. package/dist/esm/models/ListCarrierProducts200ResponseInner.d.ts +4 -4
  33. package/dist/esm/models/ListOrderChannels200ResponseDataInner.d.ts +1 -1
  34. package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +1 -1
  35. package/dist/esm/models/ListOrders200ResponseDataInner.d.ts +1 -1
  36. package/dist/esm/models/ListOrgBrands200ResponseDataInner.d.ts +2 -2
  37. package/dist/esm/models/ListShippingRules200ResponseDataInner.d.ts +3 -3
  38. package/dist/esm/models/SendShipment422Response.d.ts +3 -1
  39. package/dist/esm/models/SendShipment422Response.js +2 -0
  40. package/dist/esm/models/UpdateOrderChannelRequest.d.ts +1 -1
  41. package/dist/esm/models/UpdateOrderRequest.d.ts +2 -2
  42. package/dist/esm/models/UpdateOrgBrandRequest.d.ts +2 -2
  43. package/dist/esm/models/UpdateShipmentRequest.d.ts +1 -1
  44. package/dist/esm/models/UpdateShipmentRequestDroppoint.d.ts +1 -1
  45. package/dist/esm/models/UpdateShippingRuleRequest.d.ts +3 -3
  46. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -2
  47. package/dist/models/BatchSendShipments200ResponseResultsInner.js +2 -0
  48. package/dist/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
  49. package/dist/models/BatchSendShipmentsRequest.d.ts +1 -1
  50. package/dist/models/CreateOrder201Response.d.ts +1 -1
  51. package/dist/models/CreateOrder201ResponseShippingAddress.d.ts +3 -3
  52. package/dist/models/CreateOrderChannelRequest.d.ts +1 -1
  53. package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +1 -1
  54. package/dist/models/CreateOrderRequestShippingAddress.d.ts +3 -3
  55. package/dist/models/CreateOrgBrandRequest.d.ts +2 -2
  56. package/dist/models/CreateShipment201Response.d.ts +1 -1
  57. package/dist/models/CreateShipmentRequest.d.ts +1 -1
  58. package/dist/models/CreateShippingRule201Response.d.ts +3 -3
  59. package/dist/models/CreateShippingRuleRequest.d.ts +3 -3
  60. package/dist/models/GetBillingUsage200ResponseZippyCredits.d.ts +1 -1
  61. package/dist/models/GetOrder200Response.d.ts +1 -1
  62. package/dist/models/GetOrder200ResponseShipmentsInner.d.ts +2 -2
  63. package/dist/models/ListApiTokens401Response.d.ts +2 -0
  64. package/dist/models/ListApiTokens401Response.js +2 -0
  65. package/dist/models/ListCarrierProducts200ResponseInner.d.ts +4 -4
  66. package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +1 -1
  67. package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +1 -1
  68. package/dist/models/ListOrders200ResponseDataInner.d.ts +1 -1
  69. package/dist/models/ListOrgBrands200ResponseDataInner.d.ts +2 -2
  70. package/dist/models/ListShippingRules200ResponseDataInner.d.ts +3 -3
  71. package/dist/models/SendShipment422Response.d.ts +3 -1
  72. package/dist/models/SendShipment422Response.js +2 -0
  73. package/dist/models/UpdateOrderChannelRequest.d.ts +1 -1
  74. package/dist/models/UpdateOrderRequest.d.ts +2 -2
  75. package/dist/models/UpdateOrgBrandRequest.d.ts +2 -2
  76. package/dist/models/UpdateShipmentRequest.d.ts +1 -1
  77. package/dist/models/UpdateShipmentRequestDroppoint.d.ts +1 -1
  78. package/dist/models/UpdateShippingRuleRequest.d.ts +3 -3
  79. package/docs/BrandsApi.md +1 -1
  80. package/docs/CarriersApi.md +1 -1
  81. package/docs/GetBillingUsage200ResponseZippyCredits.md +1 -1
  82. package/docs/OrdersApi.md +2 -2
  83. package/docs/ShipmentsApi.md +3 -3
  84. package/docs/UpdateShipmentRequestDroppoint.md +1 -1
  85. package/package.json +1 -1
  86. package/src/apis/BrandsApi.ts +2 -2
  87. package/src/apis/CarriersApi.ts +2 -2
  88. package/src/apis/ShipmentsApi.ts +6 -6
  89. package/src/models/BatchSendShipments200ResponseResultsInner.ts +4 -2
  90. package/src/models/BatchSendShipments200ResponseSummary.ts +1 -1
  91. package/src/models/BatchSendShipmentsRequest.ts +1 -1
  92. package/src/models/CreateOrder201Response.ts +1 -1
  93. package/src/models/CreateOrder201ResponseShippingAddress.ts +3 -3
  94. package/src/models/CreateOrderChannelRequest.ts +1 -1
  95. package/src/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.ts +1 -1
  96. package/src/models/CreateOrderRequestShippingAddress.ts +3 -3
  97. package/src/models/CreateOrgBrandRequest.ts +2 -2
  98. package/src/models/CreateShipment201Response.ts +1 -1
  99. package/src/models/CreateShipmentRequest.ts +1 -1
  100. package/src/models/CreateShippingRule201Response.ts +3 -3
  101. package/src/models/CreateShippingRuleRequest.ts +3 -3
  102. package/src/models/GetBillingUsage200ResponseZippyCredits.ts +1 -1
  103. package/src/models/GetOrder200Response.ts +1 -1
  104. package/src/models/GetOrder200ResponseShipmentsInner.ts +2 -2
  105. package/src/models/ListApiTokens401Response.ts +2 -0
  106. package/src/models/ListCarrierProducts200ResponseInner.ts +4 -4
  107. package/src/models/ListOrderChannels200ResponseDataInner.ts +1 -1
  108. package/src/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.ts +1 -1
  109. package/src/models/ListOrders200ResponseDataInner.ts +1 -1
  110. package/src/models/ListOrgBrands200ResponseDataInner.ts +2 -2
  111. package/src/models/ListShippingRules200ResponseDataInner.ts +3 -3
  112. package/src/models/SendShipment422Response.ts +3 -1
  113. package/src/models/UpdateOrderChannelRequest.ts +1 -1
  114. package/src/models/UpdateOrderRequest.ts +2 -2
  115. package/src/models/UpdateOrgBrandRequest.ts +2 -2
  116. package/src/models/UpdateShipmentRequest.ts +1 -1
  117. package/src/models/UpdateShipmentRequestDroppoint.ts +1 -1
  118. package/src/models/UpdateShippingRuleRequest.ts +3 -3
@@ -35,7 +35,7 @@ export interface SendShipment422Response {
35
35
  */
36
36
  message: string;
37
37
  /**
38
- * Detailed carrier errors that caused the booking to fail.
38
+ * Detailed carrier errors that made sending fail.
39
39
  * @type {Array<SendShipment422ResponseErrorsInner>}
40
40
  * @memberof SendShipment422Response
41
41
  */
@@ -77,6 +77,8 @@ export declare const SendShipment422ResponseCodeEnum: {
77
77
  readonly OrgAccessDenied: "ORG_ACCESS_DENIED";
78
78
  readonly OrgDisabled: "ORG_DISABLED";
79
79
  readonly OrgSlugExists: "ORG_SLUG_EXISTS";
80
+ readonly SetupNotFound: "SETUP_NOT_FOUND";
81
+ readonly SetupExists: "SETUP_EXISTS";
80
82
  readonly BrandNotFound: "BRAND_NOT_FOUND";
81
83
  readonly BrandAccessDenied: "BRAND_ACCESS_DENIED";
82
84
  readonly BrandSlugExists: "BRAND_SLUG_EXISTS";
@@ -56,6 +56,8 @@ exports.SendShipment422ResponseCodeEnum = {
56
56
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
57
57
  OrgDisabled: 'ORG_DISABLED',
58
58
  OrgSlugExists: 'ORG_SLUG_EXISTS',
59
+ SetupNotFound: 'SETUP_NOT_FOUND',
60
+ SetupExists: 'SETUP_EXISTS',
59
61
  BrandNotFound: 'BRAND_NOT_FOUND',
60
62
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
61
63
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -35,7 +35,7 @@ export interface UpdateOrderChannelRequest {
35
35
  */
36
36
  enabled?: boolean;
37
37
  /**
38
- * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform.
38
+ * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform.
39
39
  * @type {UpdateOrderChannelRequestRoleEnum}
40
40
  * @memberof UpdateOrderChannelRequest
41
41
  */
@@ -72,7 +72,7 @@ export interface UpdateOrderRequest {
72
72
  */
73
73
  notes?: string | null;
74
74
  /**
75
- * Order fulfilment status derived from its shipments.
75
+ * Order fulfillment status derived from its shipments.
76
76
  * @type {UpdateOrderRequestStatusEnum}
77
77
  * @memberof UpdateOrderRequest
78
78
  */
@@ -84,7 +84,7 @@ export interface UpdateOrderRequest {
84
84
  */
85
85
  shippingRuleId?: string | null;
86
86
  /**
87
- * Service point (parcel shop) ID to apply to unsent outbound shipments.
87
+ * Service point ID to apply to unsent outbound shipments.
88
88
  * @type {string}
89
89
  * @memberof UpdateOrderRequest
90
90
  */
@@ -66,13 +66,13 @@ export interface UpdateOrgBrandRequest {
66
66
  */
67
67
  country?: string | null;
68
68
  /**
69
- * Primary brand colour — document title and table headers
69
+ * Primary brand color — document title and table headers
70
70
  * @type {string}
71
71
  * @memberof UpdateOrgBrandRequest
72
72
  */
73
73
  primaryColor?: string | null;
74
74
  /**
75
- * Secondary brand colour — subtitle, section headings, totals accent
75
+ * Secondary brand color — subtitle, section headings, totals accent
76
76
  * @type {string}
77
77
  * @memberof UpdateOrgBrandRequest
78
78
  */
@@ -33,7 +33,7 @@ export interface UpdateShipmentRequest {
33
33
  */
34
34
  addressId?: string | null;
35
35
  /**
36
- * Selected carrier service point identifier.
36
+ * Selected service point ID.
37
37
  * @type {string}
38
38
  * @memberof UpdateShipmentRequest
39
39
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
13
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).
14
+ * Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace it).
15
15
  * @export
16
16
  * @interface UpdateShipmentRequestDroppoint
17
17
  */
@@ -74,13 +74,13 @@ export interface UpdateShippingRuleRequest {
74
74
  */
75
75
  receivingCountries?: Array<string>;
76
76
  /**
77
- * Send email notification to recipient
77
+ * Send an email notification to the receiver
78
78
  * @type {boolean}
79
79
  * @memberof UpdateShippingRuleRequest
80
80
  */
81
81
  emailNotification?: boolean;
82
82
  /**
83
- * Send SMS notification to recipient
83
+ * Send an SMS notification to the receiver
84
84
  * @type {boolean}
85
85
  * @memberof UpdateShippingRuleRequest
86
86
  */
@@ -128,7 +128,7 @@ export interface UpdateShippingRuleRequest {
128
128
  */
129
129
  generateCommercialInvoice?: boolean;
130
130
  /**
131
- * Generate packing slip with package and item details
131
+ * Generate a packing slip with parcel and item details
132
132
  * @type {boolean}
133
133
  * @memberof UpdateShippingRuleRequest
134
134
  */
package/docs/BrandsApi.md CHANGED
@@ -638,7 +638,7 @@ example().catch(console.error);
638
638
 
639
639
  Update brand
640
640
 
641
- Updates a brand\&#39;s name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization\&#39;s value applies again.
641
+ Updates a brand\&#39;s name, slug, identity overrides (company name, VAT, customs, address) and document colors. Null clears an override so the organization\&#39;s value applies again.
642
642
 
643
643
  ### Example
644
644
 
@@ -331,7 +331,7 @@ example().catch(console.error);
331
331
 
332
332
  List carrier products
333
333
 
334
- Returns the shipping products available for a connected carrier.
334
+ Returns the carrier products available for a connected carrier.
335
335
 
336
336
  ### Example
337
337
 
@@ -1,7 +1,7 @@
1
1
 
2
2
  # GetBillingUsage200ResponseZippyCredits
3
3
 
4
- Zippy AI credit usage this period (present when the Zippy add-on is enabled)
4
+ Zippy credit usage this period (present when the Zippy add-on is enabled)
5
5
 
6
6
  ## Properties
7
7
 
package/docs/OrdersApi.md CHANGED
@@ -279,7 +279,7 @@ async function example() {
279
279
  brandId: brnd_8f3kd92ld0,
280
280
  // 'own' | 'shared' | 'both' | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. (optional)
281
281
  brandScope: own,
282
- // 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'error' | 'cancelled' | Order fulfilment status derived from its shipments. (optional)
282
+ // 'pending' | 'processing' | 'partially_fulfilled' | 'fulfilled' | 'error' | 'cancelled' | Order fulfillment status derived from its shipments. (optional)
283
283
  status: processing,
284
284
  // string | Filter by order channel ID. (optional)
285
285
  orderChannelId: clz9k2f0a0001abcd1234efgh,
@@ -311,7 +311,7 @@ example().catch(console.error);
311
311
  | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
312
312
  | **brandId** | `string` | Filter by brand. Pass a brand ID, or \&quot;none\&quot; for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
313
313
  | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \&quot;own\&quot; returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \&quot;shared\&quot; returns only unassigned organization-wide rows, \&quot;both\&quot; (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \&quot;shared\&quot; returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
314
- | **status** | `pending`, `processing`, `partially_fulfilled`, `fulfilled`, `error`, `cancelled` | Order fulfilment status derived from its shipments. | [Optional] [Defaults to `undefined`] [Enum: pending, processing, partially_fulfilled, fulfilled, error, cancelled] |
314
+ | **status** | `pending`, `processing`, `partially_fulfilled`, `fulfilled`, `error`, `cancelled` | Order fulfillment status derived from its shipments. | [Optional] [Defaults to `undefined`] [Enum: pending, processing, partially_fulfilled, fulfilled, error, cancelled] |
315
315
  | **orderChannelId** | `string` | Filter by order channel ID. | [Optional] [Defaults to `undefined`] |
316
316
  | **search** | `string` | Search by order number or customer name/email. | [Optional] [Defaults to `undefined`] |
317
317
  | **filter** | `string` | Advanced filter as a JSON-encoded definition: a &#x60;conjunction&#x60; (&#x60;and&#x60;/&#x60;or&#x60;) over &#x60;conditions&#x60;, each &#x60;{ id, field, operator, value }&#x60; or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 &#x60;FILTER_INVALID&#x60;. | [Optional] [Defaults to `undefined`] |
@@ -27,7 +27,7 @@ All URIs are relative to *https://api.zippendo.com*
27
27
 
28
28
  Batch send shipments
29
29
 
30
- Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in &#x60;results&#x60;; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
30
+ Send multiple shipments in &#x60;pending&#x60; or &#x60;error&#x60; status to their carriers in one request. Each shipment is processed independently and reported in &#x60;results&#x60;; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
31
31
 
32
32
  ### Example
33
33
 
@@ -183,7 +183,7 @@ example().catch(console.error);
183
183
 
184
184
  Create return shipment
185
185
 
186
- Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: &#x60;dispatched&#x60;, or &#x60;error&#x60; with the carrier\&#39;s reasons in &#x60;errors&#x60;.
186
+ Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with the outcome of sending it: &#x60;dispatched&#x60;, or &#x60;error&#x60; with the carrier\&#39;s reasons in &#x60;errors&#x60;.
187
187
 
188
188
  ### Example
189
189
 
@@ -748,7 +748,7 @@ example().catch(console.error);
748
748
 
749
749
  Send shipment
750
750
 
751
- Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
751
+ Send a shipment in &#x60;pending&#x60; or &#x60;error&#x60; status to its carrier, generating labels and tracking. Returns 422 with the carrier\&#39;s errors if sending fails.
752
752
 
753
753
  ### Example
754
754
 
@@ -1,7 +1,7 @@
1
1
 
2
2
  # UpdateShipmentRequestDroppoint
3
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).
4
+ Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace it).
5
5
 
6
6
  ## Properties
7
7
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.3.7",
3
+ "version": "1.3.8",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -657,7 +657,7 @@ export class BrandsApi extends runtime.BaseAPI {
657
657
  }
658
658
 
659
659
  /**
660
- * Updates a brand\'s name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization\'s value applies again.
660
+ * Updates a brand\'s name, slug, identity overrides (company name, VAT, customs, address) and document colors. Null clears an override so the organization\'s value applies again.
661
661
  * Update brand
662
662
  */
663
663
  async updateOrgBrandRaw(requestParameters: UpdateOrgBrandOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrgBrands200ResponseDataInner>> {
@@ -668,7 +668,7 @@ export class BrandsApi extends runtime.BaseAPI {
668
668
  }
669
669
 
670
670
  /**
671
- * Updates a brand\'s name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization\'s value applies again.
671
+ * Updates a brand\'s name, slug, identity overrides (company name, VAT, customs, address) and document colors. Null clears an override so the organization\'s value applies again.
672
672
  * Update brand
673
673
  */
674
674
  async updateOrgBrand(requestParameters: UpdateOrgBrandOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrgBrands200ResponseDataInner> {
@@ -422,7 +422,7 @@ export class CarriersApi extends runtime.BaseAPI {
422
422
  }
423
423
 
424
424
  /**
425
- * Returns the shipping products available for a connected carrier.
425
+ * Returns the carrier products available for a connected carrier.
426
426
  * List carrier products
427
427
  */
428
428
  async listCarrierProductsRaw(requestParameters: ListCarrierProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListCarrierProducts200ResponseInner>>> {
@@ -433,7 +433,7 @@ export class CarriersApi extends runtime.BaseAPI {
433
433
  }
434
434
 
435
435
  /**
436
- * Returns the shipping products available for a connected carrier.
436
+ * Returns the carrier products available for a connected carrier.
437
437
  * List carrier products
438
438
  */
439
439
  async listCarrierProducts(requestParameters: ListCarrierProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListCarrierProducts200ResponseInner>> {
@@ -229,7 +229,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
229
229
  }
230
230
 
231
231
  /**
232
- * Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
232
+ * Send multiple shipments in `pending` or `error` status to their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
233
233
  * Batch send shipments
234
234
  */
235
235
  async batchSendShipmentsRaw(requestParameters: BatchSendShipmentsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BatchSendShipments200Response>> {
@@ -240,7 +240,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
240
240
  }
241
241
 
242
242
  /**
243
- * Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
243
+ * Send multiple shipments in `pending` or `error` status to their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
244
244
  * Batch send shipments
245
245
  */
246
246
  async batchSendShipments(requestParameters: BatchSendShipmentsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BatchSendShipments200Response> {
@@ -365,7 +365,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
365
365
  }
366
366
 
367
367
  /**
368
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
368
+ * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with the outcome of sending it: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
369
369
  * Create return shipment
370
370
  */
371
371
  async createReturnShipmentRaw(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
@@ -376,7 +376,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
376
376
  }
377
377
 
378
378
  /**
379
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
379
+ * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with the outcome of sending it: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
380
380
  * Create return shipment
381
381
  */
382
382
  async createReturnShipment(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
@@ -847,7 +847,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
847
847
  }
848
848
 
849
849
  /**
850
- * Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
850
+ * Send a shipment in `pending` or `error` status to its carrier, generating labels and tracking. Returns 422 with the carrier\'s errors if sending fails.
851
851
  * Send shipment
852
852
  */
853
853
  async sendShipmentRaw(requestParameters: SendShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
@@ -858,7 +858,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
858
858
  }
859
859
 
860
860
  /**
861
- * Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
861
+ * Send a shipment in `pending` or `error` status to its carrier, generating labels and tracking. Returns 422 with the carrier\'s errors if sending fails.
862
862
  * Send shipment
863
863
  */
864
864
  async sendShipment(requestParameters: SendShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
@@ -34,7 +34,7 @@ export interface BatchSendShipments200ResponseResultsInner {
34
34
  */
35
35
  shipmentId: string;
36
36
  /**
37
- * `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
37
+ * `sent` when the carrier accepted it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
38
38
  * @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
39
39
  * @memberof BatchSendShipments200ResponseResultsInner
40
40
  */
@@ -52,7 +52,7 @@ export interface BatchSendShipments200ResponseResultsInner {
52
52
  */
53
53
  message?: string;
54
54
  /**
55
- * Carrier-specific errors, present when the carrier rejected the booking.
55
+ * Carrier-specific errors, present when the carrier rejected the shipment.
56
56
  * @type {Array<SendShipment422ResponseErrorsInner>}
57
57
  * @memberof BatchSendShipments200ResponseResultsInner
58
58
  */
@@ -106,6 +106,8 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
106
106
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
107
107
  OrgDisabled: 'ORG_DISABLED',
108
108
  OrgSlugExists: 'ORG_SLUG_EXISTS',
109
+ SetupNotFound: 'SETUP_NOT_FOUND',
110
+ SetupExists: 'SETUP_EXISTS',
109
111
  BrandNotFound: 'BRAND_NOT_FOUND',
110
112
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
111
113
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -26,7 +26,7 @@ export interface BatchSendShipments200ResponseSummary {
26
26
  */
27
27
  total: number;
28
28
  /**
29
- * How many were successfully booked.
29
+ * How many were sent successfully.
30
30
  * @type {number}
31
31
  * @memberof BatchSendShipments200ResponseSummary
32
32
  */
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface BatchSendShipmentsRequest {
22
22
  /**
23
- * IDs of the shipments to book. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request.
23
+ * IDs of the shipments to send. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request.
24
24
  * @type {Array<string>}
25
25
  * @memberof BatchSendShipmentsRequest
26
26
  */
@@ -95,7 +95,7 @@ export interface CreateOrder201Response {
95
95
  */
96
96
  currency?: string | null;
97
97
  /**
98
- * Order fulfilment status derived from its shipments.
98
+ * Order fulfillment status derived from its shipments.
99
99
  * @type {CreateOrder201ResponseStatusEnum}
100
100
  * @memberof CreateOrder201Response
101
101
  */
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface CreateOrder201ResponseShippingAddress {
22
22
  /**
23
- * Recipient full name.
23
+ * Receiver full name.
24
24
  * @type {string}
25
25
  * @memberof CreateOrder201ResponseShippingAddress
26
26
  */
@@ -86,13 +86,13 @@ export interface CreateOrder201ResponseShippingAddress {
86
86
  */
87
87
  countryCode: string;
88
88
  /**
89
- * Recipient phone number.
89
+ * Receiver phone number.
90
90
  * @type {string}
91
91
  * @memberof CreateOrder201ResponseShippingAddress
92
92
  */
93
93
  phone?: string | null;
94
94
  /**
95
- * Recipient email address.
95
+ * Receiver email address.
96
96
  * @type {string}
97
97
  * @memberof CreateOrder201ResponseShippingAddress
98
98
  */
@@ -52,7 +52,7 @@ export interface CreateOrderChannelRequest {
52
52
  */
53
53
  enabled?: boolean;
54
54
  /**
55
- * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform.
55
+ * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform.
56
56
  * @type {CreateOrderChannelRequestRoleEnum}
57
57
  * @memberof CreateOrderChannelRequest
58
58
  */
@@ -32,7 +32,7 @@ export interface CreateOrderChannelRequestSettingsShippingMethodMappingsInner {
32
32
  */
33
33
  shippingRuleId: string;
34
34
  /**
35
- * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection.
35
+ * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the receiver's address; 'manual' keeps the shipment in draft for manual selection.
36
36
  * @type {CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum}
37
37
  * @memberof CreateOrderChannelRequestSettingsShippingMethodMappingsInner
38
38
  */
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface CreateOrderRequestShippingAddress {
22
22
  /**
23
- * Recipient full name.
23
+ * Receiver full name.
24
24
  * @type {string}
25
25
  * @memberof CreateOrderRequestShippingAddress
26
26
  */
@@ -86,13 +86,13 @@ export interface CreateOrderRequestShippingAddress {
86
86
  */
87
87
  countryCode: string;
88
88
  /**
89
- * Recipient phone number.
89
+ * Receiver phone number.
90
90
  * @type {string}
91
91
  * @memberof CreateOrderRequestShippingAddress
92
92
  */
93
93
  phone?: string | null;
94
94
  /**
95
- * Recipient email address.
95
+ * Receiver email address.
96
96
  * @type {string}
97
97
  * @memberof CreateOrderRequestShippingAddress
98
98
  */
@@ -68,13 +68,13 @@ export interface CreateOrgBrandRequest {
68
68
  */
69
69
  country?: string | null;
70
70
  /**
71
- * Primary brand colour — document title and table headers
71
+ * Primary brand color — document title and table headers
72
72
  * @type {string}
73
73
  * @memberof CreateOrgBrandRequest
74
74
  */
75
75
  primaryColor?: string | null;
76
76
  /**
77
- * Secondary brand colour — subtitle, section headings, totals accent
77
+ * Secondary brand color — subtitle, section headings, totals accent
78
78
  * @type {string}
79
79
  * @memberof CreateOrgBrandRequest
80
80
  */
@@ -109,7 +109,7 @@ export interface CreateShipment201Response {
109
109
  */
110
110
  addressId?: string | null;
111
111
  /**
112
- * Selected carrier service point identifier.
112
+ * Selected service point ID.
113
113
  * @type {string}
114
114
  * @memberof CreateShipment201Response
115
115
  */
@@ -68,7 +68,7 @@ export interface CreateShipmentRequest {
68
68
  */
69
69
  addressId?: string | null;
70
70
  /**
71
- * Selected carrier service point identifier.
71
+ * Selected service point ID.
72
72
  * @type {string}
73
73
  * @memberof CreateShipmentRequest
74
74
  */
@@ -95,13 +95,13 @@ export interface CreateShippingRule201Response {
95
95
  */
96
96
  receivingCountries: Array<string>;
97
97
  /**
98
- * Send email notification to recipient
98
+ * Send an email notification to the receiver
99
99
  * @type {boolean}
100
100
  * @memberof CreateShippingRule201Response
101
101
  */
102
102
  emailNotification: boolean;
103
103
  /**
104
- * Send SMS notification to recipient
104
+ * Send an SMS notification to the receiver
105
105
  * @type {boolean}
106
106
  * @memberof CreateShippingRule201Response
107
107
  */
@@ -149,7 +149,7 @@ export interface CreateShippingRule201Response {
149
149
  */
150
150
  generateCommercialInvoice: boolean;
151
151
  /**
152
- * Generate packing slip with package and item details
152
+ * Generate a packing slip with parcel and item details
153
153
  * @type {boolean}
154
154
  * @memberof CreateShippingRule201Response
155
155
  */
@@ -89,13 +89,13 @@ export interface CreateShippingRuleRequest {
89
89
  */
90
90
  receivingCountries: Array<string>;
91
91
  /**
92
- * Send email notification to recipient
92
+ * Send an email notification to the receiver
93
93
  * @type {boolean}
94
94
  * @memberof CreateShippingRuleRequest
95
95
  */
96
96
  emailNotification?: boolean;
97
97
  /**
98
- * Send SMS notification to recipient
98
+ * Send an SMS notification to the receiver
99
99
  * @type {boolean}
100
100
  * @memberof CreateShippingRuleRequest
101
101
  */
@@ -143,7 +143,7 @@ export interface CreateShippingRuleRequest {
143
143
  */
144
144
  generateCommercialInvoice?: boolean;
145
145
  /**
146
- * Generate packing slip with package and item details
146
+ * Generate a packing slip with parcel and item details
147
147
  * @type {boolean}
148
148
  * @memberof CreateShippingRuleRequest
149
149
  */
@@ -14,7 +14,7 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
- * Zippy AI credit usage this period (present when the Zippy add-on is enabled)
17
+ * Zippy credit usage this period (present when the Zippy add-on is enabled)
18
18
  * @export
19
19
  * @interface GetBillingUsage200ResponseZippyCredits
20
20
  */
@@ -116,7 +116,7 @@ export interface GetOrder200Response {
116
116
  */
117
117
  currency?: string | null;
118
118
  /**
119
- * Order fulfilment status derived from its shipments.
119
+ * Order fulfillment status derived from its shipments.
120
120
  * @type {GetOrder200ResponseStatusEnum}
121
121
  * @memberof GetOrder200Response
122
122
  */
@@ -85,7 +85,7 @@ export interface GetOrder200ResponseShipmentsInner {
85
85
  */
86
86
  carrierSettings: ListShipments200ResponseDataInnerCarrierSettings;
87
87
  /**
88
- * Selected carrier service point identifier.
88
+ * Selected service point ID.
89
89
  * @type {string}
90
90
  * @memberof GetOrder200ResponseShipmentsInner
91
91
  */
@@ -115,7 +115,7 @@ export interface GetOrder200ResponseShipmentsInner {
115
115
  */
116
116
  documents?: Array<CreateShipment201ResponseDocumentsInner>;
117
117
  /**
118
- * Compact parcels for the order fulfillment workspace (no QR/label payloads).
118
+ * Compact parcels for the order's fulfillment view (no QR/label payloads).
119
119
  * @type {Array<GetOrder200ResponseShipmentsInnerParcelsInner>}
120
120
  * @memberof GetOrder200ResponseShipmentsInner
121
121
  */
@@ -76,6 +76,8 @@ export const ListApiTokens401ResponseCodeEnum = {
76
76
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
77
77
  OrgDisabled: 'ORG_DISABLED',
78
78
  OrgSlugExists: 'ORG_SLUG_EXISTS',
79
+ SetupNotFound: 'SETUP_NOT_FOUND',
80
+ SetupExists: 'SETUP_EXISTS',
79
81
  BrandNotFound: 'BRAND_NOT_FOUND',
80
82
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
81
83
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -42,7 +42,7 @@ import {
42
42
  */
43
43
  export interface ListCarrierProducts200ResponseInner {
44
44
  /**
45
- * Display name of the shipping product
45
+ * Display name of the carrier product
46
46
  * @type {string}
47
47
  * @memberof ListCarrierProducts200ResponseInner
48
48
  */
@@ -60,13 +60,13 @@ export interface ListCarrierProducts200ResponseInner {
60
60
  */
61
61
  type: ListCarrierProducts200ResponseInnerTypeEnum;
62
62
  /**
63
- * Description of the shipping product
63
+ * Description of the carrier product
64
64
  * @type {string}
65
65
  * @memberof ListCarrierProducts200ResponseInner
66
66
  */
67
67
  description?: string;
68
68
  /**
69
- * Recipient countries supported by this product
69
+ * Receiver countries this product delivers to
70
70
  * @type {Array<string>}
71
71
  * @memberof ListCarrierProducts200ResponseInner
72
72
  */
@@ -78,7 +78,7 @@ export interface ListCarrierProducts200ResponseInner {
78
78
  */
79
79
  availableSenderCountries: Array<string>;
80
80
  /**
81
- * Whether delivery is to a service point/pickup location
81
+ * Whether this product delivers to a service point
82
82
  * @type {boolean}
83
83
  * @memberof ListCarrierProducts200ResponseInner
84
84
  */
@@ -52,7 +52,7 @@ export interface ListOrderChannels200ResponseDataInner {
52
52
  */
53
53
  enabled: boolean;
54
54
  /**
55
- * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform.
55
+ * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform.
56
56
  * @type {ListOrderChannels200ResponseDataInnerRoleEnum}
57
57
  * @memberof ListOrderChannels200ResponseDataInner
58
58
  */