/** * This file was auto-generated by openapi-typescript and ts-morph. * Do not make direct changes to the file. */ export interface paths { readonly "/shipping/zones": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path?: never; readonly cookie?: never; }; /** * Get All Shipping Zones * @description Returns a list of all *Shipping Zones*. */ readonly get: operations["getShippingZones"]; /** * Create a Shipping Zone * @description Creates a *Shipping Zone*. */ readonly post: operations["createShippingZones"]; }; readonly "/shipping/zones/{id}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly id: number; }; readonly cookie?: never; }; /** * Get a Shipping Zone * @description Returns a single *Shipping Zone*. */ readonly get: operations["getShippingZone"]; /** * Update a Shipping Zone * @description Updates a *Shipping Zone*. * * **Required Fields** * * name * * **Read Only Fields** * * id */ readonly put: operations["updateShippingZone"]; /** * Delete a Shipping Zone * @description Deletes a *Shipping Zone*. */ readonly delete: operations["deleteShippingZone"]; }; readonly "/shipping/zones/{zone_id}/methods": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly zone_id: number; }; readonly cookie?: never; }; /** * Get All Shipping Methods in a Zone * @description Returns a list of *Shipping Methods* in a zone. Default sorting is by shipping method ID, from lowest to highest. */ readonly get: operations["getShippingZoneMethods"]; /** * Create a Shipping Method * @description Creates a *Shipping Method* within a shipping zone. Real Time Carrier Connections are also supported by this endpoint. * * ## Carrier Configurations – Current * * This section provides a sample request and a carrier-specific object/property model, for each supported carrier. * * ### USPS by Endicia * * Example request body: * * ```json * { * "name": "USPS by Endicia", * "type": "endicia", * "settings": { * "carrier_options": { * "delivery_services" : ["PriorityExpress","Priority", "PriorityMailExpressInternational"], * "packaging_type" : "LargeFlatRateBox", * "show_transit_time" : true * } * }, * "enabled": true * } * ``` * * #### USPS by Endicia Object Properties * * | Property | Type | Values | * | - | - | - | * | delivery_services | array | PriorityExpress, PriorityMailExpressInternational, FirstClassPackageInternationalService, Priority, PriorityMailInternational, First, ParcelSelect, MediaMail | * | packaging_type | array | FlatRateLegalEnvelope, FlatRatePaddedEnvelope, Parcel, SmallFlatRateBox, MediumFlatRateBox, LargeFlatRateBox, FlatRateEnvelope, RegionalRateBoxA, RegionalRateBoxB | * |show_transit_time | boolean | true, false | * * ### FedEx * * Example request body: * * ```json * { * "name": "FEDEX", * "type": "fedex", * "settings": { * "carrier_options": { * "delivery_services": [ * "PRIORITY_OVERNIGHT", * "FEDEX_2_DAY" * ], * "dropoff_type": "REGULAR_PICKUP", * "packaging_type": "FEDEX_ENVELOPE", * "packing_method": "SEPARATE", * "rate_type": "NONE", * "include_package_value": true, * "destination_type": "residential" * } * }, * "enabled": true * } * * ``` * * #### FedEx Object Properties * * | Property | Type | Values | * | - | - | - | * | delivery_services | array | PRIORITY_OVERNIGHT, STANDARD_OVERNIGHT, FIRST_OVERNIGHT, FEDEX_2_DAY, FEDEX_EXPRESS_SAVER, INTERNATIONAL_PRIORITY, INTERNATIONAL_ECONOMY, INTERNATIONAL_FIRST, FEDEX_1_DAY_FREIGHT, FEDEX_2_DAY_FREIGHT, FEDEX_3_DAY_FREIGHT, FEDEX_GROUND, GROUND_HOME_DELIVERY, INTERNATIONAL_PRIORITY_FREIGHT, INTERNATIONAL_ECONOMY_FREIGHT, EUROPE_FIRST_INTERNATIONAL_PRIORITY | * | dropoff_type | string | REGULAR_PICKUP, REQUEST_COURIER, DROP_BOX, BUSINESS_SERVICE_CENTER, STATION | * | packaging_type | string | FEDEX_ENVELOPE, FEDEX_PAK, FEDEX_BOX, FEDEX_TUBE, FEDEX_10KG_BOX, FEDEX_25KG_BOX, YOUR_PACKAGING | * | packing_method | string | SEPARATE, COMBINED | * | rate_type | string | NONE, LIST | * | include_package_value | boolean | true, false | * | destination_type | string | residential, business | * * * ### UPS Ready * * Example request body: * * ```json * { * "name": "UPS ready", * "type": "upsready", * "settings": { * "carrier_options": { * "delivery_services": [ * "2nd_Day_Air","Standard" * ], * "packaging_type": "21", * "packing_method": "separate", * "include_package_value": true, * "destination_type": "residential", * "show_transit_time" : true * } * }, * "enabled": true * } * * ``` * * #### UPS Ready Object Properties * * | Property | Type | Values | * | - | - | - | * | delivery_services | array | 2nd_Day_Air, 2nd_Day_Air_AM, 3_Day_Select, Expedited, Express, Express_Plus, Express_Saver, Express_Early_AM, Ground, Next_Day_Air, Next_Day_Air_Early_AM, Next_Day_Air_Saver, Saver, Standard, Today_Dedicated_Courier, Today_Express, Today_Express_Saver, Today_Intercity, Today_Standard, Worldwide_Expedited, Worldwide_Express, Worldwide_Express_Plus, Worldwide_Express_Saver, Worldwide_Saver | * | destination_type | string | residential, business | * | packing_method | string | separate, combined | * | packaging_type | string (only codes allowed) | See the following table | * | include_package_value | boolean | true, false | * | show_transit_time | boolean | true, false | * * UPS `packaging_type` values include: * * | Code | Description | * |:----:|:------------| * | 21 | UPS® Express Box | * | 24 | UPS® 25 KG Box | * | 25 | UPS® 10 KG Box | * | 30 | Pallet | * | 01 | UPS® Letter | * | 02 | Customer Supplied Package | * | 03 | Tube | * | 04 | PAK | * | 2a | Small Express Box | * | 2b | Medium Express Box | * | 2c | Large Express Box | * * * ### Canada Post * * Example request body: * * ```json * { * "name": "Canada Post", * "type": "canadapost", * "settings": { * "carrier_options": { * "delivery_services": [ * "DOM.RP","DOM.EP" * ] * } * }, * "enabled": true * } * * ``` * * #### Canada Post Object Properties * * | Property | Type | Values | * | - | - | - | * | delivery_services | array | DOM.RP, DOM.EP, DOM.XP, DOM.XP.CERT, DOM.PC DOM.LIB, USA.EP, USA.PW.ENV, USA.PW.PAK, USA.PW.PARCEL, USA.SP.AIR, USA.TP, USA.TP.LVM, USA.XP, INT.XP, INT.IP.AIR, INT.IP.SURF, INT.PW.ENV, INT.PW.PAK, INT.PW.PARCEL, INT.SP.AIR, INT.SP.SURF, INT.TP | * * ### Australia Post * * Example request body: * * ```json * { * "name": "Australia Post", * "type": "auspost", * "settings": { * "carrier_options": { * "delivery_services": [ * "AUS_PARCEL_REGULAR", * "AUS_PARCEL_EXPRESS" * ] * } * }, * "enabled": true * } * * ``` * * #### Australia Post Object Properties * * | Property | Type | Values | * | - | - | - | * | delivery_services | array | AUS_LETTER_REGULAR_SMALL, AUS_LETTER_REGULAR_Large, AUS_LETTER_EXPRESS_SMALL, AUS_LETTER_EXPRESS_MEDIUM, AUS_LETTER_EXPRESS_LARGE, AUS_PARCEL_REGULAR, AUS_PARCEL_REGULAR_SATCHEL_500G, AUS_PARCEL_REGULAR_SATCHEL_3KG, AUS_PARCEL_REGULAR_SATCHEL_5KG, AUS_PARCEL_EXPRESS, AUS_PARCEL_EXPRESS_SATCHEL_500G, AUS_PARCEL_EXPRESS_SATCHEL_3KG, AUS_PARCEL_EXPRESS_SATCHEL_5KG, AUS_PARCEL_COURIER, AUS_PARCEL_COURIER_SATCHEL_MEDIUM, INT_PARCEL_COR_OWN_PACKAGING, INT_PARCEL_EXP_OWN_PACKAGING, INT_PARCEL_STD_OWN_PACKAGING, INT_PARCEL_AIR_OWN_PACKAGING, INT_PARCEL_SEA_OWN_PACKAGING | * * ### Royal Mail * * Example request body: * * ```json * { * "name": "Royal Mail", * "type": "royalmail", * "settings": { * "carrier_options": { * "delivery_services": [ * "StandardFirstClass", * "StandardSecondClass" * ] * } * }, * "enabled": true * } * ``` * * #### Royal Mail Object Properties * * | Property | Type | Values | * | - | - | - | * | delivery_services | array | SpecialDelivery1pm, SpecialDelivery9am, SpecialDelivery1pmSaturday, SpecialDelivery9amSaturday, SignedForFirstClass, SignedForSecondClass, Express9, Express10, ExpressAM, Express24, Express48, StandardFirstClass, StandardSecondClass, InternationalStandard, InternationalTracked, InternationalEconomy | * * ### Zoom2U * * Example request body: * * ```json * { * "name": "Zoom2U", * "type": "zoom2u", * "settings": { * "carrier_options": { * "delivery_services": [ * "3_hour", * "Same_day", * "VIP" * ] * } * }, * "enabled": true * } * ``` * * #### Zoom2U Object Properties * * | Property | Type | Values | * | - | - | - | * | delivery_services | array | 3_hour, Same_day, VIP| * * ### Settings Objects * * A shipping methodʼs `type` and `settings` properties can match one of the following models: * * #### perorder Object – Properties * * Object model for flat-rate shipping quotes per order. * * | Property | Type | Description | * | - | - | - | * | rate | number | Flat rate per order. | * * Example request body: * * ```json * { * "name": "Flat Rate per Order", * "type": "perorder", * "settings": { * "rate": 7 * } * } * ``` * * #### peritem Object – Properties * * Object model for flat-rate shipping quotes per item ordered. * * | Name | Type | Description | * |:-----|:-----|:------------| * | rate | number | Flat rate per item. | * * Example request body: * * ```json * { * "name": "Flat Rate per Item", * "type": "peritem", * "settings": { * "rate": 8 * } * } * ``` * * #### weight Object – Properties * * Object model for shipping quotes by weight. * * | Property | Type | Description | * | - | - | - | * | default_cost | number | null | Default shipping cost, applied either as a percentage of the orderʼs total value or as a fixed amount. If default cost is not required, you can supply a value of null. | * | default_cost_type | string | How the default shipping cost is calculated; either `percentage_of_total` or `fixed_amount`. | * | range | number | Array of [range](#range-object--properties) objects. The units for these ranges' `lower_limit` and `upper_limit` properties depend on the default units set in the storeʼs control panel. | * * Example request body: * * ```json * { * "name": "Rate per Weight", * "type": "weight", * "settings": { * "default_cost": 12, * "default_cost_type": "fixed_amount", * "range": [ * { * "lower_limit": 0, * "upper_limit": 20, * "shipping_cost": 8 * }, * { * "lower_limit": 20, * "upper_limit": 40, * "shipping_cost": 12 * } * ] * } * } * ``` * * #### total Object – Properties * * Object model for shipping quotes by orderʼs total value. * * | Property | Type | Description | * | - | - | - | * | default_cost | number | null | Default shipping cost, applied either as a percentage of the orderʼs total value or as a fixed amount. If default cost is not required, you can supply a value of null. | * | default_cost_type | string | How the default shipping cost is calculated; either `percentage_of_total` or `fixed_amount`. | * | range | number | Array of [range](#range-object--properties) objects. The units for these ranges' `lower_limit` and `upper_limit` properties are values in the storeʼs currency. | * * Example request body: * * This example sets free shipping above a certain order total: * * ```json * { * "name": "Per Total or Free", * "type": "total", * "settings": { * "default_cost": 12, * "default_cost_type": "fixed_amount", * "range": [ * { * "lower_limit": 0, * "upper_limit": 5, * "shipping_cost": 5 * }, * { * "lower_limit": 5, * "upper_limit": 10, * "shipping_cost": 8 * }, * { * "lower_limit": 10, * "upper_limit": 20, * "shipping_cost": 10 * }, * { * "lower_limit": 20, * "upper_limit": 49.99, * "shipping_cost": 15 * }, * { * "lower_limit": 50, * "upper_limit": 100000, * "shipping_cost": 0 * } * ] * } * } * ``` * * #### Range Object – Properties * * Object model to define ranges for shipping quotes. Units are defined in the parent object. * * | Property | Type | Description | * | - | - | - | * | lower_limit | number | Lower limit for order total. | * | upper_limit | number | Upper limit for order total. | * | shipping_cost | number | Shipping cost for orders whose total falls between the lower and upper limits. | * * * Example request body: * * ```json * { * "lower_limit": 0, * "upper_limit": 20, * "shipping_cost": 8 * } * ``` * * ### Channels * * Example request body: * * ```json * { * "name": "Method associated to channels 1, 3", * "type": "peritem", * "settings": { * "rate": 5 * }, * "channel_ids": [1, 3] * } * ``` * * | Property | Type | Description | * | - | - | - | * | channel_ids | array | Channels associated with the method as an array of integers. | */ readonly post: operations["createShippingMethod"]; }; readonly "/shipping/zones/{zone_id}/methods/{method_id}": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly zone_id: number; /** @description ID of the shipping method within the shipping zone. */ readonly method_id: number; }; readonly cookie?: never; }; /** * Get a Shipping Method * @description Returns a single *Shipping Method* in a zone. Real Time Carrier Connections are also supported by this endpoint. * * ### Settings Objects * * A shipping methodʼs `type` and `settings` properties can match one of the following models: * * ### perorder Object – Properties * * Object model for flat-rate shipping quotes per order. * * | Name | Type | Description | * | - | - | - | * | rate | number | Flat rate per order. | * * #### JSON Example * * ```json * { * "name": "Flat Rate per Order", * "type": "perorder", * "settings": { * "rate": 7 * }, * "channel_ids": [1] * }, * ``` * * ### peritem Object – Properties * * Object model for flat-rate shipping quotes per item ordered. * * | Name | Type | Description | * | - | - | - | * | rate | number | Flat rate per item. | * * #### JSON Example * * ```json * { * "name": "Flat Rate per Item", * "type": "peritem", * "settings": { * "rate": 8 * }, * "channel_ids": [1] * }, * ``` * * ### weight Object – Properties * * Object model for shipping quotes by weight. * * | Name | Type | Description | * | - | - | - | * | default_cost | number | null | Default shipping cost, applied either as a percentage of the orderʼs total value or as a fixed amount. If default cost is not required, you can supply a value of null. | * | default_cost_type | string | How the default shipping cost is calculated; either `percentage_of_total` or `fixed_amount`. | * | range | number | Array of [range](#range-object--properties) objects. The units for these ranges' `lower_limit` and `upper_limit` properties depend on the default units set in the storeʼs control panel. | * * * #### JSON Example * ```json * { * "name": "Rate per Weight", * "type": "weight", * "settings": { * "default_cost": 12, * "default_cost_type": "fixed_amount", * "range": [ * { * "lower_limit": 0, * "upper_limit": 20, * "shipping_cost": 8 * }, * { * "lower_limit": 20, * "upper_limit": 40, * "shipping_cost": 12 * } * ] * }, * "channel_ids": [1] * } * ``` * * ### total Object – Properties * * Object model for shipping quotes by orderʼs total value. * * | Name | Type | Description | * | - | - | - | * | default_cost | number | null | Default shipping cost, applied either as a percentage of the orderʼs total value or as a fixed amount. If default cost is not required, you can supply a value of null. | * | default_cost_type | string | How the default shipping cost is calculated; either `percentage_of_total` or `fixed_amount`. | * | range | number | Array of [range](#range-object--properties) objects. The units for these ranges' `lower_limit` and `upper_limit` properties are values in the storeʼs currency. | * * #### JSON Example * * This example sets free shipping above a certain order total: * * ```json * { * "name": "Per Total or Free", * "type": "total", * "settings": { * "default_cost": 12, * "default_cost_type": "fixed_amount", * "range": [ * { * "lower_limit": 0, * "upper_limit": 5, * "shipping_cost": 5 * }, * { * "lower_limit": 5, * "upper_limit": 10, * "shipping_cost": 8 * }, * { * "lower_limit": 10, * "upper_limit": 20, * "shipping_cost": 10 * }, * { * "lower_limit": 20, * "upper_limit": 49.99, * "shipping_cost": 15 * }, * { * "lower_limit": 50, * "upper_limit": 100000, * "shipping_cost": 0 * } * ] * }, * "channel_ids": [1] * } * ``` * * ### Range Object – Properties * * Object model to define ranges for shipping quotes. Units are defined in the parent object. * * | Property | Type | Description | * | - | - | - | * | lower_limit | number | Lower limit for order total. | * | upper_limit | number | Upper limit for order total. | * | shipping_cost | number | Shipping cost for orders whose total falls between the lower and upper limits. | * * #### JSON Example * * ```json * { * "lower_limit": 0, * "upper_limit": 20, * "shipping_cost": 8 * } * ``` * * ### Channels * * Example request body: * * ```json * { * "name": "Method associated to channels 1, 3", * "type": "peritem", * "settings": { * "rate": 5 * }, * "channel_ids": [1, 3] * } * ``` * * | Property | Type | Description | * | - | - | - | * | channel_ids | array | Channels associated with the method as an array of integers. | */ readonly get: operations["getShippingMethod"]; /** * Update a Shipping Method * @description Updates a *Shipping Method* in a zone. Real Time Carrier Connections are also supported by this endpoint. * * **Read Only Fields** * * id * * ### Settings Objects * * A shipping methodʼs `type` and `settings` properties can match one of the following models: * * #### perorder Object – Properties * * Object model for flat-rate shipping quotes per order. * * | Property | Type | Description | * | - | - | - | * | rate | number | Flat rate per order. | * * Example response: * * ```json * { * "name": "Flat Rate per Order", * "type": "perorder", * "settings": { * "rate": 7 * } * }, * ``` * * #### peritem Object – Properties * * Object model for flat-rate shipping quotes per item ordered. * * | Property | Type | Description | * | - | - | - | * | rate | number | Flat rate per item. | * * Example response: * * ```json * { * "name": "Flat Rate per Item", * "type": "peritem", * "settings": { * "rate": 8 * } * }, * ``` * * #### weight Object – Properties * * Object model for shipping quotes by weight. * * | Property | Type | Description | * | - | - | - | * | default_cost | number | null | Default shipping cost, applied either as a percentage of the orderʼs total value or as a fixed amount. If default cost is not required, you can supply a value of null. | * | default_cost_type | string | How the default shipping cost is calculated; either `percentage_of_total` or `fixed_amount`. | * | range | number | Array of [range](#range-object--properties) objects. The units for these ranges' `lower_limit` and `upper_limit` properties depend on the default units set in the storeʼs control panel. | * * * Example response: * * ```json * { * "name": "Rate per Weight", * "type": "weight", * "settings": { * "default_cost": 12, * "default_cost_type": "fixed_amount", * "range": [ * { * "lower_limit": 0, * "upper_limit": 20, * "shipping_cost": 8 * }, * { * "lower_limit": 20, * "upper_limit": 40, * "shipping_cost": 12 * } * ] * } * } * ``` * * #### total Object – Properties * * Object model for shipping quotes by orderʼs total value. * * | Property | Type | Description | * | - | - | - | * | default_cost | number | null | Default shipping cost, applied either as a percentage of the orderʼs total value or as a fixed amount. If default cost is not required, you can supply a value of null. | * | default_cost_type | string | How the default shipping cost is calculated; either `percentage_of_total` or `fixed_amount`. | * | range | number | Array of [range](#range-object--properties) objects. The units for these ranges' `lower_limit` and `upper_limit` properties are values in the storeʼs currency. | * * Example response: * * This example sets free shipping above a certain order total: * * ```json * { * "name": "Per Total or Free", * "type": "total", * "settings": { * "default_cost": 12, * "default_cost_type": "fixed_amount", * "range": [ * { * "lower_limit": 0, * "upper_limit": 5, * "shipping_cost": 5 * }, * { * "lower_limit": 5, * "upper_limit": 10, * "shipping_cost": 8 * }, * { * "lower_limit": 10, * "upper_limit": 20, * "shipping_cost": 10 * }, * { * "lower_limit": 20, * "upper_limit": 49.99, * "shipping_cost": 15 * }, * { * "lower_limit": 50, * "upper_limit": 100000, * "shipping_cost": 0 * } * ] * } * } * ``` * * #### Range Object – Properties * * Object model to define ranges for shipping quotes. Units are defined in the parent object. * * | Property | Type | Description | * | - | - | - | * | lower_limit | number | Lower limit for order total. | * | upper_limit | number | Upper limit for order total. | * | shipping_cost | number | Shipping cost for orders whose total falls between the lower and upper limits. | * * Example response: * * ```json * { * "lower_limit": 0, * "upper_limit": 20, * "shipping_cost": 8 * } * ``` * ### Channels * * Example request body: * * ```json * { * "name": "Method associated to channels 1, 3", * "type": "peritem", * "settings": { * "rate": 5 * }, * "channel_ids": [1, 3] * } * ``` * * | Property | Type | Description | * | - | - | - | * | channel_ids | array | Channels associated with the method as an array of integers. | */ readonly put: operations["updateShippingMethod"]; /** * Delete a Shipping Method * @description Deletes an *Shipping Method*. Real Time Carrier Connections can also be deleted. */ readonly delete: operations["deleteShippingMethod"]; }; readonly "/shipping/carrier/connection": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; }; readonly path?: never; readonly cookie?: never; }; /** * Update a Carrier Connection * @description Updates a *Carrier Connection*. * * Updating the carrier connection is done using the same information as creating the connection. This endpoint can be used to update credentials. */ readonly put: operations["updateCarrierConnection"]; /** * Create a Carrier Connection * @description Creates a *Carrier Connection*. * * Carrier connections refer to specific settings required to connect to a specific shipping carrier. Each carrier requires your app to supply a unique set of properties/fields to establish a connection with that carrier. * * *Notes:* * * - There is no `GET` with this resource. It has `PUT`, `POST` and `DELETE`. * * `PUT` is used to update. The connection can be updated by API. * * - Connections created here do not enable the shipping method. To enable the carrier for a shipping zone, use the Shipping Methods API. * * - The Carrier Connection resource returns a 204 for both successful and unsuccessful attempts to connect. If a field is missing, it will return a 400. * * ### Australia Post * * PUT or POST example request: * * ```json * { * "carrier_id" : "auspost", * "connection" : { * "auth_key" : "yourAusPostAuthKey", * "test_mode" : false * } * } * ``` * * DELETE example request: * * ```json * { * "carrier_id" : "auspost" * } * ``` * * #### Australia Post Connection Object – Properties * * Australia Post `PUT` or `POST` requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) `DELETE` requests require only a `carrier_id`. * * * | Property | Type | Description | * | - | - | - | * | auth_key | string | Australia Post authorization key. | * | test_mode | boolean | Whether or not to use Australia Post test-mode settings. Acceptable values are `true` or `false`. | * * * ### Endicia * USPS is connected through Endicia. * * PUT or POST example request: * * ```json * { "carrier_id" : "endicia", * "connection": { * "account_id" : "yourEndiciaAccountId", * "pass_phrase" : "yourEndiciaPassphrase" * } * } * ``` * * DELETE example request: * * ```json * { * "carrier_id" : "endicia" * } * ``` * * #### Endicia Connection Object – Properties * * Endicia `PUT` or `POST` requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) `DELETE` requests require only a `carrier_id`. * * * | Property | Type | Description | * | - | - | - | * | account_id | string | Endicia account ID. | * | passphrase | string | Endicia passphrase. | * * * ### FedEx * * PUT or POST example request: * * ```json * { * "carrier_id" : "fedex", * "connection" : { * "key" : "yourFedexKey", * "password" : "yourFedexPassword", * "account_number" : "yourFedexAccountNumber", * "meter_number" : "yourFedexMeterNumber" * } * } * ``` * * DELETE example request: * * ```json * { * "carrier_id" : "fedex" * } * ``` * * #### FedEx Connection Object – Properties * * FedEx `PUT` or `POST` requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) `DELETE` requests require only a `carrier_id`. * * * | Property | Type | Description | * | - | - | - | * | key | string | FedEx account ID. | * | password | string | FedEx passphrase. | * | account_number | string | FedEx account number. | * | meter_number | string | FedEx meter number. | * * ### Royal Mail * * PUT or POST example request: * * ```json * { * "carrier_id" : "royalmail", * "connection" : { * * } * } * ``` * * DELETE example request: * * ```json * { * "carrier_id" : "royalmail" * } * ``` * * #### Royal Mail Connection Object - Properties * * Royal Mail has no connection object properties. * * ### Shipping Provider API * * Please note that this endpoint is not intended for adding connection settings. * * Its purpose is solely to establish a connection between your BigCommerce store and the carrier. If the carrier has no connection settings configured, please leave the connection property empty. However, if the carrier already has connection settings configured, you can utilize this endpoint to establish the connection using the existing connection properties. * * PUT or POST example request when your carrier is not configured with any connection settings: * * ```json filename="No connection settings configured" showLineNumbers copy * { * "carrier_id" : "carrier_{your_carrier_id}", * "connection" : {} * } * ``` * * PUT or POST example request when your carrier is configured with connection settings: * * ```json filename="Connection settings configured" showLineNumbers copy * { * "carrier_id" : "carrier_{your_carrier_id}", * "connection" : { * "your_configured_key_1": "value_1", * "your_configured_key_2": "value_2 * } * } * ``` * * ### Zoom2U * * PUT or POST example request: * * ```json * { * "carrier_id" : "zoom2u", * "connection" : { * "auth_key" : "yourZoom2uAuthKey", * "test_mode" : false * } * } * ``` * * DELETE example request: * * ```json * { * "carrier_id" : "zoom2u" * } * ``` * * #### Zoom2U Connection Object – Properties * * Zoom2U `PUT` or `POST` requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) `DELETE` requests require only a `carrier_id`. * * * | Property | Type | Description | * | - | - | - | * | auth_key | string | Zoom2U authorization key. | * | test_mode | boolean | Whether or not to use Zoom2U test-mode settings. Acceptable values are `true` or `false`. | */ readonly post: operations["createCarrierConnection"]; /** * Delete a Carrier Connection * @description Deletes a *Carrier Connection*. * * **Required Fields** * * carrier_id */ readonly delete: operations["deleteCarrierConnection"]; }; } export type webhooks = Record; export interface components { schemas: { /** * Tracking Carrier * @example auspost * @enum {string} */ readonly TrackingCarrier: "auspost" | "canadapost" | "endicia" | "usps" | "fedex" | "royalmail" | "ups" | "upsready" | "shipperhq"; /** * Shipping Provider * @example endicia * @enum {string} */ readonly ShippingProvider: "fedex" | "auspost" | "canadapost" | "endicia" | "usps" | "royalmail" | "ups" | "upsready" | "upsonline" | "shipperhq"; /** Shipping Zone */ readonly ShippingZone: { /** * @description Zone ID. Read-only. * @example 1 */ readonly id?: number; /** * @description Zone name. Required for PUT requests. * @example United States */ readonly name: string; /** @enum {string} */ readonly type?: "zip" | "country" | "state" | "global"; /** @description Array of zone locations. */ readonly locations?: readonly { /** * @description Location’s ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }[]; readonly free_shipping?: { readonly enabled?: boolean; /** * @description (Float, Float-As-String, Integer) * @example 0.0000 */ readonly minimum_sub_total?: string; readonly exclude_fixed_shipping_products?: boolean; }; /** Shipping Zone Handling Fees */ readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** * @description Whether this shipping zone is enabled. * @example true */ readonly enabled?: boolean; }; /** Shipping Zone Locations */ readonly ShippingZoneLocations: { /** * @description Location’s ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }; /** Shipping Zone Handling Fees */ readonly HandlingFees: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** shippingMethod_Full */ readonly shippingMethod_Full: { /** * @description Shipping method ID. Read-only. * @example 1 */ readonly id?: number; } & components["schemas"]["shippingMethod_Base"]; /** * Shipping Method Type * @example perorder * @enum {string} */ readonly ShippingMethodType: "perorder" | "peritem" | "weight" | "total" | "auspost" | "canadapost" | "endicia" | "usps" | "fedex" | "royalmail" | "upsready" | "freeshipping"; /** shippingMethod_Base */ readonly shippingMethod_Base: { /** * @description Display name for shipping method. * @example Flat Rate */ readonly name?: string; readonly type?: components["schemas"]["ShippingMethodType"]; /** @description Depends on the shipping method type. See the [supported settings object](#settings-objects). */ readonly settings?: { /** * @description Flat rate per order. * @example 7 */ readonly rate?: number; }; /** * @description Whether or not this shipping zone method is enabled. * @example true */ readonly enabled?: boolean; readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: number; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 0 */ readonly percentage_surcharge?: number; }; /** * @description Whether or not this shipping method is a fallback method used when advanced shipping rules are unavailable. * @example false */ readonly is_fallback?: boolean; /** * @description List of channels associated to a method. When creating a new method, all available channels are associated by default. (Optional) * @example [ * 1, * 3 * ] */ readonly channel_ids?: readonly number[]; }; /** ShippingResponse */ readonly ShippingResponse: Record; /** Carrier Connection */ readonly carrierConnection: { readonly carrier_id?: string; /** @description The `connection` object varies by carrier. */ readonly connection?: { readonly [key: string]: unknown; }; }; /** * metaCollection * @description Meta data relating to pagination. */ readonly metaCollection: { readonly pagination?: { /** * @description Total number of items returned. * @example 3 */ readonly total?: number; /** * @description Number of items returned on per page. * @example 1 */ readonly count?: number; /** * @description Number of items to be displayed per page. * @example 1 */ readonly per_page?: number; /** * @description Current page number. * @example 2 */ readonly current_page?: number; /** * @description Total number of pages. * @example 3 */ readonly total_page?: number; readonly links?: { /** * @description Query string appended to the resource to return to the previous page. * @example ?limit=1&page=1 */ readonly previous?: string; /** * @description Query string appended to the resource to proceed to the next page. * @example ?limit=1&page=3 */ readonly next?: string; /** * @description Query string appended to the resource to show the current page. * @example ?limit=1&page=2 */ readonly current?: string; }; }; }; }; responses: never; parameters: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { readonly getShippingZones: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": readonly { /** * @description Zone ID * @example 1 */ readonly id?: number; /** * @description Zone name. Required for PUT requests. * @example United States */ readonly name?: string; /** @enum {string} */ readonly type?: "zip" | "country" | "state" | "global"; /** @description Array of zone locations. */ readonly locations?: readonly { /** * @description Location’s ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }[]; readonly free_shipping?: { readonly enabled?: boolean; /** * @description (Float, Float-As-String, Integer) * @example 0.0000 */ readonly minimum_sub_total?: string; readonly exclude_fixed_shipping_products?: boolean; }; /** Shipping Zone Handling Fees */ readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** * @description Whether this shipping zone is enabled. * @example true */ readonly enabled?: boolean; }[]; }; }; }; }; readonly createShippingZones: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: { readonly content: { readonly "application/json": { /** * @description Zone name. Required for PUT requests. * @example United States */ readonly name: string; /** @enum {string} */ readonly type: "zip" | "country" | "state" | "global"; /** @description Array of zone locations. BigCommerce has a platform limit of 40000 `zip` type locations. */ readonly locations?: readonly { /** * @description Location’s ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }[]; readonly free_shipping?: { readonly enabled?: boolean; /** * @description (Float, Float-As-String, Integer) * @example 0.0000 */ readonly minimum_sub_total?: string; readonly exclude_fixed_shipping_products?: boolean; }; /** Shipping Zone Handling Fees */ readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** * @description Whether this shipping zone is enabled. * @example true */ readonly enabled?: boolean; }; }; }; readonly responses: { readonly 201: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { /** * @description Zone ID. * @example 1 */ readonly id?: number; /** * @description Zone name. * @example United States */ readonly name?: string; /** @enum {string} */ readonly type?: "zip" | "country" | "state" | "global"; /** @description Array of zone locations. */ readonly locations?: readonly { /** * @description Location ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }[]; readonly free_shipping?: { readonly enabled?: boolean; /** * @description (Float, Float-As-String, Integer) * @example 0.0000 */ readonly minimum_sub_total?: string; readonly exclude_fixed_shipping_products?: boolean; }; /** Shipping Zone Handling Fees */ readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** * @description Whether this shipping zone is enabled. * @example true */ readonly enabled?: boolean; }; }; }; }; }; readonly getShippingZone: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly id: number; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { /** * @description Zone ID * @example 1 */ readonly id?: number; /** * @description Zone name. * @example United States */ readonly name?: string; /** @enum {string} */ readonly type?: "zip" | "country" | "state" | "global"; /** @description Array of zone locations. */ readonly locations?: readonly { /** * @description Location’s ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }[]; readonly free_shipping?: { readonly enabled?: boolean; /** * @description (Float, Float-As-String, Integer) * @example 0.0000 */ readonly minimum_sub_total?: string; readonly exclude_fixed_shipping_products?: boolean; }; /** Shipping Zone Handling Fees */ readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** * @description Whether this shipping zone is enabled. * @example true */ readonly enabled?: boolean; }; }; }; }; }; readonly updateShippingZone: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly id: number; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { readonly "application/json": { /** * @description Zone ID. Read-only. * @example 1 */ readonly id?: number; /** * @description Zone name. Required for PUT requests. * @example United States */ readonly name: string; /** @enum {string} */ readonly type?: "zip" | "country" | "state" | "global"; /** @description Array of zone locations. BigCommerce has a platform limit of 40000 `zip` type locations. */ readonly locations?: readonly { /** * @description Location’s ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }[]; readonly free_shipping?: { readonly enabled?: boolean; /** * @description (Float, Float-As-String, Integer) * @example 0.0000 */ readonly minimum_sub_total?: string; readonly exclude_fixed_shipping_products?: boolean; }; /** Shipping Zone Handling Fees */ readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** * @description Whether this shipping zone is enabled. * @example true */ readonly enabled?: boolean; }; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { /** * @description Zone ID. Read-only. * @example 1 */ readonly id?: number; /** * @description Zone name. Required for PUT requests. * @example United States */ readonly name: string; /** @enum {string} */ readonly type?: "zip" | "country" | "state" | "global"; /** @description Array of zone locations. */ readonly locations?: readonly { /** * @description Location’s ID. * @example 3 */ readonly id?: number; /** * @description Location’s ZIP/postal code. * @example 12345 */ readonly zip?: string; /** * @description 2-letter ISO Alpha-2 code for the country. * @example US */ readonly country_iso2?: string; /** * @description ISO Alpha-2 code for the state. * @example TX */ readonly state_iso2?: string; }[]; readonly free_shipping?: { readonly enabled?: boolean; /** * @description (Float, Float-As-String, Integer) * @example 0.0000 */ readonly minimum_sub_total?: string; readonly exclude_fixed_shipping_products?: boolean; }; /** Shipping Zone Handling Fees */ readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 5 */ readonly percentage_surcharge?: string; /** * @description Indicates whether store displays handling fee separately at checkout. * @example true */ readonly display_separately?: boolean; }; /** * @description Whether this shipping zone is enabled. * @example true */ readonly enabled?: boolean; }; }; }; }; }; readonly deleteShippingZone: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly id: number; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; readonly getShippingZoneMethods: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly zone_id: number; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": readonly components["schemas"]["shippingMethod_Full"][]; }; }; }; }; readonly createShippingMethod: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly zone_id: number; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { /** @example { * "name": "Per Order", * "type": "perorder", * "settings": { * "rate": 8 * }, * "enabled": true, * "handling_fees": { * "fixed_surcharge": "3" * }, * "channel_ids": [ * 1 * ] * } */ readonly "application/json": components["schemas"]["shippingMethod_Base"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": components["schemas"]["shippingMethod_Full"]; }; }; }; }; readonly getShippingMethod: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly zone_id: number; /** @description ID of the shipping method within the shipping zone. */ readonly method_id: number; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": { /** * @description Shipping method ID. Read-only. * @example 1 */ readonly id?: number; /** * @description Display name for shipping method. * @example Flat Rate */ readonly name?: string; readonly type?: components["schemas"]["ShippingMethodType"]; /** @description Depends on the shipping method type. See the [supported settings object](#settings-objects). */ readonly settings?: { readonly [key: string]: unknown; }; /** * @description Whether or not this shipping zone method is enabled. * @example true */ readonly enabled?: boolean; readonly handling_fees?: { /** * @description Flat-rate handling fee applied to shipping cost. * @example 0 */ readonly fixed_surcharge?: number; } | { /** * @description Percentage handling fee applied to shipping cost. * @example 0 */ readonly percentage_surcharge?: number; }; /** * @description Whether or not this shipping zone is the fallback if all others are not valid for the order. * @example false */ readonly is_fallback?: boolean; /** * @description List of channels associated to a method. When creating a new method, all available channels are associated by default. (Optional) * @example [ * 1, * 3 * ] */ readonly channel_ids?: readonly number[]; }; }; }; }; }; readonly updateShippingMethod: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly zone_id: number; /** @description ID of the shipping method within the shipping zone. */ readonly method_id: number; }; readonly cookie?: never; }; readonly requestBody: { readonly content: { /** @example { * "settings": { * "rate": 11 * }, * "handling_fees": { * "fixed_surcharge": "0" * }, * "channel_ids": [ * 2, * 3 * ] * } */ readonly "application/json": components["schemas"]["shippingMethod_Base"]; }; }; readonly responses: { readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": components["schemas"]["shippingMethod_Full"]; }; }; }; }; readonly deleteShippingMethod: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path: { /** @description ID of the shipping zone. */ readonly zone_id: number; /** @description ID of the shipping method within the shipping zone. */ readonly method_id: number; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; readonly updateCarrierConnection: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path?: never; readonly cookie?: never; }; /** @description The request body will vary by carrier. See [Create a Carrier Connection](/docs/rest-management/shipping-v2/shipping-carrier#create-a-carrier-connection). */ readonly requestBody?: { readonly content: { /** @example { * "carrier_id": "endicia", * "connection": { * "account_id": "yourEndiciaAccountId", * "pass_phrase": "yourEndiciaPassphrase" * } * } */ readonly "application/json": components["schemas"]["carrierConnection"]; }; }; readonly responses: { /** @description Returns if request was successful. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; /** @description If a required field is not provided, the request will return a 400 response. * * [ * { * "status": 400, * "message": "Required fields missing [key]" * } * ] */ readonly 400: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": unknown; }; }; }; }; readonly createCarrierConnection: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path?: never; readonly cookie?: never; }; readonly requestBody?: { readonly content: { /** @example { * "carrier_id": "auspost", * "connection": { * "auth_key": "yourAusPostAuthKey", * "test_mode": false * } * } */ readonly "application/json": components["schemas"]["carrierConnection"]; }; }; readonly responses: { /** @description Returns if request was successful. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; /** @description Invalid requests will return a 400 response. * * [ * { * "status": 400, * "message": "The field 'id' cannot be written to. Please remove it from your request before trying again." * } * ] * * If a required field is not provided, the request will return a 400 response. * * [ * { * "status": 400, * "message": "Required fields missing [key]" * } * ] * */ readonly 400: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": unknown; }; }; }; }; readonly deleteCarrierConnection: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; }; readonly path?: never; readonly cookie?: never; }; readonly requestBody: { readonly content: { /** @example { * "carrier_id": "fedex" * } */ readonly "application/json": { /** @example fedex */ readonly carrier_id?: string; }; }; }; readonly responses: { /** @description Returns if request was successful. */ readonly 204: { headers: { readonly [name: string]: unknown; }; content?: never; }; /** @description If a required field is not provided, the request will return a 400 response. * * [ * { * "status": 400, * "message": "Required fields missing [key]" * } * ] */ readonly 400: { headers: { readonly [name: string]: unknown; }; content: { readonly "application/json": unknown; }; }; }; }; }