From 8ef37f508ed313ae0cf3081b8a12d0624b75e42c Mon Sep 17 00:00:00 2001 From: Dan Kobina Date: Fri, 18 Sep 2020 13:11:18 -0400 Subject: [PATCH] update generated client and fix links to API guides plus added back models docs --- README.md | 35 ++- docs/Address.md | 24 ++ docs/AddressData.md | 23 ++ docs/Card.md | 16 ++ docs/CarrierSettings.md | 13 + docs/Charge.md | 12 + docs/Commodity.md | 24 ++ docs/Customs.md | 18 ++ docs/CustomsData.md | 17 ++ docs/Doc.md | 12 + docs/ErrorResponse.md | 10 + docs/Invoice.md | 13 + docs/LabelPrintingRequest.md | 11 + docs/Message.md | 14 ++ docs/Parcel.md | 21 ++ docs/ParcelData.md | 20 ++ docs/Payment.md | 16 ++ docs/PaymentData.md | 15 ++ docs/Rate.md | 22 ++ docs/RateRequest.md | 16 ++ docs/RateResponse.md | 11 + docs/References.md | 16 ++ docs/Shipment.md | 30 +++ docs/ShipmentData.md | 19 ++ docs/ShipmentPurchaseData.md | 11 + docs/ShipmentResponse.md | 11 + docs/ShippingRequest.md | 19 ++ docs/TrackingDetails.md | 13 + docs/TrackingEvent.md | 15 ++ docs/TrackingResponse.md | 11 + docs/TrackingStatus.md | 15 ++ purplship/__init__.py | 18 +- purplship/api/__init__.py | 18 +- .../api/{addresses.py => addresses_api.py} | 12 +- .../api/{carriers.py => carriers_api.py} | 2 +- purplship/api/{customs.py => customs_api.py} | 12 +- purplship/api/{parcels.py => parcels_api.py} | 12 +- purplship/api/{rates.py => rates_api.py} | 2 +- .../api/{shipments.py => shipments_api.py} | 222 +++++++++-------- .../api/{shipping.py => shipping_api.py} | 6 +- .../api/{tracking.py => tracking_api.py} | 2 +- purplship/api/utils.py | 224 ------------------ purplship/api/utils_api.py | 224 ++++++++++++++++++ purplship/models/__init__.py | 4 +- purplship/models/address.py | 2 +- purplship/models/address_data.py | 2 +- purplship/models/card.py | 2 +- purplship/models/carrier_settings.py | 2 +- purplship/models/charge.py | 2 +- purplship/models/commodity.py | 2 +- purplship/models/customs.py | 2 +- purplship/models/customs_data.py | 2 +- purplship/models/doc.py | 2 +- purplship/models/error_response.py | 2 +- purplship/models/invoice.py | 2 +- purplship/models/label_printing_request.py | 2 +- purplship/models/message.py | 2 +- purplship/models/parcel.py | 10 +- purplship/models/parcel_data.py | 10 +- purplship/models/payment.py | 2 +- purplship/models/payment_data.py | 2 +- purplship/models/rate.py | 2 +- purplship/models/rate_request.py | 10 +- purplship/models/rate_response.py | 2 +- purplship/models/references.py | 35 ++- purplship/models/shipment.py | 10 +- purplship/models/shipment_data.py | 10 +- purplship/models/shipment_purchase_data.py | 2 +- purplship/models/shipment_response.py | 2 +- purplship/models/shipping_request.py | 6 +- purplship/models/tracking_details.py | 2 +- purplship/models/tracking_event.py | 2 +- purplship/models/tracking_response.py | 2 +- .../{tracking.py => tracking_status.py} | 58 ++--- setup.py | 2 +- 75 files changed, 1032 insertions(+), 444 deletions(-) create mode 100644 docs/Address.md create mode 100644 docs/AddressData.md create mode 100644 docs/Card.md create mode 100644 docs/CarrierSettings.md create mode 100644 docs/Charge.md create mode 100644 docs/Commodity.md create mode 100644 docs/Customs.md create mode 100644 docs/CustomsData.md create mode 100644 docs/Doc.md create mode 100644 docs/ErrorResponse.md create mode 100644 docs/Invoice.md create mode 100644 docs/LabelPrintingRequest.md create mode 100644 docs/Message.md create mode 100644 docs/Parcel.md create mode 100644 docs/ParcelData.md create mode 100644 docs/Payment.md create mode 100644 docs/PaymentData.md create mode 100644 docs/Rate.md create mode 100644 docs/RateRequest.md create mode 100644 docs/RateResponse.md create mode 100644 docs/References.md create mode 100644 docs/Shipment.md create mode 100644 docs/ShipmentData.md create mode 100644 docs/ShipmentPurchaseData.md create mode 100644 docs/ShipmentResponse.md create mode 100644 docs/ShippingRequest.md create mode 100644 docs/TrackingDetails.md create mode 100644 docs/TrackingEvent.md create mode 100644 docs/TrackingResponse.md create mode 100644 docs/TrackingStatus.md rename purplship/api/{addresses.py => addresses_api.py} (96%) rename purplship/api/{carriers.py => carriers_api.py} (99%) rename purplship/api/{customs.py => customs_api.py} (96%) rename purplship/api/{parcels.py => parcels_api.py} (96%) rename purplship/api/{rates.py => rates_api.py} (99%) rename purplship/api/{shipments.py => shipments_api.py} (95%) rename purplship/api/{shipping.py => shipping_api.py} (97%) rename purplship/api/{tracking.py => tracking_api.py} (99%) delete mode 100644 purplship/api/utils.py create mode 100644 purplship/api/utils_api.py rename purplship/models/{tracking.py => tracking_status.py} (78%) diff --git a/README.md b/README.md index f479aed..6e3e2a5 100755 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Visit [purplship.com](https://purplship.com) to deploy your private cloud multi- ## Documentation -See the full [Python API docs](https://docs.purplship.com). +See the full [Python API docs](https://docs.purplship.com/#/guide). ## Requirements @@ -49,6 +49,39 @@ except ApiException as e: ``` +## Documentation For Models + +- [Address](docs/Address.md) +- [AddressData](docs/AddressData.md) +- [Card](docs/Card.md) +- [CarrierSettings](docs/CarrierSettings.md) +- [Charge](docs/Charge.md) +- [Commodity](docs/Commodity.md) +- [Customs](docs/Customs.md) +- [CustomsData](docs/CustomsData.md) +- [Doc](docs/Doc.md) +- [ErrorResponse](docs/ErrorResponse.md) +- [Invoice](docs/Invoice.md) +- [LabelPrintingRequest](docs/LabelPrintingRequest.md) +- [Message](docs/Message.md) +- [Parcel](docs/Parcel.md) +- [ParcelData](docs/ParcelData.md) +- [Payment](docs/Payment.md) +- [PaymentData](docs/PaymentData.md) +- [Rate](docs/Rate.md) +- [RateRequest](docs/RateRequest.md) +- [RateResponse](docs/RateResponse.md) +- [References](docs/References.md) +- [Shipment](docs/Shipment.md) +- [ShipmentData](docs/ShipmentData.md) +- [ShipmentPurchaseData](docs/ShipmentPurchaseData.md) +- [ShipmentResponse](docs/ShipmentResponse.md) +- [ShippingRequest](docs/ShippingRequest.md) +- [TrackingDetails](docs/TrackingDetails.md) +- [TrackingEvent](docs/TrackingEvent.md) +- [TrackingResponse](docs/TrackingResponse.md) +- [TrackingStatus](docs/TrackingStatus.md) + ## Author PurplShip Team | hello@purplship.com | [purplship.com](https://purplship.com) diff --git a/docs/Address.md b/docs/Address.md new file mode 100644 index 0000000..043981a --- /dev/null +++ b/docs/Address.md @@ -0,0 +1,24 @@ +# Address + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**postal_code** | **str** | The address postal code | [optional] +**city** | **str** | The address city. <br/> **(required to create as shipment)** | [optional] +**federal_tax_id** | **str** | The party frederal tax id | [optional] +**state_tax_id** | **str** | The party state id | [optional] +**person_name** | **str** | attention to <br/> **(required to create as shipment)** | [optional] +**company_name** | **str** | The company name if the party is a company | [optional] +**country_code** | **str** | The address country code | +**email** | **str** | The party email | [optional] +**phone_number** | **str** | The party phone number.<br/> Note that the expected format is: **1 514 0000000** Country Code | Area Code | Phone --- | --- | --- 1 | 514 | 0000000 | [optional] +**state_code** | **str** | The address state code | [optional] +**suburb** | **str** | The address suburb if known | [optional] +**residential** | **bool** | Indicate if the address is residential or commercial (enterprise) | [optional] +**address_line1** | **str** | The address line with street number <br/> **(required to create as shipment)** | [optional] +**address_line2** | **str** | The address line with suite number | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/AddressData.md b/docs/AddressData.md new file mode 100644 index 0000000..4e11830 --- /dev/null +++ b/docs/AddressData.md @@ -0,0 +1,23 @@ +# AddressData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**postal_code** | **str** | The address postal code | [optional] +**city** | **str** | The address city. <br/> **(required to create as shipment)** | [optional] +**federal_tax_id** | **str** | The party frederal tax id | [optional] +**state_tax_id** | **str** | The party state id | [optional] +**person_name** | **str** | attention to <br/> **(required to create as shipment)** | [optional] +**company_name** | **str** | The company name if the party is a company | [optional] +**country_code** | **str** | The address country code | +**email** | **str** | The party email | [optional] +**phone_number** | **str** | The party phone number.<br/> Note that the expected format is: **1 514 0000000** Country Code | Area Code | Phone --- | --- | --- 1 | 514 | 0000000 | [optional] +**state_code** | **str** | The address state code | [optional] +**suburb** | **str** | The address suburb if known | [optional] +**residential** | **bool** | Indicate if the address is residential or commercial (enterprise) | [optional] +**address_line1** | **str** | The address line with street number <br/> **(required to create as shipment)** | [optional] +**address_line2** | **str** | The address line with suite number | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Card.md b/docs/Card.md new file mode 100644 index 0000000..5114e73 --- /dev/null +++ b/docs/Card.md @@ -0,0 +1,16 @@ +# Card + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The credit card type | +**number** | **str** | The credit card number | +**expiry_month** | **str** | The credit card expiry month (MM) | +**expiry_year** | **str** | The credit card expiry year (YYYY) | +**security_code** | **str** | The credit card security code often at the back (000) | +**name** | **str** | The name inscribed on the credit card | [optional] +**postal_code** | **str** | The credit card registration address postal code | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/CarrierSettings.md b/docs/CarrierSettings.md new file mode 100644 index 0000000..0e24edf --- /dev/null +++ b/docs/CarrierSettings.md @@ -0,0 +1,13 @@ +# CarrierSettings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique address identifier | +**carrier_name** | **str** | Indicates a carrier (type) | +**carrier_id** | **str** | Indicates a specific carrier configuration name. | +**test** | **bool** | The test flag indicates whether to use a carrier configured for test. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Charge.md b/docs/Charge.md new file mode 100644 index 0000000..e790fd1 --- /dev/null +++ b/docs/Charge.md @@ -0,0 +1,12 @@ +# Charge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The charge description | [optional] +**amount** | **float** | The charge monetary value | [optional] +**currency** | **str** | The charge amount currency | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Commodity.md b/docs/Commodity.md new file mode 100644 index 0000000..67df452 --- /dev/null +++ b/docs/Commodity.md @@ -0,0 +1,24 @@ +# Commodity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**postal_code** | **str** | The address postal code | [optional] +**city** | **str** | The address city. <br/> **(required to create as shipment)** | [optional] +**federal_tax_id** | **str** | The party frederal tax id | [optional] +**state_tax_id** | **str** | The party state id | [optional] +**person_name** | **str** | attention to <br/> **(required to create as shipment)** | [optional] +**company_name** | **str** | The company name if the party is a company | [optional] +**country_code** | **str** | The address country code | +**email** | **str** | The party email | [optional] +**phone_number** | **str** | The party phone number.<br/> Note that the expected format is: **1 514 0000000** Country Code | Area Code | Phone --- | --- | --- 1 | 514 | 0000000 | [optional] +**state_code** | **str** | The address state code | [optional] +**suburb** | **str** | The address suburb if known | [optional] +**residential** | **bool** | Indicate if the address is residential or commercial (enterprise) | [optional] +**address_line1** | **str** | The address line with street number <br/> **(required to create as shipment)** | [optional] +**address_line2** | **str** | The address line with suite number | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Customs.md b/docs/Customs.md new file mode 100644 index 0000000..01296f4 --- /dev/null +++ b/docs/Customs.md @@ -0,0 +1,18 @@ +# Customs + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**no_eei** | **str** | | [optional] +**aes** | **str** | | [optional] +**description** | **str** | | [optional] +**terms_of_trade** | **str** | The customs 'term of trade' also known as 'incoterm' | [optional] +**commodities** | [**list[Commodity]**](Commodity.md) | The parcel content items | [optional] +**duty** | [**Payment**](Payment.md) | | [optional] +**invoice** | [**Invoice**](Invoice.md) | | [optional] +**commercial_invoice** | **bool** | Indicates if the shipment is commercial | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/CustomsData.md b/docs/CustomsData.md new file mode 100644 index 0000000..9690f84 --- /dev/null +++ b/docs/CustomsData.md @@ -0,0 +1,17 @@ +# CustomsData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**no_eei** | **str** | | [optional] +**aes** | **str** | | [optional] +**description** | **str** | | [optional] +**terms_of_trade** | **str** | The customs 'term of trade' also known as 'incoterm' | [optional] +**commodities** | [**list[Commodity]**](Commodity.md) | The parcel content items | [optional] +**duty** | [**Payment**](Payment.md) | | [optional] +**invoice** | [**Invoice**](Invoice.md) | | [optional] +**commercial_invoice** | **bool** | Indicates if the shipment is commercial | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Doc.md b/docs/Doc.md new file mode 100644 index 0000000..16956df --- /dev/null +++ b/docs/Doc.md @@ -0,0 +1,12 @@ +# Doc + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The document type | +**image** | **str** | encoded base64 string of the document | +**format** | **str** | The document format | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md new file mode 100644 index 0000000..fc3872b --- /dev/null +++ b/docs/ErrorResponse.md @@ -0,0 +1,10 @@ +# ErrorResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messages** | [**list[Message]**](Message.md) | The list of error messages | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Invoice.md b/docs/Invoice.md new file mode 100644 index 0000000..e2af194 --- /dev/null +++ b/docs/Invoice.md @@ -0,0 +1,13 @@ +# Invoice + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_date** | **str** | The invoice date | +**identifier** | **str** | The internal invoice document identifier | [optional] +**type** | **str** | The invoice type | [optional] +**copies** | **int** | The number of invoice copies | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/LabelPrintingRequest.md b/docs/LabelPrintingRequest.md new file mode 100644 index 0000000..9e09ea0 --- /dev/null +++ b/docs/LabelPrintingRequest.md @@ -0,0 +1,11 @@ +# LabelPrintingRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | PDF file name. eg: shipment-[trackingNumber] | +**label** | **str** | Shipment base64 label | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Message.md b/docs/Message.md new file mode 100644 index 0000000..700a46b --- /dev/null +++ b/docs/Message.md @@ -0,0 +1,14 @@ +# Message + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**carrier_name** | **str** | The targeted carrier | +**carrier_id** | **str** | The targeted carrier name (unique identifier) | +**message** | **str** | The error or warning message | [optional] +**code** | **str** | The message code | [optional] +**details** | **dict(str, str)** | any additional details | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Parcel.md b/docs/Parcel.md new file mode 100644 index 0000000..e5af03f --- /dev/null +++ b/docs/Parcel.md @@ -0,0 +1,21 @@ +# Parcel + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**weight** | **float** | The parcel's weight | [optional] +**width** | **float** | The parcel's width | [optional] +**height** | **float** | The parcel's height | [optional] +**length** | **float** | The parcel's length | [optional] +**packaging_type** | **str** | The parcel's packaging type. **Note that the packaging is optional when using a package preset** values: <br/>- **envelope**<br/>- **pak**<br/>- **tube**<br/>- **pallet**<br/>- **small_box**<br/>- **medium_box**<br/>- **your_packaging** For specific carriers packaging type, please consult the API reference. | [optional] +**package_preset** | **str** | The parcel's package preset. For specific carriers package preset, please consult the API reference. | [optional] +**description** | **str** | The parcel's description | [optional] +**content** | **str** | The parcel's content description | [optional] +**is_document** | **bool** | Indicates if the parcel is composed of documents only | [optional] [default to False] +**weight_unit** | **str** | The parcel's weight unit | [optional] +**dimension_unit** | **str** | The parcel's dimension unit | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/ParcelData.md b/docs/ParcelData.md new file mode 100644 index 0000000..a04eb7f --- /dev/null +++ b/docs/ParcelData.md @@ -0,0 +1,20 @@ +# ParcelData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**weight** | **float** | The parcel's weight | [optional] +**width** | **float** | The parcel's width | [optional] +**height** | **float** | The parcel's height | [optional] +**length** | **float** | The parcel's length | [optional] +**packaging_type** | **str** | The parcel's packaging type. **Note that the packaging is optional when using a package preset** values: <br/>- **envelope**<br/>- **pak**<br/>- **tube**<br/>- **pallet**<br/>- **small_box**<br/>- **medium_box**<br/>- **your_packaging** For specific carriers packaging type, please consult the API reference. | [optional] +**package_preset** | **str** | The parcel's package preset. For specific carriers package preset, please consult the API reference. | [optional] +**description** | **str** | The parcel's description | [optional] +**content** | **str** | The parcel's content description | [optional] +**is_document** | **bool** | Indicates if the parcel is composed of documents only | [optional] [default to False] +**weight_unit** | **str** | The parcel's weight unit | [optional] +**dimension_unit** | **str** | The parcel's dimension unit | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Payment.md b/docs/Payment.md new file mode 100644 index 0000000..4a1dd40 --- /dev/null +++ b/docs/Payment.md @@ -0,0 +1,16 @@ +# Payment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**paid_by** | **str** | The payment payer | +**amount** | **float** | The payment amount if known | [optional] +**currency** | **str** | The payment amount currency | +**account_number** | **str** | The selected rate carrier payer account number | [optional] +**credit_card** | [**Card**](Card.md) | | [optional] +**contact** | [**Address**](Address.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/PaymentData.md b/docs/PaymentData.md new file mode 100644 index 0000000..cd708ec --- /dev/null +++ b/docs/PaymentData.md @@ -0,0 +1,15 @@ +# PaymentData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**paid_by** | **str** | The payment payer | +**amount** | **float** | The payment amount if known | [optional] +**currency** | **str** | The payment amount currency | +**account_number** | **str** | The selected rate carrier payer account number | [optional] +**credit_card** | [**Card**](Card.md) | | [optional] +**contact** | [**Address**](Address.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Rate.md b/docs/Rate.md new file mode 100644 index 0000000..2afe71a --- /dev/null +++ b/docs/Rate.md @@ -0,0 +1,22 @@ +# Rate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**carrier_name** | **str** | The rate's carrier | +**carrier_id** | **str** | The targeted carrier's name (unique identifier) | +**currency** | **str** | The rate monetary values currency code | +**service** | **str** | The carrier's rate (quote) service | [optional] +**discount** | **float** | The monetary amount of the discount on the rate | [optional] +**base_charge** | **float** | The rate's monetary amount of the base charge.<br/> This is the net amount of the rate before additional charges | [optional] +**total_charge** | **float** | The rate's monetary amount of the total charge.<br/> This is the gross amount of the rate after adding the additional charges | [optional] +**duties_and_taxes** | **float** | The monetary amount of the duties and taxes if applied | [optional] +**transit_days** | **int** | The estimated delivery transit days | [optional] +**extra_charges** | [**list[Charge]**](Charge.md) | list of the rate's additional charges | [optional] +**meta** | **object** | provider specific metadata | [optional] +**carrier_ref** | **str** | The system carrier configuration id | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/RateRequest.md b/docs/RateRequest.md new file mode 100644 index 0000000..cb32e2e --- /dev/null +++ b/docs/RateRequest.md @@ -0,0 +1,16 @@ +# RateRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shipper** | [**Address**](Address.md) | | +**recipient** | [**Address**](Address.md) | | +**parcels** | [**list[Parcel]**](Parcel.md) | The shipment's parcels | +**services** | **list[str]** | The requested carrier service for the shipment.<br/> Please consult the API reference for specific carriers services. Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. | [optional] +**options** | **object** | The options available for the shipment. Please consult the API reference for additional specific carriers options. | [optional] +**reference** | **str** | The shipment reference | [optional] +**carrier_ids** | **list[str]** | The list of configured carriers you wish to get rates from. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/RateResponse.md b/docs/RateResponse.md new file mode 100644 index 0000000..272fce8 --- /dev/null +++ b/docs/RateResponse.md @@ -0,0 +1,11 @@ +# RateResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messages** | [**list[Message]**](Message.md) | The list of note, error or warning messages | [optional] +**rates** | [**list[Rate]**](Rate.md) | The list of returned rates | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/References.md b/docs/References.md new file mode 100644 index 0000000..7ae054d --- /dev/null +++ b/docs/References.md @@ -0,0 +1,16 @@ +# References + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**countries** | **list[str]** | | +**currencies** | **list[str]** | | +**states** | **object** | | +**services** | **object** | | +**options** | **object** | | +**package_presets** | **object** | | +**packaging_types** | **object** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/Shipment.md b/docs/Shipment.md new file mode 100644 index 0000000..f2f2952 --- /dev/null +++ b/docs/Shipment.md @@ -0,0 +1,30 @@ +# Shipment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**status** | **str** | The current Shipment status | [optional] [default to 'created'] +**carrier_name** | **str** | The shipment carrier | [optional] +**carrier_id** | **str** | The shipment carrier configured identifier | [optional] +**label** | **str** | The shipment label in base64 string | [optional] +**tracking_number** | **str** | The shipment tracking number | [optional] +**selected_rate** | [**Rate**](Rate.md) | | [optional] +**selected_rate_id** | **str** | The shipment selected rate. | [optional] +**rates** | [**list[Rate]**](Rate.md) | The list for shipment rates fetched previously | [optional] +**tracking_url** | **str** | The shipment tracking url | [optional] +**shipper** | [**Address**](Address.md) | | +**recipient** | [**Address**](Address.md) | | +**parcels** | [**list[Parcel]**](Parcel.md) | The shipment's parcels | +**services** | **list[str]** | The requested carrier service for the shipment. Please consult the API reference for specific carriers services.<br/> Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. | [optional] +**options** | **object** | The options available for the shipment.<br/> Please consult the API reference for additional specific carriers options. | [optional] +**payment** | [**Payment**](Payment.md) | | [optional] +**customs** | [**Customs**](Customs.md) | | [optional] +**doc_images** | [**list[Doc]**](Doc.md) | The list of documents to attach for a paperless interantional trade. eg: Invoices... | [optional] +**reference** | **str** | The shipment reference | [optional] +**carrier_ids** | **list[str]** | The list of configured carriers you wish to get rates from. *Note that the request will be sent to all carriers in nothing is specified* | [optional] +**meta** | **object** | provider specific metadata | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/ShipmentData.md b/docs/ShipmentData.md new file mode 100644 index 0000000..26ef711 --- /dev/null +++ b/docs/ShipmentData.md @@ -0,0 +1,19 @@ +# ShipmentData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shipper** | [**AddressData**](AddressData.md) | | +**recipient** | [**AddressData**](AddressData.md) | | +**parcels** | [**list[ParcelData]**](ParcelData.md) | The shipment's parcels | +**options** | **object** | The options available for the shipment.<br/> Please consult the API reference for additional specific carriers options. | [optional] +**payment** | [**PaymentData**](PaymentData.md) | | [optional] +**customs** | [**CustomsData**](CustomsData.md) | | [optional] +**doc_images** | [**list[Doc]**](Doc.md) | The list of documents to attach for a paperless interantional trade. eg: Invoices... | [optional] +**reference** | **str** | The shipment reference | [optional] +**services** | **list[str]** | The requested carrier service for the shipment. Please consult the API reference for specific carriers services.<br/> Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. | [optional] +**carrier_ids** | **list[str]** | The list of configured carriers you wish to get rates from. *Note that the request will be sent to all carriers in nothing is specified* | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/ShipmentPurchaseData.md b/docs/ShipmentPurchaseData.md new file mode 100644 index 0000000..dbb3de4 --- /dev/null +++ b/docs/ShipmentPurchaseData.md @@ -0,0 +1,11 @@ +# ShipmentPurchaseData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selected_rate_id** | **str** | The shipment selected rate. | +**payment** | [**Payment**](Payment.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/ShipmentResponse.md b/docs/ShipmentResponse.md new file mode 100644 index 0000000..80af8ab --- /dev/null +++ b/docs/ShipmentResponse.md @@ -0,0 +1,11 @@ +# ShipmentResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messages** | [**list[Message]**](Message.md) | The list of note or warning messages | [optional] +**shipment** | [**Shipment**](Shipment.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/ShippingRequest.md b/docs/ShippingRequest.md new file mode 100644 index 0000000..a66f315 --- /dev/null +++ b/docs/ShippingRequest.md @@ -0,0 +1,19 @@ +# ShippingRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shipper** | [**AddressData**](AddressData.md) | | +**recipient** | [**AddressData**](AddressData.md) | | +**parcels** | [**list[ParcelData]**](ParcelData.md) | The shipment's parcels | +**options** | **object** | The options available for the shipment.<br/> Please consult the API reference for additional specific carriers options. | [optional] +**payment** | [**Payment**](Payment.md) | | +**customs** | [**CustomsData**](CustomsData.md) | | [optional] +**doc_images** | [**list[Doc]**](Doc.md) | The list of documents to attach for a paperless interantional trade. eg: Invoices... | [optional] +**reference** | **str** | The shipment reference | [optional] +**selected_rate_id** | **str** | The shipment selected rate. | +**rates** | [**list[Rate]**](Rate.md) | The list for shipment rates fetched previously | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/TrackingDetails.md b/docs/TrackingDetails.md new file mode 100644 index 0000000..b925511 --- /dev/null +++ b/docs/TrackingDetails.md @@ -0,0 +1,13 @@ +# TrackingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**carrier_name** | **str** | The tracking carrier | +**carrier_id** | **str** | The tracking carrier configured identifier | +**tracking_number** | **str** | The shipment tracking number | +**events** | [**list[TrackingEvent]**](TrackingEvent.md) | The tracking details events | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/TrackingEvent.md b/docs/TrackingEvent.md new file mode 100644 index 0000000..08371d1 --- /dev/null +++ b/docs/TrackingEvent.md @@ -0,0 +1,15 @@ +# TrackingEvent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_date** | **str** | The tracking event's date | +**description** | **str** | The tracking event's description | +**location** | **str** | The tracking event's location | +**code** | **str** | The tracking event's code | [optional] +**time** | **str** | The tracking event's time | [optional] +**signatory** | **str** | The tracking signature on delivery | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/TrackingResponse.md b/docs/TrackingResponse.md new file mode 100644 index 0000000..7be3288 --- /dev/null +++ b/docs/TrackingResponse.md @@ -0,0 +1,11 @@ +# TrackingResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messages** | [**list[Message]**](Message.md) | The list of note or warning messages | [optional] +**tracking_details** | [**TrackingDetails**](TrackingDetails.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/docs/TrackingStatus.md b/docs/TrackingStatus.md new file mode 100644 index 0000000..d887de4 --- /dev/null +++ b/docs/TrackingStatus.md @@ -0,0 +1,15 @@ +# TrackingStatus + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A unique identifier | [optional] +**carrier_name** | **str** | The tracking carrier | +**carrier_id** | **str** | The tracking carrier configured identifier | +**tracking_number** | **str** | The shipment tracking number | +**events** | [**list[TrackingEvent]**](TrackingEvent.md) | The tracking details events | [optional] +**shipment_id** | **str** | The system shipment associated. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + diff --git a/purplship/__init__.py b/purplship/__init__.py index efada32..0d8193b 100755 --- a/purplship/__init__.py +++ b/purplship/__init__.py @@ -16,15 +16,15 @@ from __future__ import absolute_import # import apis into sdk package -from purplship.api.addresses import AddressesApi -from purplship.api.carriers import CarriersApi -from purplship.api.customs import CustomsApi -from purplship.api.parcels import ParcelsApi -from purplship.api.rates import RatesApi -from purplship.api.shipments import ShipmentsApi -from purplship.api.shipping import ShippingApi -from purplship.api.tracking import TrackingApi -from purplship.api.utils import UtilsApi +from purplship.api.addresses_api import AddressesApi +from purplship.api.carriers_api import CarriersApi +from purplship.api.customs_api import CustomsApi +from purplship.api.parcels_api import ParcelsApi +from purplship.api.rates_api import RatesApi +from purplship.api.shipments_api import ShipmentsApi +from purplship.api.shipping_api import ShippingApi +from purplship.api.tracking_api import TrackingApi +from purplship.api.utils_api import UtilsApi # import ApiClient from purplship.api_client import ApiClient diff --git a/purplship/api/__init__.py b/purplship/api/__init__.py index ba1d471..7c8f6cd 100644 --- a/purplship/api/__init__.py +++ b/purplship/api/__init__.py @@ -3,12 +3,12 @@ # flake8: noqa # import apis into api package -from purplship.api.addresses import AddressesApi -from purplship.api.carriers import CarriersApi -from purplship.api.customs import CustomsApi -from purplship.api.parcels import ParcelsApi -from purplship.api.rates import RatesApi -from purplship.api.shipments import ShipmentsApi -from purplship.api.shipping import ShippingApi -from purplship.api.tracking import TrackingApi -from purplship.api.utils import UtilsApi +from purplship.api.addresses_api import AddressesApi +from purplship.api.carriers_api import CarriersApi +from purplship.api.customs_api import CustomsApi +from purplship.api.parcels_api import ParcelsApi +from purplship.api.rates_api import RatesApi +from purplship.api.shipments_api import ShipmentsApi +from purplship.api.shipping_api import ShippingApi +from purplship.api.tracking_api import TrackingApi +from purplship.api.utils_api import UtilsApi diff --git a/purplship/api/addresses.py b/purplship/api/addresses_api.py similarity index 96% rename from purplship/api/addresses.py rename to purplship/api/addresses_api.py index de3c68d..0e35b48 100644 --- a/purplship/api/addresses.py +++ b/purplship/api/addresses_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -142,6 +142,8 @@ def list(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: list[Address] If the method is called asynchronously, returns the request thread. @@ -163,12 +165,14 @@ def list_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: list[Address] If the method is called asynchronously, returns the request thread. """ - all_params = [] # noqa: E501 + all_params = ['limit', 'offset'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -189,6 +193,10 @@ def list_with_http_info(self, **kwargs): # noqa: E501 path_params = {} query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 header_params = {} diff --git a/purplship/api/carriers.py b/purplship/api/carriers_api.py similarity index 99% rename from purplship/api/carriers.py rename to purplship/api/carriers_api.py index 185bf52..5b7e267 100644 --- a/purplship/api/carriers.py +++ b/purplship/api/carriers_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/api/customs.py b/purplship/api/customs_api.py similarity index 96% rename from purplship/api/customs.py rename to purplship/api/customs_api.py index ce59e6f..80ac916 100644 --- a/purplship/api/customs.py +++ b/purplship/api/customs_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -142,6 +142,8 @@ def list(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: list[Customs] If the method is called asynchronously, returns the request thread. @@ -163,12 +165,14 @@ def list_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: list[Customs] If the method is called asynchronously, returns the request thread. """ - all_params = [] # noqa: E501 + all_params = ['limit', 'offset'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -189,6 +193,10 @@ def list_with_http_info(self, **kwargs): # noqa: E501 path_params = {} query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 header_params = {} diff --git a/purplship/api/parcels.py b/purplship/api/parcels_api.py similarity index 96% rename from purplship/api/parcels.py rename to purplship/api/parcels_api.py index 0ee37b1..93aaf74 100644 --- a/purplship/api/parcels.py +++ b/purplship/api/parcels_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -142,6 +142,8 @@ def list(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: list[Parcel] If the method is called asynchronously, returns the request thread. @@ -163,12 +165,14 @@ def list_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: list[Parcel] If the method is called asynchronously, returns the request thread. """ - all_params = [] # noqa: E501 + all_params = ['limit', 'offset'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -189,6 +193,10 @@ def list_with_http_info(self, **kwargs): # noqa: E501 path_params = {} query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 header_params = {} diff --git a/purplship/api/rates.py b/purplship/api/rates_api.py similarity index 99% rename from purplship/api/rates.py rename to purplship/api/rates_api.py index a0c49a1..0689f7b 100644 --- a/purplship/api/rates.py +++ b/purplship/api/rates_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/api/shipments.py b/purplship/api/shipments_api.py similarity index 95% rename from purplship/api/shipments.py rename to purplship/api/shipments_api.py index 5230dcb..ec1bef3 100644 --- a/purplship/api/shipments.py +++ b/purplship/api/shipments_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,45 +33,45 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def options(self, id, **kwargs): # noqa: E501 - """Add Shipment Options # noqa: E501 + def create(self, data, **kwargs): # noqa: E501 + """Create a Shipment # noqa: E501 - Add one or many options to your shipment.
**eg:**
- add shipment **insurance** - specify the preferred transaction **currency** - setup a **cash collected on delivery** option ```json { \"insurane\": { \"amount\": 120, }, \"currency\": \"USD\" } ``` And many more, check additional options available in the [reference](#operation/all_references). # noqa: E501 + Create a new shipment instance. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.options(id, async_req=True) + >>> thread = api.create(data, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: (required) + :param ShipmentData data: (required) :return: Shipment If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.options_with_http_info(id, **kwargs) # noqa: E501 + return self.create_with_http_info(data, **kwargs) # noqa: E501 else: - (data) = self.options_with_http_info(id, **kwargs) # noqa: E501 + (data) = self.create_with_http_info(data, **kwargs) # noqa: E501 return data - def options_with_http_info(self, id, **kwargs): # noqa: E501 - """Add Shipment Options # noqa: E501 + def create_with_http_info(self, data, **kwargs): # noqa: E501 + """Create a Shipment # noqa: E501 - Add one or many options to your shipment.
**eg:**
- add shipment **insurance** - specify the preferred transaction **currency** - setup a **cash collected on delivery** option ```json { \"insurane\": { \"amount\": 120, }, \"currency\": \"USD\" } ``` And many more, check additional options available in the [reference](#operation/all_references). # noqa: E501 + Create a new shipment instance. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.options_with_http_info(id, async_req=True) + >>> thread = api.create_with_http_info(data, async_req=True) >>> result = thread.get() :param async_req bool - :param str id: (required) + :param ShipmentData data: (required) :return: Shipment If the method is called asynchronously, returns the request thread. """ - all_params = ['id'] # noqa: E501 + all_params = ['data'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -82,20 +82,18 @@ def options_with_http_info(self, id, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method options" % key + " to method create" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params or - params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `options`") # noqa: E501 + # verify the required parameter 'data' is set + if ('data' not in params or + params['data'] is None): + raise ValueError("Missing the required parameter `data` when calling `create`") # noqa: E501 collection_formats = {} path_params = {} - if 'id' in params: - path_params['id'] = params['id'] # noqa: E501 query_params = [] @@ -105,6 +103,8 @@ def options_with_http_info(self, id, **kwargs): # noqa: E501 local_var_files = {} body_params = None + if 'data' in params: + body_params = params['data'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -117,7 +117,7 @@ def options_with_http_info(self, id, **kwargs): # noqa: E501 auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 return self.api_client.call_api( - '/shipments/{id}/options', 'POST', + '/shipments', 'POST', path_params, query_params, header_params, @@ -132,45 +132,47 @@ def options_with_http_info(self, id, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def create(self, data, **kwargs): # noqa: E501 - """Create a Shipment # noqa: E501 + def list(self, **kwargs): # noqa: E501 + """List all Shipments # noqa: E501 - Create a new shipment instance. # noqa: E501 + Retrieve all shipments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create(data, async_req=True) + >>> thread = api.list(async_req=True) >>> result = thread.get() :param async_req bool - :param ShipmentData data: (required) - :return: Shipment + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :return: list[Shipment] If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.create_with_http_info(data, **kwargs) # noqa: E501 + return self.list_with_http_info(**kwargs) # noqa: E501 else: - (data) = self.create_with_http_info(data, **kwargs) # noqa: E501 + (data) = self.list_with_http_info(**kwargs) # noqa: E501 return data - def create_with_http_info(self, data, **kwargs): # noqa: E501 - """Create a Shipment # noqa: E501 + def list_with_http_info(self, **kwargs): # noqa: E501 + """List all Shipments # noqa: E501 - Create a new shipment instance. # noqa: E501 + Retrieve all shipments. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_with_http_info(data, async_req=True) + >>> thread = api.list_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool - :param ShipmentData data: (required) - :return: Shipment + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :return: list[Shipment] If the method is called asynchronously, returns the request thread. """ - all_params = ['data'] # noqa: E501 + all_params = ['limit', 'offset'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -181,20 +183,20 @@ def create_with_http_info(self, data, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method create" % key + " to method list" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'data' is set - if ('data' not in params or - params['data'] is None): - raise ValueError("Missing the required parameter `data` when calling `create`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 header_params = {} @@ -202,8 +204,6 @@ def create_with_http_info(self, data, **kwargs): # noqa: E501 local_var_files = {} body_params = None - if 'data' in params: - body_params = params['data'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -216,14 +216,14 @@ def create_with_http_info(self, data, **kwargs): # noqa: E501 auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 return self.api_client.call_api( - '/shipments', 'POST', + '/shipments', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='Shipment', # noqa: E501 + response_type='list[Shipment]', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -231,40 +231,40 @@ def create_with_http_info(self, data, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def rates(self, id, **kwargs): # noqa: E501 - """Fetch new Shipment Rates # noqa: E501 + def options(self, id, **kwargs): # noqa: E501 + """Add Shipment Options # noqa: E501 - Refresh the list of the shipment rates # noqa: E501 + Add one or many options to your shipment.
**eg:**
- add shipment **insurance** - specify the preferred transaction **currency** - setup a **cash collected on delivery** option ```json { \"insurane\": { \"amount\": 120, }, \"currency\": \"USD\" } ``` And many more, check additional options available in the [reference](#operation/all_references). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.rates(id, async_req=True) + >>> thread = api.options(id, async_req=True) >>> result = thread.get() :param async_req bool :param str id: (required) - :return: ShipmentResponse + :return: Shipment If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.rates_with_http_info(id, **kwargs) # noqa: E501 + return self.options_with_http_info(id, **kwargs) # noqa: E501 else: - (data) = self.rates_with_http_info(id, **kwargs) # noqa: E501 + (data) = self.options_with_http_info(id, **kwargs) # noqa: E501 return data - def rates_with_http_info(self, id, **kwargs): # noqa: E501 - """Fetch new Shipment Rates # noqa: E501 + def options_with_http_info(self, id, **kwargs): # noqa: E501 + """Add Shipment Options # noqa: E501 - Refresh the list of the shipment rates # noqa: E501 + Add one or many options to your shipment.
**eg:**
- add shipment **insurance** - specify the preferred transaction **currency** - setup a **cash collected on delivery** option ```json { \"insurane\": { \"amount\": 120, }, \"currency\": \"USD\" } ``` And many more, check additional options available in the [reference](#operation/all_references). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.rates_with_http_info(id, async_req=True) + >>> thread = api.options_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool :param str id: (required) - :return: ShipmentResponse + :return: Shipment If the method is called asynchronously, returns the request thread. """ @@ -280,14 +280,14 @@ def rates_with_http_info(self, id, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method rates" % key + " to method options" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params or params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `rates`") # noqa: E501 + raise ValueError("Missing the required parameter `id` when calling `options`") # noqa: E501 collection_formats = {} @@ -315,14 +315,14 @@ def rates_with_http_info(self, id, **kwargs): # noqa: E501 auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 return self.api_client.call_api( - '/shipments/{id}/rates', 'GET', + '/shipments/{id}/options', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ShipmentResponse', # noqa: E501 + response_type='Shipment', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -330,43 +330,47 @@ def rates_with_http_info(self, id, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def list(self, **kwargs): # noqa: E501 - """List all Shipments # noqa: E501 + def purchase(self, id, data, **kwargs): # noqa: E501 + """Buy a Shipment # noqa: E501 - Retrieve all shipments. # noqa: E501 + Select your preferred rates to buy a shipment label. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list(async_req=True) + >>> thread = api.purchase(id, data, async_req=True) >>> result = thread.get() :param async_req bool - :return: list[Shipment] + :param str id: (required) + :param ShipmentPurchaseData data: (required) + :return: ShipmentResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.list_with_http_info(**kwargs) # noqa: E501 + return self.purchase_with_http_info(id, data, **kwargs) # noqa: E501 else: - (data) = self.list_with_http_info(**kwargs) # noqa: E501 + (data) = self.purchase_with_http_info(id, data, **kwargs) # noqa: E501 return data - def list_with_http_info(self, **kwargs): # noqa: E501 - """List all Shipments # noqa: E501 + def purchase_with_http_info(self, id, data, **kwargs): # noqa: E501 + """Buy a Shipment # noqa: E501 - Retrieve all shipments. # noqa: E501 + Select your preferred rates to buy a shipment label. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_with_http_info(async_req=True) + >>> thread = api.purchase_with_http_info(id, data, async_req=True) >>> result = thread.get() :param async_req bool - :return: list[Shipment] + :param str id: (required) + :param ShipmentPurchaseData data: (required) + :return: ShipmentResponse If the method is called asynchronously, returns the request thread. """ - all_params = [] # noqa: E501 + all_params = ['id', 'data'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -377,14 +381,24 @@ def list_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method list" % key + " to method purchase" % key ) params[key] = val del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `purchase`") # noqa: E501 + # verify the required parameter 'data' is set + if ('data' not in params or + params['data'] is None): + raise ValueError("Missing the required parameter `data` when calling `purchase`") # noqa: E501 collection_formats = {} path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 query_params = [] @@ -394,6 +408,8 @@ def list_with_http_info(self, **kwargs): # noqa: E501 local_var_files = {} body_params = None + if 'data' in params: + body_params = params['data'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -406,14 +422,14 @@ def list_with_http_info(self, **kwargs): # noqa: E501 auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 return self.api_client.call_api( - '/shipments', 'GET', + '/shipments/{id}/purchase', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[Shipment]', # noqa: E501 + response_type='ShipmentResponse', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -421,47 +437,49 @@ def list_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def purchase(self, id, data, **kwargs): # noqa: E501 - """Buy a Shipment # noqa: E501 + def rates(self, id, **kwargs): # noqa: E501 + """Fetch new Shipment Rates # noqa: E501 - Select your preferred rates to buy a shipment label. # noqa: E501 + Refresh the list of the shipment rates # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.purchase(id, data, async_req=True) + >>> thread = api.rates(id, async_req=True) >>> result = thread.get() :param async_req bool :param str id: (required) - :param ShipmentPurchaseData data: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: ShipmentResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.purchase_with_http_info(id, data, **kwargs) # noqa: E501 + return self.rates_with_http_info(id, **kwargs) # noqa: E501 else: - (data) = self.purchase_with_http_info(id, data, **kwargs) # noqa: E501 + (data) = self.rates_with_http_info(id, **kwargs) # noqa: E501 return data - def purchase_with_http_info(self, id, data, **kwargs): # noqa: E501 - """Buy a Shipment # noqa: E501 + def rates_with_http_info(self, id, **kwargs): # noqa: E501 + """Fetch new Shipment Rates # noqa: E501 - Select your preferred rates to buy a shipment label. # noqa: E501 + Refresh the list of the shipment rates # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.purchase_with_http_info(id, data, async_req=True) + >>> thread = api.rates_with_http_info(id, async_req=True) >>> result = thread.get() :param async_req bool :param str id: (required) - :param ShipmentPurchaseData data: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. :return: ShipmentResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['id', 'data'] # noqa: E501 + all_params = ['id', 'limit', 'offset'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -472,18 +490,14 @@ def purchase_with_http_info(self, id, data, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method purchase" % key + " to method rates" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params or params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `purchase`") # noqa: E501 - # verify the required parameter 'data' is set - if ('data' not in params or - params['data'] is None): - raise ValueError("Missing the required parameter `data` when calling `purchase`") # noqa: E501 + raise ValueError("Missing the required parameter `id` when calling `rates`") # noqa: E501 collection_formats = {} @@ -492,6 +506,10 @@ def purchase_with_http_info(self, id, data, **kwargs): # noqa: E501 path_params['id'] = params['id'] # noqa: E501 query_params = [] + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 header_params = {} @@ -499,8 +517,6 @@ def purchase_with_http_info(self, id, data, **kwargs): # noqa: E501 local_var_files = {} body_params = None - if 'data' in params: - body_params = params['data'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 @@ -513,7 +529,7 @@ def purchase_with_http_info(self, id, data, **kwargs): # noqa: E501 auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 return self.api_client.call_api( - '/shipments/{id}/purchase', 'POST', + '/shipments/{id}/rates', 'GET', path_params, query_params, header_params, @@ -639,7 +655,7 @@ def track(self, carrier_id, tracking_number, **kwargs): # noqa: E501 :param async_req bool :param str carrier_id: (required) :param str tracking_number: (required) - :return: Tracking + :return: TrackingStatus If the method is called asynchronously, returns the request thread. """ @@ -662,7 +678,7 @@ def track_with_http_info(self, carrier_id, tracking_number, **kwargs): # noqa: :param async_req bool :param str carrier_id: (required) :param str tracking_number: (required) - :return: Tracking + :return: TrackingStatus If the method is called asynchronously, returns the request thread. """ @@ -726,7 +742,7 @@ def track_with_http_info(self, carrier_id, tracking_number, **kwargs): # noqa: body=body_params, post_params=form_params, files=local_var_files, - response_type='Tracking', # noqa: E501 + response_type='TrackingStatus', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/purplship/api/shipping.py b/purplship/api/shipping_api.py similarity index 97% rename from purplship/api/shipping.py rename to purplship/api/shipping_api.py index 3d27165..71a26d7 100644 --- a/purplship/api/shipping.py +++ b/purplship/api/shipping_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -34,7 +34,7 @@ def __init__(self, api_client=None): self.api_client = api_client def buy_label(self, data, **kwargs): # noqa: E501 - """Submit a Shipment # noqa: E501 + """Buy a shipment label # noqa: E501 **[proxy]** Once the shipping rates are retrieved, provide the required info to submit the shipment by specifying your preferred rate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -56,7 +56,7 @@ def buy_label(self, data, **kwargs): # noqa: E501 return data def buy_label_with_http_info(self, data, **kwargs): # noqa: E501 - """Submit a Shipment # noqa: E501 + """Buy a shipment label # noqa: E501 **[proxy]** Once the shipping rates are retrieved, provide the required info to submit the shipment by specifying your preferred rate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an diff --git a/purplship/api/tracking.py b/purplship/api/tracking_api.py similarity index 99% rename from purplship/api/tracking.py rename to purplship/api/tracking_api.py index 4a500fe..7c23fbd 100644 --- a/purplship/api/tracking.py +++ b/purplship/api/tracking_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/api/utils.py b/purplship/api/utils.py deleted file mode 100644 index 3749016..0000000 --- a/purplship/api/utils.py +++ /dev/null @@ -1,224 +0,0 @@ -# coding: utf-8 - -""" - Purplship Open Source Multi-carrier Shipping API - - Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - - OpenAPI spec version: v1-2020.8.0 - Contact: hello@purplship.com - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from __future__ import absolute_import - -import re # noqa: F401 - -# python 2 and python 3 compatibility library -import six - -from purplship.api_client import ApiClient - - -class UtilsApi(object): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - - def references(self, **kwargs): # noqa: E501 - """Get all References # noqa: E501 - - ## Countries
Code | Name --- | --- AD | ANDORRA AE | UNITED ARAB EMIRATES AF | AFGHANISTAN AG | ANTIGUA AI | ANGUILLA AL | ALBANIA AM | ARMENIA AN | NETHERLANDS ANTILLES AO | ANGOLA AR | ARGENTINA AS | AMERICAN SAMOA AT | AUSTRIA AU | AUSTRALIA AW | ARUBA AZ | AZERBAIJAN BA | BOSNIA AND HERZEGOVINA BB | BARBADOS BD | BANGLADESH BE | BELGIUM BF | BURKINA FASO BG | BULGARIA BH | BAHRAIN BI | BURUNDI BJ | BENIN BM | BERMUDA BN | BRUNEI BO | BOLIVIA BR | BRAZIL BS | BAHAMAS BT | BHUTAN BW | BOTSWANA BY | BELARUS BZ | BELIZE CA | CANADA CD | CONGO, THE DEMOCRATIC REPUBLIC OF CF | CENTRAL AFRICAN REPUBLIC CG | CONGO CH | SWITZERLAND CI | COTE D IVOIRE CK | COOK ISLANDS CL | CHILE CM | CAMEROON CN | CHINA, PEOPLES REPUBLIC CO | COLOMBIA CR | COSTA RICA CU | CUBA CV | CAPE VERDE CY | CYPRUS CZ | CZECH REPUBLIC, THE DE | GERMANY DJ | DJIBOUTI DK | DENMARK DM | DOMINICA DO | DOMINICAN REPUBLIC DZ | ALGERIA EC | ECUADOR EE | ESTONIA EG | EGYPT ER | ERITREA ES | SPAIN ET | ETHIOPIA FI | FINLAND FJ | FIJI FK | FALKLAND ISLANDS FM | MICRONESIA, FEDERATED STATES OF FO | FAROE ISLANDS FR | FRANCE GA | GABON GB | UNITED KINGDOM GD | GRENADA GE | GEORGIA GF | FRENCH GUYANA GG | GUERNSEY GH | GHANA GI | GIBRALTAR GL | GREENLAND GM | GAMBIA GN | GUINEA REPUBLIC GP | GUADELOUPE GQ | GUINEA-EQUATORIAL GR | GREECE GT | GUATEMALA GU | GUAM GW | GUINEA-BISSAU GY | GUYANA (BRITISH) HK | HONG KONG HN | HONDURAS HR | CROATIA HT | HAITI HU | HUNGARY IC | CANARY ISLANDS, THE ID | INDONESIA IE | IRELAND, REPUBLIC OF IL | ISRAEL IN | INDIA IQ | IRAQ IR | IRAN (ISLAMIC REPUBLIC OF) IS | ICELAND IT | ITALY JE | JERSEY JM | JAMAICA JO | JORDAN JP | JAPAN KE | KENYA KG | KYRGYZSTAN KH | CAMBODIA KI | KIRIBATI KM | COMOROS KN | ST. KITTS KP | KOREA, THE D.P.R OF (NORTH K.) KR | KOREA, REPUBLIC OF (SOUTH K.) KV | KOSOVO KW | KUWAIT KY | CAYMAN ISLANDS KZ | KAZAKHSTAN LA | LAO PEOPLES DEMOCRATIC REPUBLIC LB | LEBANON LC | ST. LUCIA LI | LIECHTENSTEIN LK | SRI LANKA LR | LIBERIA LS | LESOTHO LT | LITHUANIA LU | LUXEMBOURG LV | LATVIA LY | LIBYA MA | MOROCCO MC | MONACO MD | MOLDOVA, REPUBLIC OF ME | MONTENEGRO, REPUBLIC OF MG | MADAGASCAR MH | MARSHALL ISLANDS MK | MACEDONIA, REPUBLIC OF ML | MALI MM | MYANMAR MN | MONGOLIA MO | MACAU MP | COMMONWEALTH NO. MARIANA ISLANDS MQ | MARTINIQUE MR | MAURITANIA MS | MONTSERRAT MT | MALTA MU | MAURITIUS MV | MALDIVES MW | MALAWI MX | MEXICO MY | MALAYSIA MZ | MOZAMBIQUE NA | NAMIBIA NC | NEW CALEDONIA NE | NIGER NG | NIGERIA NI | NICARAGUA NL | NETHERLANDS, THE NO | NORWAY NP | NEPAL NR | NAURU, REPUBLIC OF NU | NIUE NZ | NEW ZEALAND OM | OMAN PA | PANAMA PE | PERU PF | TAHITI PG | PAPUA NEW GUINEA PH | PHILIPPINES, THE PK | PAKISTAN PL | POLAND PR | PUERTO RICO PT | PORTUGAL PW | PALAU PY | PARAGUAY QA | QATAR RE | REUNION, ISLAND OF RO | ROMANIA RS | SERBIA, REPUBLIC OF RU | RUSSIAN FEDERATION, THE RW | RWANDA SA | SAUDI ARABIA SB | SOLOMON ISLANDS SC | SEYCHELLES SD | SUDAN SE | SWEDEN SG | SINGAPORE SH | SAINT HELENA SI | SLOVENIA SK | SLOVAKIA SL | SIERRA LEONE SM | SAN MARINO SN | SENEGAL SO | SOMALIA SR | SURINAME SS | SOUTH SUDAN ST | SAO TOME AND PRINCIPE SV | EL SALVADOR SY | SYRIA SZ | SWAZILAND TC | TURKS AND CAICOS ISLANDS TD | CHAD TG | TOGO TH | THAILAND TJ | TAJIKISTAN TL | TIMOR LESTE TN | TUNISIA TO | TONGA TR | TURKEY TT | TRINIDAD AND TOBAGO TV | TUVALU TW | TAIWAN TZ | TANZANIA UA | UKRAINE UG | UGANDA US | UNITED STATES OF AMERICA UY | URUGUAY UZ | UZBEKISTAN VA | VATICAN CITY STATE VC | ST. VINCENT VE | VENEZUELA VG | VIRGIN ISLANDS (BRITISH) VI | VIRGIN ISLANDS (US) VN | VIETNAM VU | VANUATU WS | SAMOA XB | BONAIRE XC | CURACAO XE | ST. EUSTATIUS XM | ST. MAARTEN XN | NEVIS XS | SOMALILAND, REP OF (NORTH SOMALIA) XY | ST. BARTHELEMY YE | YEMEN, REPUBLIC OF YT | MAYOTTE ZA | SOUTH AFRICA ZM | ZAMBIA ZW | ZIMBABWE

## States and Provinces
### UNITED ARAB EMIRATES
Code | Name --- | --- AB | Abu Dhabi AJ | Ajman DU | Dubai FU | Fujairah RA | Ras al-Khaimah SH | Sharjah UM | Umm al-Qaiwain

### CANADA
Code | Name --- | --- AB | Alberta BC | British Columbia MB | Manitoba NB | New Brunswick NL | Newfoundland NT | Northwest Territories NS | Nova Scotia NU | Nunavut ON | Ontario PE | Prince Edward Island QC | Quebec SK | Saskatchewan YT | Yukon

### CHINA, PEOPLES REPUBLIC
Code | Name --- | --- anhui | Anhui hainan | Hainan jiangxi | Jiangxi shanghai | Shanghai beijing | Beijing hebei | Hebei jilin | Jilin shanxi | Shanxi chongqing | Chongqing heilongjiang | Heilongjiang liaoning | Liaoning sichuan | Sichuan fujian | Fujian henan | Henan nei_mongol | Nei Mongol tianjin | Tianjin gansu | Gansu hubei | Hubei qinghai | Qinghai xinjiang | Xinjiang guangdong | Guangdong hunan | Hunan shaanxi | Shaanxi yunnan | Yunnan guizhou | Guizhou jiangsu | Jiangsu shandong | Shandong zhejiang | Zhejiang

### INDIA
Code | Name --- | --- AN | Andaman & Nicobar (U.T) AP | Andhra Pradesh AR | Arunachal Pradesh AS | Assam BR | Bihar CG | Chattisgarh CH | Chandigarh (U.T.) DD | Daman & Diu (U.T.) DL | Delhi (U.T.) DN | Dadra and Nagar Haveli (U.T.) GA | Goa GJ | Gujarat HP | Himachal Pradesh HR | Haryana JH | Jharkhand JK | Jammu & Kashmir KA | Karnataka KL | Kerala LD | Lakshadweep (U.T) MH | Maharashtra ML | Meghalaya MN | Manipur MP | Madhya Pradesh MZ | Mizoram NL | Nagaland OR | Orissa PB | Punjab PY | Puducherry (U.T.) RJ | Rajasthan SK | Sikkim TN | Tamil Nadu TR | Tripura UA | Uttaranchal UP | Uttar Pradesh WB | West Bengal

### MEXICO
Code | Name --- | --- AG | Aguascalientes BC | Baja California BS | Baja California Sur CM | Campeche CS | Chiapas CH | Chihuahua CO | Coahuila CL | Colima DF | Ciudad de México DG | Durango GT | Guanajuato GR | Guerrero HG | Hidalgo JA | Jalisco EM | Estado de México MI | Michoacán MO | Morelos NA | Nayarit NL | Nuevo León OA | Oaxaca PU | Puebla QE | Querétaro QR | Quintana Roo SL | San Luis Potosí SI | Sinaloa SO | Sonora TB | Tabasco TM | Tamaulipas TL | Tlaxcala VE | Veracruz YU | Yucatán ZA | Zacatecas

### UNITED STATES OF AMERICA
Code | Name --- | --- AL | Alabama AK | Alaska AZ | Arizona AR | Arkansas CA | California CO | Colorado CT | Connecticut DE | Delaware DC | District of Columbia FL | Florida GA | Georgia HI | Hawaii ID | Idaho IL | Illinois IN | Indiana IA | Iowa KS | Kansas KY | Kentucky LA | Louisiana ME | Maine MD | Maryland MA | Massachusetts MI | Michigan MN | Minnesota MS | Mississippi MO | Missouri MT | Montana NE | Nebraska NV | Nevada NH | New Hampshire NJ | New Jersey NM | New Mexico NY | New York NC | North Carolina ND | North Dakota OH | Ohio OK | Oklahoma OR | Oregon PA | Pennsylvania RI | Rhode Island SC | South Carolina SD | South Dakota TN | Tennessee TX | Texas UT | Utah VT | Vermont VA | Virginia WA | Washington State WV | West Virginia WI | Wisconsin WY | Wyoming PR | Puerto Rico


## Currencies
Code | Name --- | --- EUR | Euro AED | UAE Dirham USD | US Dollar XCD | East Caribbean Dollar AMD | Dran ANG | Netherlands Antilles Guilder AOA | Kwanza ARS | Argentine Peso AUD | Australian Dollar AWG | Aruba Guilder AZN | Manat BAM | Convertible Marks BBD | Barbadian Dollar BDT | Taka XOF | CFA Franc West Africa BGN | Bulgarian Lev BHD | Bahraini Dinar BIF | Burundese Franc BMD | Bermudian Dollar BND | Brunei Dollar BOB | Boliviano BRL | Real BSD | Bahamian Dollar BTN | Ngultrum BWP | Pula BYN | Belarussian Ruble BZD | Belize Dollar CAD | Canadian Dollar CDF | Franc Congolais XAF | CFA Franc Central Africa CHF | Swiss Franc NZD | New Zealand Dollar CLP | New Chile Peso CNY | Yuan (Ren Min Bi) COP | Colombian Peso CRC | Costa Rican Colon CUC | Peso Convertible CVE | Cape Verde Escudo CZK | Czech Koruna DJF | Djibouti Franc DKK | Danish Krone DOP | Dominican Republic Peso DZD | Algerian Dinar EGP | Egyptian Pound ERN | Nakfa ETB | Birr FJD | Fijian Dollar GBP | Pound Sterling GEL | Georgian Lari GHS | Cedi GMD | Dalasi GNF | Guinea Franc GTQ | Quetzal GYD | Guyanan Dollar HKD | Hong Kong Dollar HNL | Lempira HRK | Croatian Kuna HTG | Gourde HUF | Forint IDR | Rupiah ILS | New Israeli Shekel INR | Indian Rupee IRR | Iranian Rial ISK | Icelandic Krona JMD | Jamaican Dollar JOD | Jordanian Dinar JPY | Yen KES | Kenyan Shilling KGS | Som KHR | Khmer Rial KMF | Comoros Franc KPW | North Korean Won KRW | Won KWD | Kuwaiti Dinar KYD | Cayman Islands Dollar KZT | Tenge LAK | Kip LKR | Sri Lankan Rupee LRD | Liberian Dollar LSL | Loti LYD | Libyan Dinar MAD | Moroccan Dirham MDL | Leu MGA | Ariary MKD | Denar MMK | Kyat MNT | Tugrik MOP | Pataca MRO | Ouguiya MUR | Mauritius Rupee MVR | Rufiyaa MWK | Kwacha MXN | Mexican Nuevo Peso MYR | Ringgit MZN | Mozambique Metical NAD | Namibian Dollar XPF | CFP Franc NGN | Naira NIO | Cordoba Oro NOK | Norwegian Krone NPR | Nepalese Rupee OMR | Omani Rial PEN | Nuevo Sol PGK | Kina PHP | Phillipines Peso PKR | Pakistani Rupee PLN | Zloty PYG | Guarani QAR | Qatar Rial RSD | Serbia, Dinars RUB | Russian Ruble RWF | Rwanda Franc SAR | Saudi Riyal SBD | Solomon Islands Dollar SCR | Seychelles Rupee SDG | Sudanese Pound SEK | Swedish Krona SGD | Singapore Dollar SHP | St. Helena Pound SLL | Leone SOS | Somali Shilling SRD | Suriname Dollar SSP | South Sudanese pound STD | Dobra SYP | Syrian Pound SZL | Lilangeni THB | Baht TJS | Somoni TND | Tunisian Dinar TOP | Pa'anga TRY | New Turkish Lira TTD | Trinidad and Tobago Dollar TWD | New Taiwan Dollar TZS | Tanzanian Shilling UAH | Hryvna UYU | Peso Uruguayo UZS | Sum VEF | Bolivar Fuerte VND | Dong VUV | Vanuatu Vatu WST | Tala YER | Yemeni Riyal ZAR | South African Rand

## Package Preset
### Canada Post
Code | Dimensions | Note --- | --- | --- canadapost_mailing_box | 15.2 x 10.2 | height x width canadapost_extra_small_mailing_box | 14.0 x 14.0 x 14.0 | height x length x width canadapost_small_mailing_box | 22.9 x 6.4 x 28.6 | height x length x width canadapost_medium_mailing_box | 23.5 x 13.3 x 31.0 | height x length x width canadapost_large_mailing_box | 30.5 x 9.5 x 38.1 | height x length x width canadapost_extra_large_mailing_box | 30.5 x 21.6 x 40.0 | height x length x width canadapost_corrugated_small_box | 32.0 x 32.0 x 42.0 | height x length x width canadapost_corrugated_medium_box | 38.0 x 32.0 x 46.0 | height x length x width canadapost_corrugated_large_box | 46.0 x 40.6 x 46.0 | height x length x width canadapost_xexpresspost_certified_envelope | 15.9 x 1.5 x 0.5 x 26.0 | height x length x weight x width canadapost_xexpresspost_national_large_envelope | 29.2 x 1.5 x 1.36 x 40.0 | height x length x weight x width

### DHL
Code | Dimensions | Note --- | --- | --- dhl_express_envelope | 27.5 x 1.0 x 0.5 x 35.0 | height x length x weight x width dhl_express_standard_flyer | 30.0 x 2.0 x 40.0 | height x weight x width dhl_express_large_flyer | 37.5 x 3.0 x 47.5 | height x weight x width dhl_express_box_2 | 18.2 x 10.0 x 1.0 x 33.7 | height x length x weight x width dhl_express_box_3 | 32.0 x 5.2 x 2.0 x 33.6 | height x length x weight x width dhl_express_box_4 | 32.2 x 18.0 x 5.0 x 33.7 | height x length x weight x width dhl_express_box_5 | 32.2 x 34.5 x 10.0 x 33.7 | height x length x weight x width dhl_express_box_6 | 35.9 x 36.9 x 15.0 x 41.7 | height x length x weight x width dhl_express_box_7 | 40.4 x 38.9 x 20.0 x 48.1 | height x length x weight x width dhl_express_box_8 | 44.4 x 40.9 x 25.0 x 54.2 | height x length x weight x width dhl_express_tube | 15.0 x 15.0 x 5.0 x 96.0 | height x length x weight x width dhl_didgeridoo_box | 13.0 x 162.0 x 10.0 x 13.0 | height x length x weight x width dhl_jumbo_box | 42.7 x 33.0 x 30.0 x 45.0 | height x length x weight x width dhl_jumbo_box_junior | 34.0 x 24.1 x 20.0 x 39.9 | height x length x weight x width

### FedEx
Code | Dimensions | Note --- | --- | --- fedex_envelope_legal_size | 15.5 x 1.0 x 9.5 | height x weight x width fedex_padded_pak | 14.75 x 2.2 x 11.75 | height x weight x width fedex_polyethylene_pak | 15.5 x 2.2 x 12.0 | height x weight x width fedex_clinical_pak | 18.0 x 2.2 x 13.5 | height x weight x width fedex_small_box | 10.9 x 1.5 x 20.0 x 12.25 | height x length x weight x width fedex_medium_box | 11.5 x 2.38 x 20.0 x 13.25 | height x length x weight x width fedex_large_box | 12.38 x 3.0 x 20.0 x 17.88 | height x length x weight x width fedex_10_kg_box | 12.94 x 10.19 x 10.0 x 15.81 | height x length x weight x width fedex_25_kg_box | 16.56 x 13.19 x 25.0 x 21.56 | height x length x weight x width fedex_tube | 6.0 x 6.0 x 20.0 x 38.0 | height x length x weight x width

### Purolator
Code | Dimensions | Note --- | --- | --- purolator_express_envelope | 1.0 | weight purolator_express_pack | 3.0 | weight purolator_express_box | 7.0 | weight

### UPS
Code | Dimensions | Note --- | --- | --- ups_small_express_box | 11.0 x 2.0 x 30.0 x 13.0 | height x length x weight x width ups_medium_express_box | 11.0 x 3.0 x 30.0 x 16.0 | height x length x weight x width ups_large_express_box | 13.0 x 3.0 x 30.0 x 18.0 | height x length x weight x width ups_express_tube | 6.0 x 6.0 x 38.0 | height x length x width ups_express_pak | 11.75 x 16.0 | height x width ups_world_document_box | 12.5 x 3.0 x 17.5 | height x length x width


## Shipment Options
### Canada Post
Code | Identifier --- | --- canadapost_signature | SO canadapost_coverage | COV canadapost_collect_on_delivery | COD canadapost_proof_of_age_required_18 | PA18 canadapost_proof_of_age_required_19 | PA19 canadapost_card_for_pickup | HFP canadapost_do_not_safe_drop | DNS canadapost_leave_at_door | LAD canadapost_deliver_to_post_office | D2PO canadapost_return_at_senders_expense | RASE canadapost_return_to_sender | RTS canadapost_abandon | ABAN

### DHL
Code | Identifier --- | --- dhl_logistics_services | 0A dhl_mailroom_management | 0B dhl_pallet_administration | 0C dhl_warehousing | 0D dhl_express_logistics_centre | 0E dhl_strategic_parts_centre | 0F dhl_local_distribution_centre | 0G dhl_terminal_handling | 0H dhl_cross_docking | 0I dhl_inventory_management | 0J dhl_loading_unloading | 0K dhl_product_kitting | 0L dhl_priority_account_desk | 0M dhl_document_archiving | 0N dhl_saturday_delivery | AA dhl_saturday_pickup | AB dhl_holiday_delivery | AC dhl_holiday_pickup | AD dhl_domestic_saturday_delivery | AG dhl_standard | BA dhl_globalmail_item | BB dhl_letter | BC dhl_packet | BD dhl_letter_plus | BE dhl_packet_plus | BF dhl_elevated_risk | CA dhl_restricted_destination | CB dhl_security_validation | CC dhl_secure_protection | CD dhl_proof_of_identity | CE dhl_secure_storage | CF dhl_diplomatic_material | CG dhl_smart_sensor | CH dhl_visa_program | CI dhl_onboard_courier | CJ dhl_secure_safebox | CK dhl_smart_sentry | CL dhl_split_duties_and_tax | DC dhl_duties_and_taxes_paid | DD dhl_receiver_paid | DE dhl_duties_and_taxes_unpaid | DS dhl_import_billing | DT dhl_importer_of_record | DU dhl_go_green_carbon_neutral | EA dhl_go_green_carbon_footprint | EB dhl_go_green_carbon_estimate | EC dhl_fuel_surcharge_b | FB dhl_fuel_surcharge_c | FC dhl_fuel_surcharge_f | FF dhl_smartphone_box | GA dhl_laptop_box | GB dhl_bottle_box | GC dhl_repacking | GD dhl_tablet_box | GE dhl_filler_material | GF dhl_packaging | GG dhl_diplomatic_bag | GH dhl_pallet_box | GI dhl_lock_box | GJ dhl_lithium_ion_pi965_section_ii | HB dhl_dry_ice_un1845 | HC dhl_lithium_ion_pi965_966_section_ii | HD dhl_dangerous_goods | HE dhl_perishable_cargo | HG dhl_excepted_quantity | HH dhl_spill_cleaning | HI dhl_consumer_commodities | HK dhl_limited_quantities_adr | HL dhl_lithium_metal_pi969_section_ii | HM dhl_adr_load_exemption | HN dhl_lithium_ion_pi967_section_ii | HV dhl_lithium_metal_pi970_section_ii | HW dhl_biological_un3373 | HY dhl_extended_liability | IB dhl_contract_insurance | IC dhl_shipment_insurance | II dhl_delivery_notification | JA dhl_pickup_notification | JC dhl_proactive_tracking | JD dhl_performance_reporting | JE dhl_prealert_notification | JY dhl_change_of_billing | KA dhl_cash_on_delivery | KB dhl_printed_invoice | KD dhl_waybill_copy | KE dhl_import_paperwork | KF dhl_payment_on_pickup | KY dhl_shipment_intercept | LA dhl_shipment_redirect | LC dhl_storage_at_facility | LE dhl_cold_storage | LG dhl_specific_routing | LH dhl_service_recovery | LV dhl_alternative_address | LW dhl_hold_for_collection | LX dhl_address_correction_a | MA dhl_address_correction_b | MB dhl_neutral_delivery | NN dhl_remote_area_pickup | OB dhl_remote_area_delivery_c | OC dhl_out_of_service_area | OE dhl_remote_area_delivery_o | OO dhl_shipment_preparation | PA dhl_shipment_labeling | PB dhl_shipment_consolidation | PC dhl_relabeling_data_entry | PD dhl_preprinted_waybill | PE dhl_piece_labelling | PS dhl_data_staging_03 | PT dhl_data_staging_06 | PU dhl_data_staging_12 | PV dhl_data_staging_24 | PW dhl_standard_pickup | PX dhl_scheduled_pickup | PY dhl_dedicated_pickup | QA dhl_early_pickup | QB dhl_late_pickup | QD dhl_residential_pickup | QE dhl_loading_waiting | QF dhl_bypass_injection | QH dhl_direct_injection | QI dhl_drop_off_at_facility | QY dhl_delivery_signature | SA dhl_content_signature | SB dhl_named_signature | SC dhl_adult_signature | SD dhl_contract_signature | SE dhl_alternative_signature | SW dhl_no_signature_required | SX dhl_dedicated_delivery | TA dhl_early_delivery | TB dhl_time_window_delivery | TC dhl_evening_delivery | TD dhl_delivery_on_appointment | TE dhl_return_undeliverable | TG dhl_swap_delivery | TH dhl_unloading_waiting | TJ dhl_residential_delivery | TK dhl_repeat_delivery | TN dhl_alternative_date | TT dhl_no_partial_delivery | TU dhl_service_point_24_7 | TV dhl_pre_9_00 | TW dhl_pre_10_30 | TX dhl_pre_12_00 | TY dhl_thermo_packaging | UA dhl_ambient_vialsafe | UB dhl_ambient_non_insulated | UC dhl_ambient_insulated | UD dhl_ambient_extreme | UE dhl_chilled_box_s | UF dhl_chilled_box_m | UG dhl_chilled_box_l | UH dhl_frozen_no_ice_s | UI dhl_frozen_no_ice_m | UJ dhl_frozen_no_ice_l | UK dhl_frozen_ice_sticks_s | UL dhl_frozen_ice_sticks_m | UM dhl_frozen_ice_sticks_l | UN dhl_frozen_ice_plates_s | UO dhl_frozen_ice_plates_m | UP dhl_frozen_ice_plates_l | UQ dhl_combination_no_ice | UR dhl_combination_dry_ice | US dhl_frozen_ice_sticks_e | UT dhl_frozen_ice_plates_e | UV dhl_customer_tcp_1 | UW dhl_thermo_accessories | VA dhl_absorbent_sleeve | VB dhl_cooland_wrap | VC dhl_dry_ice_supplies | VD dhl_pressure_bag_s | VE dhl_pressure_bag_m | VF dhl_pressure_bag_l | VG dhl_informal_clearance | WA dhl_formal_clearance | WB dhl_payment_deferment | WC dhl_clearance_authorization | WD dhl_multiline_entry | WE dhl_post_clearance_modification | WF dhl_handover_to_broker | WG dhl_physical_intervention | WH dhl_bio_phyto_veterinary_controls | WI dhl_obtaining_permits_and_licences | WJ dhl_bonded_storage | WK dhl_bonded_transit_documents | WL dhl_temporary_import_export | WM dhl_under_bond_guarantee | WN dhl_export_declaration | WO dhl_exporter_validation | WP dhl_certificate_of_origin | WQ dhl_document_translation | WR dhl_personal_effects | WS dhl_paperless_trade | WY dhl_import_export_taxes | XB dhl_unrecoverable_origin_tax | XC dhl_quarantine_inspection | XD dhl_merchandise_process | XE dhl_domestic_postal_tax | XF dhl_tier_two_tax | XG dhl_tier_three_tax | XH dhl_import_penalty | XI dhl_cargo_zone_process | XJ dhl_import_export_duties | XX dhl_premium_09_00 | Y1 dhl_premium_10_30 | Y2 dhl_premium_12_00 | Y3 dhl_over_sized_piece_b | YB dhl_over_handled_piece_c | YC dhl_multipiece_shipment | YE dhl_over_weight_piece_f | YF dhl_over_sized_piece_g | YG dhl_over_handled_piece_h | YH dhl_premium_9_00_i | YI dhl_premium_10_30_j | YJ dhl_premium_12_00_k | YK dhl_paket_shipment | YV dhl_breakbulk_mother | YW dhl_breakbulk_baby | YX dhl_over_weight_piece_y | YY dhl_customer_claim | ZA dhl_damage_compensation | ZB dhl_loss_compensation | ZC dhl_customer_rebate | ZD dhl_e_com_discount | ZE

### FedEx
Code | Identifier --- | --- blind_shipment | BLIND_SHIPMENT broker_select_option | BROKER_SELECT_OPTION call_before_delivery | CALL_BEFORE_DELIVERY cod | COD cod_remittance | COD_REMITTANCE custom_delivery_window | CUSTOM_DELIVERY_WINDOW cut_flowers | CUT_FLOWERS dangerous_goods | DANGEROUS_GOODS delivery_on_invoice_acceptance | DELIVERY_ON_INVOICE_ACCEPTANCE detention | DETENTION do_not_break_down_pallets | DO_NOT_BREAK_DOWN_PALLETS do_not_stack_pallets | DO_NOT_STACK_PALLETS dry_ice | DRY_ICE east_coast_special | EAST_COAST_SPECIAL electronic_trade_documents | ELECTRONIC_TRADE_DOCUMENTS event_notification | EVENT_NOTIFICATION exclude_from_consolidation | EXCLUDE_FROM_CONSOLIDATION exclusive_use | EXCLUSIVE_USE exhibition_delivery | EXHIBITION_DELIVERY exhibition_pickup | EXHIBITION_PICKUP expedited_alternate_delivery_route | EXPEDITED_ALTERNATE_DELIVERY_ROUTE expedited_one_day_earlier | EXPEDITED_ONE_DAY_EARLIER expedited_service_monitoring_and_delivery | EXPEDITED_SERVICE_MONITORING_AND_DELIVERY expedited_standard_day_early_delivery | EXPEDITED_STANDARD_DAY_EARLY_DELIVERY extra_labor | EXTRA_LABOR extreme_length | EXTREME_LENGTH fedex_one_rate | FEDEX_ONE_RATE flatbed_trailer | FLATBED_TRAILER food | FOOD freight_guarantee | FREIGHT_GUARANTEE freight_to_collect | FREIGHT_TO_COLLECT future_day_shipment | FUTURE_DAY_SHIPMENT hold_at_location | HOLD_AT_LOCATION holiday_delivery | HOLIDAY_DELIVERY holiday_guarantee | HOLIDAY_GUARANTEE home_delivery_premium | HOME_DELIVERY_PREMIUM inside_delivery | INSIDE_DELIVERY inside_pickup | INSIDE_PICKUP international_controlled_export_service | INTERNATIONAL_CONTROLLED_EXPORT_SERVICE international_mail_service | INTERNATIONAL_MAIL_SERVICE international_traffic_in_arms_regulations | INTERNATIONAL_TRAFFIC_IN_ARMS_REGULATIONS liftgate_delivery | LIFTGATE_DELIVERY liftgate_pickup | LIFTGATE_PICKUP limited_access_delivery | LIMITED_ACCESS_DELIVERY limited_access_pickup | LIMITED_ACCESS_PICKUP marking_or_tagging | MARKING_OR_TAGGING non_business_time | NON_BUSINESS_TIME pallet_shrinkwrap | PALLET_SHRINKWRAP pallet_weight_allowance | PALLET_WEIGHT_ALLOWANCE pallets_provided | PALLETS_PROVIDED pending_complete | PENDING_COMPLETE pending_shipment | PENDING_SHIPMENT permit | PERMIT pharmacy_delivery | PHARMACY_DELIVERY poison | POISON port_delivery | PORT_DELIVERY port_pickup | PORT_PICKUP pre_delivery_notification | PRE_DELIVERY_NOTIFICATION pre_eig_processing | PRE_EIG_PROCESSING pre_multiplier_processing | PRE_MULTIPLIER_PROCESSING protection_from_freezing | PROTECTION_FROM_FREEZING regional_mall_delivery | REGIONAL_MALL_DELIVERY regional_mall_pickup | REGIONAL_MALL_PICKUP return_shipment | RETURN_SHIPMENT returns_clearance | RETURNS_CLEARANCE returns_clearance_special_routing_required | RETURNS_CLEARANCE_SPECIAL_ROUTING_REQUIRED saturday_delivery | SATURDAY_DELIVERY saturday_pickup | SATURDAY_PICKUP shipment_assembly | SHIPMENT_ASSEMBLY sort_and_segregate | SORT_AND_SEGREGATE special_delivery | SPECIAL_DELIVERY special_equipment | SPECIAL_EQUIPMENT storage | STORAGE sunday_delivery | SUNDAY_DELIVERY third_party_consignee | THIRD_PARTY_CONSIGNEE top_load | TOP_LOAD usps_delivery | USPS_DELIVERY usps_pickup | USPS_PICKUP weighing | WEIGHING

### Purolator
Code | Identifier --- | --- dangerous_goods | Dangerous Goods chain_of_signature | Chain of Signature express_cheque | ExpressCheque hold_for_pickup | Hold For Pickup return_services | Return Services saturday_service | Saturday Service origin_signature_not_required | Origin Signature Not Required (OSNR) adult_signature_required | Adult Signature Required (ASR) special_handling | Special Handling

### UPS
Code | Identifier --- | --- saturday_delivery_indicator | SaturdayDeliveryIndicator access_point_cod | AccessPointCOD deliver_to_addressee_only_indicator | DeliverToAddresseeOnlyIndicator direct_delivery_only_indicator | DirectDeliveryOnlyIndicator cod | COD delivery_confirmation | DeliveryConfirmation return_of_document_indicator | ReturnOfDocumentIndicator up_scarbonneutral_indicator | UPScarbonneutralIndicator certificate_of_origin_indicator | CertificateOfOriginIndicator pickup_options | PickupOptions delivery_options | DeliveryOptions restricted_articles | RestrictedArticles shipper_export_declaration_indicator | ShipperExportDeclarationIndicator commercial_invoice_removal_indicator | CommercialInvoiceRemovalIndicator import_control | ImportControl return_service | ReturnService sdl_shipment_indicator | SDLShipmentIndicator epra_indicator | EPRAIndicator

### Freightcom
Code | Identifier --- | --- freightcom_saturday_pickup_required | saturdayPickupRequired freightcom_homeland_security | homelandSecurity freightcom_exhibition_convention_site | exhibitionConventionSite freightcom_military_base_delivery | militaryBaseDelivery freightcom_customs_in_bond_freight | customsIn_bondFreight freightcom_limited_access | limitedAccess freightcom_excess_length | excessLength freightcom_tailgate_pickup | tailgatePickup freightcom_residential_pickup | residentialPickup freightcom_cross_border_fee | crossBorderFee freightcom_notify_recipient | notifyRecipient freightcom_single_shipment | singleShipment freightcom_tailgate_delivery | tailgateDelivery freightcom_residential_delivery | residentialDelivery freightcom_insurance_type | insuranceType freightcom_inside_delivery | insideDelivery freightcom_is_saturday_service | isSaturdayService freightcom_dangerous_goods_type | dangerousGoodsType freightcom_stackable | stackable

### eShipper
Code | Identifier --- | --- eshipper_saturday_pickup_required | saturdayPickupRequired eshipper_homeland_security | homelandSecurity eshipper_exhibition_convention_site | exhibitionConventionSite eshipper_military_base_delivery | militaryBaseDelivery eshipper_customs_in_bond_freight | customsIn_bondFreight eshipper_limited_access | limitedAccess eshipper_excess_length | excessLength eshipper_tailgate_pickup | tailgatePickup eshipper_residential_pickup | residentialPickup eshipper_cross_border_fee | crossBorderFee eshipper_notify_recipient | notifyRecipient eshipper_single_shipment | singleShipment eshipper_tailgate_delivery | tailgateDelivery eshipper_residential_delivery | residentialDelivery eshipper_insurance_type | insuranceType eshipper_inside_delivery | insideDelivery eshipper_is_saturday_service | isSaturdayService eshipper_dangerous_goods_type | dangerousGoodsType eshipper_stackable | stackable


## Shipment Services
### Canada Post
Code | Identifier --- | --- canadapost_regular_parcel | DOM.RP canadapost_expedited_parcel | DOM.EP canadapost_xpresspost | DOM.XP canadapost_priority | DOM.PC canadapost_library_books | DOM.LIB canadapost_expedited_parcel_usa | USA.EP canadapost_priority_worldwide_envelope_usa | USA.PW.ENV canadapost_priority_worldwide_pak_usa | USA.PW.PAK canadapost_priority_worldwide_parcel_usa | USA.PW.PARCEL canadapost_small_packet_usa_air | USA.SP.AIR canadapost_tracked_packet_usa | USA.TP canadapost_tracked_packet_usa_lvm | USA.TP.LVM canadapost_xpresspost_usa | USA.XP canadapost_xpresspost_international | INT.XP canadapost_international_parcel_air | INT.IP.AIR canadapost_international_parcel_surface | INT.IP.SURF canadapost_priority_worldwide_envelope_intl | INT.PW.ENV canadapost_priority_worldwide_pak_intl | INT.PW.PAK canadapost_priority_worldwide_parcel_intl | INT.PW.PARCEL canadapost_small_packet_international_air | INT.SP.AIR canadapost_small_packet_international_surface | INT.SP.SURF canadapost_tracked_packet_international | INT.TP

### DHL
Code | Identifier --- | --- dhl_logistics_services | LOGISTICS SERVICES dhl_domestic_express_12_00_doc | DOMESTIC EXPRESS 12:00 DOC dhl_b2_c_doc | B2C DOC dhl_b2_c_nondoc | B2C NONDOC dhl_jetline | JETLINE dhl_sprintline | SPRINTLINE dhl_express_easy_doc | EXPRESS EASY DOC dhl_express_easy_nondoc | EXPRESS EASY NONDOC dhl_europack_doc | EUROPACK DOC dhl_auto_reversals | AUTO REVERSALS dhl_breakbulk_express_doc | BREAKBULK EXPRESS DOC dhl_medical_express_doc | MEDICAL EXPRESS DOC dhl_express_worldwide_doc | EXPRESS WORLDWIDE DOC dhl_express_9_00_nondoc | EXPRESS 9:00 NONDOC dhl_freight_worldwide_nondoc | FREIGHT WORLDWIDE NONDOC dhl_domestic_economy_select_doc | DOMESTIC ECONOMY SELECT DOC dhl_economy_select_nondoc | ECONOMY SELECT NONDOC dhl_domestic_express_9_00_doc | DOMESTIC EXPRESS 9:00 DOC dhl_jumbo_box_nondoc | JUMBO BOX NONDOC dhl_express_9_00_doc | EXPRESS 9:00 DOC dhl_express_10_30_doc | EXPRESS 10:30 DOC dhl_express_10_30_nondoc | EXPRESS 10:30 NONDOC dhl_domestic_express_doc | DOMESTIC EXPRESS DOC dhl_domestic_express_10_30_doc | DOMESTIC EXPRESS 10:30 DOC dhl_express_worldwide_nondoc | EXPRESS WORLDWIDE NONDOC dhl_medical_express_nondoc | MEDICAL EXPRESS NONDOC dhl_globalmail_business_doc | GLOBALMAIL BUSINESS DOC dhl_same_day_doc | SAME DAY DOC dhl_express_12_00_doc | EXPRESS 12:00 DOC dhl_europack_nondoc | EUROPACK NONDOC dhl_economy_select_doc | ECONOMY SELECT DOC dhl_express_envelope_doc | EXPRESS ENVELOPE DOC dhl_express_12_00_nondoc | EXPRESS 12:00 NONDOC dhl_destination_charges | Destination Charges

### FedEx
Code | Identifier --- | --- europe_first_international_priority | EUROPE_FIRST_INTERNATIONAL_PRIORITY fedex_1_day_freight | FEDEX_1_DAY_FREIGHT fedex_2_day | FEDEX_2_DAY fedex_2_day_am | FEDEX_2_DAY_AM fedex_2_day_freight | FEDEX_2_DAY_FREIGHT fedex_3_day_freight | FEDEX_3_DAY_FREIGHT fedex_cargo_airport_to_airport | FEDEX_CARGO_AIRPORT_TO_AIRPORT fedex_cargo_freight_forwarding | FEDEX_CARGO_FREIGHT_FORWARDING fedex_cargo_international_express_freight | FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT fedex_cargo_international_premium | FEDEX_CARGO_INTERNATIONAL_PREMIUM fedex_cargo_mail | FEDEX_CARGO_MAIL fedex_cargo_registered_mail | FEDEX_CARGO_REGISTERED_MAIL fedex_cargo_surface_mail | FEDEX_CARGO_SURFACE_MAIL fedex_custom_critical_air_expedite | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE fedex_custom_critical_air_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_air_expedite_network | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK fedex_custom_critical_charter_air | FEDEX_CUSTOM_CRITICAL_CHARTER_AIR fedex_custom_critical_point_to_point | FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT fedex_custom_critical_surface_expedite | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE fedex_custom_critical_surface_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_temp_assure_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR fedex_custom_critical_temp_assure_validated_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR fedex_custom_critical_white_glove_services | FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES fedex_distance_deferred | FEDEX_DISTANCE_DEFERRED fedex_express_saver | FEDEX_EXPRESS_SAVER fedex_first_freight | FEDEX_FIRST_FREIGHT fedex_freight_economy | FEDEX_FREIGHT_ECONOMY fedex_freight_priority | FEDEX_FREIGHT_PRIORITY fedex_ground | FEDEX_GROUND fedex_international_priority_plus | FEDEX_INTERNATIONAL_PRIORITY_PLUS fedex_next_day_afternoon | FEDEX_NEXT_DAY_AFTERNOON fedex_next_day_early_morning | FEDEX_NEXT_DAY_EARLY_MORNING fedex_next_day_end_of_day | FEDEX_NEXT_DAY_END_OF_DAY fedex_next_day_freight | FEDEX_NEXT_DAY_FREIGHT fedex_next_day_mid_morning | FEDEX_NEXT_DAY_MID_MORNING first_overnight | FIRST_OVERNIGHT ground_home_delivery | GROUND_HOME_DELIVERY international_distribution_freight | INTERNATIONAL_DISTRIBUTION_FREIGHT international_economy | INTERNATIONAL_ECONOMY international_economy_distribution | INTERNATIONAL_ECONOMY_DISTRIBUTION international_economy_freight | INTERNATIONAL_ECONOMY_FREIGHT international_first | INTERNATIONAL_FIRST international_ground | INTERNATIONAL_GROUND international_priority | INTERNATIONAL_PRIORITY international_priority_distribution | INTERNATIONAL_PRIORITY_DISTRIBUTION international_priority_express | INTERNATIONAL_PRIORITY_EXPRESS international_priority_freight | INTERNATIONAL_PRIORITY_FREIGHT priority_overnight | PRIORITY_OVERNIGHT same_day | SAME_DAY same_day_city | SAME_DAY_CITY same_day_metro_afternoon | SAME_DAY_METRO_AFTERNOON same_day_metro_morning | SAME_DAY_METRO_MORNING same_day_metro_rush | SAME_DAY_METRO_RUSH smart_post | SMART_POST standard_overnight | STANDARD_OVERNIGHT transborder_distribution_consolidation | TRANSBORDER_DISTRIBUTION_CONSOLIDATION

### Purolator
Code | Identifier --- | --- purolator_express_9_am | PurolatorExpress9AM purolator_express_us | PurolatorExpressU.S. purolator_express_10_30_am | PurolatorExpress10:30AM purolator_express_us_9_am | PurolatorExpressU.S.9AM purolator_express_12_pm | PurolatorExpress12PM purolator_express_us_10_30_am | PurolatorExpressU.S.10:30AM purolator_express | PurolatorExpress purolator_express_us_12_00 | PurolatorExpressU.S.12:00 purolator_express_evening | PurolatorExpressEvening purolator_express_envelope_us | PurolatorExpressEnvelopeU.S. purolator_express_envelope_9_am | PurolatorExpressEnvelope9AM purolator_express_us_envelope_9_am | PurolatorExpressU.S.Envelope9AM purolator_express_envelope_10_30_am | PurolatorExpressEnvelope10:30AM purolator_express_us_envelope_10_30_am | PurolatorExpressU.S.Envelope10:30AM purolator_express_envelope_12_pm | PurolatorExpressEnvelope12PM purolator_express_us_envelope_12_00 | PurolatorExpressU.S.Envelope12:00 purolator_express_envelope | PurolatorExpressEnvelope purolator_express_pack_us | PurolatorExpressPackU.S. purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening purolator_express_us_pack_9_am | PurolatorExpressU.S.Pack9AM purolator_express_pack_9_am | PurolatorExpressPack9AM purolator_express_us_pack_10_30_am | PurolatorExpressU.S.Pack10:30AM purolator_express_pack10_30_am | PurolatorExpressPack10:30AM purolator_express_us_pack_12_00 | PurolatorExpressU.S.Pack12:00 purolator_express_pack_12_pm | PurolatorExpressPack12PM purolator_express_box_us | PurolatorExpressBoxU.S. purolator_express_pack | PurolatorExpressPack purolator_express_us_box_9_am | PurolatorExpressU.S.Box9AM purolator_express_pack_evening | PurolatorExpressPackEvening purolator_express_us_box_10_30_am | PurolatorExpressU.S.Box10:30AM purolator_express_box_9_am | PurolatorExpressBox9AM purolator_express_us_box_12_00 | PurolatorExpressU.S.Box12:00 purolator_express_box_10_30_am | PurolatorExpressBox10:30AM purolator_ground_us | PurolatorGroundU.S. purolator_express_box_12_pm | PurolatorExpressBox12PM purolator_express_international | PurolatorExpressInternational purolator_express_box | PurolatorExpressBox purolator_express_international_9_am | PurolatorExpressInternational9AM purolator_express_box_evening | PurolatorExpressBoxEvening purolator_express_international_10_30_am | PurolatorExpressInternational10:30AM purolator_ground | PurolatorGround purolator_express_international_12_00 | PurolatorExpressInternational12:00 purolator_ground9_am | PurolatorGround9AM purolator_express_envelope_international | PurolatorExpressEnvelopeInternational purolator_ground10_30_am | PurolatorGround10:30AM purolator_express_international_envelope_9_am | PurolatorExpressInternationalEnvelope9AM purolator_ground_evening | PurolatorGroundEvening purolator_express_international_envelope_10_30_am | PurolatorExpressInternationalEnvelope10:30AM purolator_quick_ship | PurolatorQuickShip purolator_express_international_envelope_12_00 | PurolatorExpressInternationalEnvelope12:00 purolator_quick_ship_envelope | PurolatorQuickShipEnvelope purolator_express_pack_international | PurolatorExpressPackInternational purolator_quick_ship_pack | PurolatorQuickShipPack purolator_express_international_pack_9_am | PurolatorExpressInternationalPack9AM purolator_quick_ship_box | PurolatorQuickShipBox purolator_express_international_pack_10_30_am | PurolatorExpressInternationalPack10:30AM purolator_express_international_pack_12_00 | PurolatorExpressInternationalPack12:00 purolator_express_box_international | PurolatorExpressBoxInternational purolator_express_international_box_9_am | PurolatorExpressInternationalBox9AM purolator_express_international_box_10_30_am | PurolatorExpressInternationalBox10:30AM purolator_express_international_box_12_00 | PurolatorExpressInternationalBox12:00

### UPS
Code | Identifier --- | --- ups_standard | 11 ups_worldwide_expedited | 08 ups_worldwide_express | 07 ups_worldwide_express_plus | 54 ups_worldwide_saver | 65 ups_2nd_day_air | 02 ups_2nd_day_air_am | 59 ups_3_day_select | 12 ups_expedited_mail_innovations | M4 ups_first_class_mail | M2 ups_ground | 03 ups_next_day_air | 01 ups_next_day_air_early | 14 ups_next_day_air_saver | 13 ups_priority_mail | M3 ups_access_point_economy | 70 ups_today_dedicated_courier | 83 ups_today_express | 85 ups_today_express_saver | 86 ups_today_standard | 82 ups_worldwide_express_freight | 96 ups_priority_mail_innovations | M5 ups_economy_mail_innovations | M6

### Freightcom
Code | Identifier --- | --- freightcom_central_transport | 2029 freigthcom_estes | 2107 freigthcom_usf_holland | 1911 freightcom_fedex_ground | 4101 freightcom_ups_standard | 4600 freightcom_fedex_2_day | 4102 freightcom_fedex_priority_overnight | 4104 freightcom_fedex_standard_overnight | 4105 freightcom_ground | 3400 freightcom_ups_expedited | 4601 freightcom_ups_express_saver | 4602 freightcom_ups_express | 4603 freightcom_fedex_express_saver | 4100 freightcom_ups_express_early | 4604 freightcom_select | 3404 freightcom_dayr_e_comm_ground_service | 5707 freightcom_overnight | 3407 freightcom_purolator_ground | 4000 freightcom_purolator_express | 4003 freightcom_purolator_express_10_30_am | 4005 freightcom_fedex_first_overnight | 4106 freightcom_purolator_express_9_am | 4004 freightcom_dayr_e_comm_am_service | 5706

### eShipper
Code | Identifier --- | --- eshipper_fedex_priority | 1 eshipper_fedex_first_overnight | 2 eshipper_fedex_ground | 3 eshipper_fedex_standard_overnight | 28 eshipper_fedex_2nd_day | 29 eshipper_fedex_express_saver | 30 eshipper_purolator_air | 4 eshipper_purolator_air_9_am | 5 eshipper_purolator_air_10_30 | 6 eshipper_puroletter | 7 eshipper_puroletter_9_am | 8 eshipper_puroletter_10_30 | 9 eshipper_puro_pak | 10 eshipper_puro_pak_9_am | 11 eshipper_puro_pak_10_30 | 12 eshipper_purolator_ground | 13 eshipper_purolator_ground_9_am | 19 eshipper_purolator_ground_10_30 | 20 eshipper_canada_worldwide_same_day | 14 eshipper_canada_worldwide_next_flight_out | 15 eshipper_canada_worldwide_air_freight | 16 eshipper_canada_worldwide_ltl | 17 eshipper_dhl_international_express | 106 eshipper_ups_express_next_day_air | 600 eshipper_ups_expedited_second_day_air | 601 eshipper_ups_worldwide_express | 602 eshipper_ups_worldwide_expedited | 603 eshipper_ups_standard_ground | 604 eshipper_ups_express_early_am_next_day_air_early_am | 605 eshipper_ups_three_day_select | 606 eshipper_ups_saver | 607 eshipper_ups_ground | 608 eshipper_next_day_saver | 609 eshipper_worldwide_express_plus | 610 eshipper_second_day_air_am | 611 eshipper_canada_post_priority | 500 eshipper_canada_post_xpress_post | 501 eshipper_canada_post_expedited | 502 eshipper_canada_post_regular | 503 eshipper_canada_post_xpress_post_usa | 504 eshipper_canada_post_xpress_post_intl | 505 eshipper_canada_post_air_parcel_intl | 506 eshipper_canada_post_surface_parcel_intl | 507 eshipper_canada_post_expedited_parcel_usa | 508 eshipper_tst_ltl | 1100 eshipper_ltl_chicago_suburban_express | 1500 eshipper_ltl_fedex_freight_east | 1501 eshipper_ltl_fedex_freight_west | 1502 eshipper_ltl_mid_states_express | 1503 eshipper_ltl_new_england_motor_freight | 1504 eshipper_ltl_new_penn | 1505 eshipper_ltl_oak_harbor | 1506 eshipper_ltl_pitt_ohio | 1507 eshipper_ltl_r_l_carriers | 1508 eshipper_ltl_saia | 1509 eshipper_ltl_usf_reddaway | 1510 eshipper_ltl_vitran_express | 1511 eshipper_ltl_wilson_trucking | 1512 eshipper_ltl_yellow_transportation | 1513 eshipper_ltl_roadway | 1514 eshipper_ltl_fedex_national | 1515 eshipper_wilson_trucking_tfc | 1800 eshipper_aaa_cooper_transportation | 1801 eshipper_roadrunner_dawes | 1802 eshipper_new_england_motor_freight | 1803 eshipper_new_penn_motor_express | 1804 eshipper_dayton_freight | 1805 eshipper_southeastern_freightway | 1806 eshipper_saia_inc | 1807 eshipper_conway | 1808 eshipper_roadway | 1809 eshipper_usf_reddaway | 1810 eshipper_usf_holland | 1811 eshipper_dependable_highway_express | 1812 eshipper_day_and_ross | 1813 eshipper_day_and_ross_r_and_l | 1814 eshipper_ups | 1815 eshipper_aaa_cooper | 1816 eshipper_ama_transportation | 1817 eshipper_averitt_express | 1818 eshipper_central_freight | 1819 eshipper_conway_us | 1820 eshipper_dayton | 1821 eshipper_drug_transport | 1822 eshipper_estes | 1823 eshipper_land_air_express | 1824 eshipper_fedex_west | 1825 eshipper_fedex_national | 1826 eshipper_usf_holland_us | 1827 eshipper_lakeville_m_express | 1828 eshipper_milan_express | 1829 eshipper_nebraska_transport | 1830 eshipper_new_england | 1831 eshipper_new_penn | 1832 eshipper_a_duie_pyle | 1833 eshipper_roadway_us | 1834 eshipper_usf_reddaway_us | 1835 eshipper_rhody_transportation | 1836 eshipper_saia_motor_freight | 1837 eshipper_southeastern_frgt | 1838 eshipper_pitt_ohio | 1839 eshipper_ward | 1840 eshipper_wilson | 1841 eshipper_chi_cargo | 1842 eshipper_tax_air | 1843 eshipper_fedex_east | 1844 eshipper_central_transport | 1845 eshipper_roadrunner | 1846 eshipper_r_and_l_carriers | 1847 eshipper_estes_us | 1848 eshipper_yrc_roadway | 1849 eshipper_central_transport_us | 1850 eshipper_absolute_transportation_services | 1851 eshipper_blue_sky_express | 1852 eshipper_galasso_trucking | 1853 eshipper_griley_air_freight | 1854 eshipper_jet_transportation | 1855 eshipper_metro_transportation_logistics | 1856 eshipper_oak_harbor | 1857 eshipper_stream_links_express | 1858 eshipper_tiffany_trucking | 1859 eshipper_ups_freight | 1860 eshipper_roadrunner_us | 1861 eshipper_global_mail_parcel_priority | 3500 eshipper_global_mail_parcel_standard | 3501 eshipper_global_mail_packet_plus_priority | 3502 eshipper_global_mail_packet_priority | 3503 eshipper_global_mail_packet_standard | 3504 eshipper_global_mail_business_priority | 3505 eshipper_global_mail_business_standard | 3506 eshipper_global_mail_parcel_direct_priority | 3507 eshipper_global_mail_parcel_direct_standard | 3508 eshipper_ground | 4500 eshipper_select_parcel | 4504 eshipper_express_parcel | 4507


# noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.references(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: References - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.references_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.references_with_http_info(**kwargs) # noqa: E501 - return data - - def references_with_http_info(self, **kwargs): # noqa: E501 - """Get all References # noqa: E501 - - ## Countries
Code | Name --- | --- AD | ANDORRA AE | UNITED ARAB EMIRATES AF | AFGHANISTAN AG | ANTIGUA AI | ANGUILLA AL | ALBANIA AM | ARMENIA AN | NETHERLANDS ANTILLES AO | ANGOLA AR | ARGENTINA AS | AMERICAN SAMOA AT | AUSTRIA AU | AUSTRALIA AW | ARUBA AZ | AZERBAIJAN BA | BOSNIA AND HERZEGOVINA BB | BARBADOS BD | BANGLADESH BE | BELGIUM BF | BURKINA FASO BG | BULGARIA BH | BAHRAIN BI | BURUNDI BJ | BENIN BM | BERMUDA BN | BRUNEI BO | BOLIVIA BR | BRAZIL BS | BAHAMAS BT | BHUTAN BW | BOTSWANA BY | BELARUS BZ | BELIZE CA | CANADA CD | CONGO, THE DEMOCRATIC REPUBLIC OF CF | CENTRAL AFRICAN REPUBLIC CG | CONGO CH | SWITZERLAND CI | COTE D IVOIRE CK | COOK ISLANDS CL | CHILE CM | CAMEROON CN | CHINA, PEOPLES REPUBLIC CO | COLOMBIA CR | COSTA RICA CU | CUBA CV | CAPE VERDE CY | CYPRUS CZ | CZECH REPUBLIC, THE DE | GERMANY DJ | DJIBOUTI DK | DENMARK DM | DOMINICA DO | DOMINICAN REPUBLIC DZ | ALGERIA EC | ECUADOR EE | ESTONIA EG | EGYPT ER | ERITREA ES | SPAIN ET | ETHIOPIA FI | FINLAND FJ | FIJI FK | FALKLAND ISLANDS FM | MICRONESIA, FEDERATED STATES OF FO | FAROE ISLANDS FR | FRANCE GA | GABON GB | UNITED KINGDOM GD | GRENADA GE | GEORGIA GF | FRENCH GUYANA GG | GUERNSEY GH | GHANA GI | GIBRALTAR GL | GREENLAND GM | GAMBIA GN | GUINEA REPUBLIC GP | GUADELOUPE GQ | GUINEA-EQUATORIAL GR | GREECE GT | GUATEMALA GU | GUAM GW | GUINEA-BISSAU GY | GUYANA (BRITISH) HK | HONG KONG HN | HONDURAS HR | CROATIA HT | HAITI HU | HUNGARY IC | CANARY ISLANDS, THE ID | INDONESIA IE | IRELAND, REPUBLIC OF IL | ISRAEL IN | INDIA IQ | IRAQ IR | IRAN (ISLAMIC REPUBLIC OF) IS | ICELAND IT | ITALY JE | JERSEY JM | JAMAICA JO | JORDAN JP | JAPAN KE | KENYA KG | KYRGYZSTAN KH | CAMBODIA KI | KIRIBATI KM | COMOROS KN | ST. KITTS KP | KOREA, THE D.P.R OF (NORTH K.) KR | KOREA, REPUBLIC OF (SOUTH K.) KV | KOSOVO KW | KUWAIT KY | CAYMAN ISLANDS KZ | KAZAKHSTAN LA | LAO PEOPLES DEMOCRATIC REPUBLIC LB | LEBANON LC | ST. LUCIA LI | LIECHTENSTEIN LK | SRI LANKA LR | LIBERIA LS | LESOTHO LT | LITHUANIA LU | LUXEMBOURG LV | LATVIA LY | LIBYA MA | MOROCCO MC | MONACO MD | MOLDOVA, REPUBLIC OF ME | MONTENEGRO, REPUBLIC OF MG | MADAGASCAR MH | MARSHALL ISLANDS MK | MACEDONIA, REPUBLIC OF ML | MALI MM | MYANMAR MN | MONGOLIA MO | MACAU MP | COMMONWEALTH NO. MARIANA ISLANDS MQ | MARTINIQUE MR | MAURITANIA MS | MONTSERRAT MT | MALTA MU | MAURITIUS MV | MALDIVES MW | MALAWI MX | MEXICO MY | MALAYSIA MZ | MOZAMBIQUE NA | NAMIBIA NC | NEW CALEDONIA NE | NIGER NG | NIGERIA NI | NICARAGUA NL | NETHERLANDS, THE NO | NORWAY NP | NEPAL NR | NAURU, REPUBLIC OF NU | NIUE NZ | NEW ZEALAND OM | OMAN PA | PANAMA PE | PERU PF | TAHITI PG | PAPUA NEW GUINEA PH | PHILIPPINES, THE PK | PAKISTAN PL | POLAND PR | PUERTO RICO PT | PORTUGAL PW | PALAU PY | PARAGUAY QA | QATAR RE | REUNION, ISLAND OF RO | ROMANIA RS | SERBIA, REPUBLIC OF RU | RUSSIAN FEDERATION, THE RW | RWANDA SA | SAUDI ARABIA SB | SOLOMON ISLANDS SC | SEYCHELLES SD | SUDAN SE | SWEDEN SG | SINGAPORE SH | SAINT HELENA SI | SLOVENIA SK | SLOVAKIA SL | SIERRA LEONE SM | SAN MARINO SN | SENEGAL SO | SOMALIA SR | SURINAME SS | SOUTH SUDAN ST | SAO TOME AND PRINCIPE SV | EL SALVADOR SY | SYRIA SZ | SWAZILAND TC | TURKS AND CAICOS ISLANDS TD | CHAD TG | TOGO TH | THAILAND TJ | TAJIKISTAN TL | TIMOR LESTE TN | TUNISIA TO | TONGA TR | TURKEY TT | TRINIDAD AND TOBAGO TV | TUVALU TW | TAIWAN TZ | TANZANIA UA | UKRAINE UG | UGANDA US | UNITED STATES OF AMERICA UY | URUGUAY UZ | UZBEKISTAN VA | VATICAN CITY STATE VC | ST. VINCENT VE | VENEZUELA VG | VIRGIN ISLANDS (BRITISH) VI | VIRGIN ISLANDS (US) VN | VIETNAM VU | VANUATU WS | SAMOA XB | BONAIRE XC | CURACAO XE | ST. EUSTATIUS XM | ST. MAARTEN XN | NEVIS XS | SOMALILAND, REP OF (NORTH SOMALIA) XY | ST. BARTHELEMY YE | YEMEN, REPUBLIC OF YT | MAYOTTE ZA | SOUTH AFRICA ZM | ZAMBIA ZW | ZIMBABWE

## States and Provinces
### UNITED ARAB EMIRATES
Code | Name --- | --- AB | Abu Dhabi AJ | Ajman DU | Dubai FU | Fujairah RA | Ras al-Khaimah SH | Sharjah UM | Umm al-Qaiwain

### CANADA
Code | Name --- | --- AB | Alberta BC | British Columbia MB | Manitoba NB | New Brunswick NL | Newfoundland NT | Northwest Territories NS | Nova Scotia NU | Nunavut ON | Ontario PE | Prince Edward Island QC | Quebec SK | Saskatchewan YT | Yukon

### CHINA, PEOPLES REPUBLIC
Code | Name --- | --- anhui | Anhui hainan | Hainan jiangxi | Jiangxi shanghai | Shanghai beijing | Beijing hebei | Hebei jilin | Jilin shanxi | Shanxi chongqing | Chongqing heilongjiang | Heilongjiang liaoning | Liaoning sichuan | Sichuan fujian | Fujian henan | Henan nei_mongol | Nei Mongol tianjin | Tianjin gansu | Gansu hubei | Hubei qinghai | Qinghai xinjiang | Xinjiang guangdong | Guangdong hunan | Hunan shaanxi | Shaanxi yunnan | Yunnan guizhou | Guizhou jiangsu | Jiangsu shandong | Shandong zhejiang | Zhejiang

### INDIA
Code | Name --- | --- AN | Andaman & Nicobar (U.T) AP | Andhra Pradesh AR | Arunachal Pradesh AS | Assam BR | Bihar CG | Chattisgarh CH | Chandigarh (U.T.) DD | Daman & Diu (U.T.) DL | Delhi (U.T.) DN | Dadra and Nagar Haveli (U.T.) GA | Goa GJ | Gujarat HP | Himachal Pradesh HR | Haryana JH | Jharkhand JK | Jammu & Kashmir KA | Karnataka KL | Kerala LD | Lakshadweep (U.T) MH | Maharashtra ML | Meghalaya MN | Manipur MP | Madhya Pradesh MZ | Mizoram NL | Nagaland OR | Orissa PB | Punjab PY | Puducherry (U.T.) RJ | Rajasthan SK | Sikkim TN | Tamil Nadu TR | Tripura UA | Uttaranchal UP | Uttar Pradesh WB | West Bengal

### MEXICO
Code | Name --- | --- AG | Aguascalientes BC | Baja California BS | Baja California Sur CM | Campeche CS | Chiapas CH | Chihuahua CO | Coahuila CL | Colima DF | Ciudad de México DG | Durango GT | Guanajuato GR | Guerrero HG | Hidalgo JA | Jalisco EM | Estado de México MI | Michoacán MO | Morelos NA | Nayarit NL | Nuevo León OA | Oaxaca PU | Puebla QE | Querétaro QR | Quintana Roo SL | San Luis Potosí SI | Sinaloa SO | Sonora TB | Tabasco TM | Tamaulipas TL | Tlaxcala VE | Veracruz YU | Yucatán ZA | Zacatecas

### UNITED STATES OF AMERICA
Code | Name --- | --- AL | Alabama AK | Alaska AZ | Arizona AR | Arkansas CA | California CO | Colorado CT | Connecticut DE | Delaware DC | District of Columbia FL | Florida GA | Georgia HI | Hawaii ID | Idaho IL | Illinois IN | Indiana IA | Iowa KS | Kansas KY | Kentucky LA | Louisiana ME | Maine MD | Maryland MA | Massachusetts MI | Michigan MN | Minnesota MS | Mississippi MO | Missouri MT | Montana NE | Nebraska NV | Nevada NH | New Hampshire NJ | New Jersey NM | New Mexico NY | New York NC | North Carolina ND | North Dakota OH | Ohio OK | Oklahoma OR | Oregon PA | Pennsylvania RI | Rhode Island SC | South Carolina SD | South Dakota TN | Tennessee TX | Texas UT | Utah VT | Vermont VA | Virginia WA | Washington State WV | West Virginia WI | Wisconsin WY | Wyoming PR | Puerto Rico


## Currencies
Code | Name --- | --- EUR | Euro AED | UAE Dirham USD | US Dollar XCD | East Caribbean Dollar AMD | Dran ANG | Netherlands Antilles Guilder AOA | Kwanza ARS | Argentine Peso AUD | Australian Dollar AWG | Aruba Guilder AZN | Manat BAM | Convertible Marks BBD | Barbadian Dollar BDT | Taka XOF | CFA Franc West Africa BGN | Bulgarian Lev BHD | Bahraini Dinar BIF | Burundese Franc BMD | Bermudian Dollar BND | Brunei Dollar BOB | Boliviano BRL | Real BSD | Bahamian Dollar BTN | Ngultrum BWP | Pula BYN | Belarussian Ruble BZD | Belize Dollar CAD | Canadian Dollar CDF | Franc Congolais XAF | CFA Franc Central Africa CHF | Swiss Franc NZD | New Zealand Dollar CLP | New Chile Peso CNY | Yuan (Ren Min Bi) COP | Colombian Peso CRC | Costa Rican Colon CUC | Peso Convertible CVE | Cape Verde Escudo CZK | Czech Koruna DJF | Djibouti Franc DKK | Danish Krone DOP | Dominican Republic Peso DZD | Algerian Dinar EGP | Egyptian Pound ERN | Nakfa ETB | Birr FJD | Fijian Dollar GBP | Pound Sterling GEL | Georgian Lari GHS | Cedi GMD | Dalasi GNF | Guinea Franc GTQ | Quetzal GYD | Guyanan Dollar HKD | Hong Kong Dollar HNL | Lempira HRK | Croatian Kuna HTG | Gourde HUF | Forint IDR | Rupiah ILS | New Israeli Shekel INR | Indian Rupee IRR | Iranian Rial ISK | Icelandic Krona JMD | Jamaican Dollar JOD | Jordanian Dinar JPY | Yen KES | Kenyan Shilling KGS | Som KHR | Khmer Rial KMF | Comoros Franc KPW | North Korean Won KRW | Won KWD | Kuwaiti Dinar KYD | Cayman Islands Dollar KZT | Tenge LAK | Kip LKR | Sri Lankan Rupee LRD | Liberian Dollar LSL | Loti LYD | Libyan Dinar MAD | Moroccan Dirham MDL | Leu MGA | Ariary MKD | Denar MMK | Kyat MNT | Tugrik MOP | Pataca MRO | Ouguiya MUR | Mauritius Rupee MVR | Rufiyaa MWK | Kwacha MXN | Mexican Nuevo Peso MYR | Ringgit MZN | Mozambique Metical NAD | Namibian Dollar XPF | CFP Franc NGN | Naira NIO | Cordoba Oro NOK | Norwegian Krone NPR | Nepalese Rupee OMR | Omani Rial PEN | Nuevo Sol PGK | Kina PHP | Phillipines Peso PKR | Pakistani Rupee PLN | Zloty PYG | Guarani QAR | Qatar Rial RSD | Serbia, Dinars RUB | Russian Ruble RWF | Rwanda Franc SAR | Saudi Riyal SBD | Solomon Islands Dollar SCR | Seychelles Rupee SDG | Sudanese Pound SEK | Swedish Krona SGD | Singapore Dollar SHP | St. Helena Pound SLL | Leone SOS | Somali Shilling SRD | Suriname Dollar SSP | South Sudanese pound STD | Dobra SYP | Syrian Pound SZL | Lilangeni THB | Baht TJS | Somoni TND | Tunisian Dinar TOP | Pa'anga TRY | New Turkish Lira TTD | Trinidad and Tobago Dollar TWD | New Taiwan Dollar TZS | Tanzanian Shilling UAH | Hryvna UYU | Peso Uruguayo UZS | Sum VEF | Bolivar Fuerte VND | Dong VUV | Vanuatu Vatu WST | Tala YER | Yemeni Riyal ZAR | South African Rand

## Package Preset
### Canada Post
Code | Dimensions | Note --- | --- | --- canadapost_mailing_box | 15.2 x 10.2 | height x width canadapost_extra_small_mailing_box | 14.0 x 14.0 x 14.0 | height x length x width canadapost_small_mailing_box | 22.9 x 6.4 x 28.6 | height x length x width canadapost_medium_mailing_box | 23.5 x 13.3 x 31.0 | height x length x width canadapost_large_mailing_box | 30.5 x 9.5 x 38.1 | height x length x width canadapost_extra_large_mailing_box | 30.5 x 21.6 x 40.0 | height x length x width canadapost_corrugated_small_box | 32.0 x 32.0 x 42.0 | height x length x width canadapost_corrugated_medium_box | 38.0 x 32.0 x 46.0 | height x length x width canadapost_corrugated_large_box | 46.0 x 40.6 x 46.0 | height x length x width canadapost_xexpresspost_certified_envelope | 15.9 x 1.5 x 0.5 x 26.0 | height x length x weight x width canadapost_xexpresspost_national_large_envelope | 29.2 x 1.5 x 1.36 x 40.0 | height x length x weight x width

### DHL
Code | Dimensions | Note --- | --- | --- dhl_express_envelope | 27.5 x 1.0 x 0.5 x 35.0 | height x length x weight x width dhl_express_standard_flyer | 30.0 x 2.0 x 40.0 | height x weight x width dhl_express_large_flyer | 37.5 x 3.0 x 47.5 | height x weight x width dhl_express_box_2 | 18.2 x 10.0 x 1.0 x 33.7 | height x length x weight x width dhl_express_box_3 | 32.0 x 5.2 x 2.0 x 33.6 | height x length x weight x width dhl_express_box_4 | 32.2 x 18.0 x 5.0 x 33.7 | height x length x weight x width dhl_express_box_5 | 32.2 x 34.5 x 10.0 x 33.7 | height x length x weight x width dhl_express_box_6 | 35.9 x 36.9 x 15.0 x 41.7 | height x length x weight x width dhl_express_box_7 | 40.4 x 38.9 x 20.0 x 48.1 | height x length x weight x width dhl_express_box_8 | 44.4 x 40.9 x 25.0 x 54.2 | height x length x weight x width dhl_express_tube | 15.0 x 15.0 x 5.0 x 96.0 | height x length x weight x width dhl_didgeridoo_box | 13.0 x 162.0 x 10.0 x 13.0 | height x length x weight x width dhl_jumbo_box | 42.7 x 33.0 x 30.0 x 45.0 | height x length x weight x width dhl_jumbo_box_junior | 34.0 x 24.1 x 20.0 x 39.9 | height x length x weight x width

### FedEx
Code | Dimensions | Note --- | --- | --- fedex_envelope_legal_size | 15.5 x 1.0 x 9.5 | height x weight x width fedex_padded_pak | 14.75 x 2.2 x 11.75 | height x weight x width fedex_polyethylene_pak | 15.5 x 2.2 x 12.0 | height x weight x width fedex_clinical_pak | 18.0 x 2.2 x 13.5 | height x weight x width fedex_small_box | 10.9 x 1.5 x 20.0 x 12.25 | height x length x weight x width fedex_medium_box | 11.5 x 2.38 x 20.0 x 13.25 | height x length x weight x width fedex_large_box | 12.38 x 3.0 x 20.0 x 17.88 | height x length x weight x width fedex_10_kg_box | 12.94 x 10.19 x 10.0 x 15.81 | height x length x weight x width fedex_25_kg_box | 16.56 x 13.19 x 25.0 x 21.56 | height x length x weight x width fedex_tube | 6.0 x 6.0 x 20.0 x 38.0 | height x length x weight x width

### Purolator
Code | Dimensions | Note --- | --- | --- purolator_express_envelope | 1.0 | weight purolator_express_pack | 3.0 | weight purolator_express_box | 7.0 | weight

### UPS
Code | Dimensions | Note --- | --- | --- ups_small_express_box | 11.0 x 2.0 x 30.0 x 13.0 | height x length x weight x width ups_medium_express_box | 11.0 x 3.0 x 30.0 x 16.0 | height x length x weight x width ups_large_express_box | 13.0 x 3.0 x 30.0 x 18.0 | height x length x weight x width ups_express_tube | 6.0 x 6.0 x 38.0 | height x length x width ups_express_pak | 11.75 x 16.0 | height x width ups_world_document_box | 12.5 x 3.0 x 17.5 | height x length x width


## Shipment Options
### Canada Post
Code | Identifier --- | --- canadapost_signature | SO canadapost_coverage | COV canadapost_collect_on_delivery | COD canadapost_proof_of_age_required_18 | PA18 canadapost_proof_of_age_required_19 | PA19 canadapost_card_for_pickup | HFP canadapost_do_not_safe_drop | DNS canadapost_leave_at_door | LAD canadapost_deliver_to_post_office | D2PO canadapost_return_at_senders_expense | RASE canadapost_return_to_sender | RTS canadapost_abandon | ABAN

### DHL
Code | Identifier --- | --- dhl_logistics_services | 0A dhl_mailroom_management | 0B dhl_pallet_administration | 0C dhl_warehousing | 0D dhl_express_logistics_centre | 0E dhl_strategic_parts_centre | 0F dhl_local_distribution_centre | 0G dhl_terminal_handling | 0H dhl_cross_docking | 0I dhl_inventory_management | 0J dhl_loading_unloading | 0K dhl_product_kitting | 0L dhl_priority_account_desk | 0M dhl_document_archiving | 0N dhl_saturday_delivery | AA dhl_saturday_pickup | AB dhl_holiday_delivery | AC dhl_holiday_pickup | AD dhl_domestic_saturday_delivery | AG dhl_standard | BA dhl_globalmail_item | BB dhl_letter | BC dhl_packet | BD dhl_letter_plus | BE dhl_packet_plus | BF dhl_elevated_risk | CA dhl_restricted_destination | CB dhl_security_validation | CC dhl_secure_protection | CD dhl_proof_of_identity | CE dhl_secure_storage | CF dhl_diplomatic_material | CG dhl_smart_sensor | CH dhl_visa_program | CI dhl_onboard_courier | CJ dhl_secure_safebox | CK dhl_smart_sentry | CL dhl_split_duties_and_tax | DC dhl_duties_and_taxes_paid | DD dhl_receiver_paid | DE dhl_duties_and_taxes_unpaid | DS dhl_import_billing | DT dhl_importer_of_record | DU dhl_go_green_carbon_neutral | EA dhl_go_green_carbon_footprint | EB dhl_go_green_carbon_estimate | EC dhl_fuel_surcharge_b | FB dhl_fuel_surcharge_c | FC dhl_fuel_surcharge_f | FF dhl_smartphone_box | GA dhl_laptop_box | GB dhl_bottle_box | GC dhl_repacking | GD dhl_tablet_box | GE dhl_filler_material | GF dhl_packaging | GG dhl_diplomatic_bag | GH dhl_pallet_box | GI dhl_lock_box | GJ dhl_lithium_ion_pi965_section_ii | HB dhl_dry_ice_un1845 | HC dhl_lithium_ion_pi965_966_section_ii | HD dhl_dangerous_goods | HE dhl_perishable_cargo | HG dhl_excepted_quantity | HH dhl_spill_cleaning | HI dhl_consumer_commodities | HK dhl_limited_quantities_adr | HL dhl_lithium_metal_pi969_section_ii | HM dhl_adr_load_exemption | HN dhl_lithium_ion_pi967_section_ii | HV dhl_lithium_metal_pi970_section_ii | HW dhl_biological_un3373 | HY dhl_extended_liability | IB dhl_contract_insurance | IC dhl_shipment_insurance | II dhl_delivery_notification | JA dhl_pickup_notification | JC dhl_proactive_tracking | JD dhl_performance_reporting | JE dhl_prealert_notification | JY dhl_change_of_billing | KA dhl_cash_on_delivery | KB dhl_printed_invoice | KD dhl_waybill_copy | KE dhl_import_paperwork | KF dhl_payment_on_pickup | KY dhl_shipment_intercept | LA dhl_shipment_redirect | LC dhl_storage_at_facility | LE dhl_cold_storage | LG dhl_specific_routing | LH dhl_service_recovery | LV dhl_alternative_address | LW dhl_hold_for_collection | LX dhl_address_correction_a | MA dhl_address_correction_b | MB dhl_neutral_delivery | NN dhl_remote_area_pickup | OB dhl_remote_area_delivery_c | OC dhl_out_of_service_area | OE dhl_remote_area_delivery_o | OO dhl_shipment_preparation | PA dhl_shipment_labeling | PB dhl_shipment_consolidation | PC dhl_relabeling_data_entry | PD dhl_preprinted_waybill | PE dhl_piece_labelling | PS dhl_data_staging_03 | PT dhl_data_staging_06 | PU dhl_data_staging_12 | PV dhl_data_staging_24 | PW dhl_standard_pickup | PX dhl_scheduled_pickup | PY dhl_dedicated_pickup | QA dhl_early_pickup | QB dhl_late_pickup | QD dhl_residential_pickup | QE dhl_loading_waiting | QF dhl_bypass_injection | QH dhl_direct_injection | QI dhl_drop_off_at_facility | QY dhl_delivery_signature | SA dhl_content_signature | SB dhl_named_signature | SC dhl_adult_signature | SD dhl_contract_signature | SE dhl_alternative_signature | SW dhl_no_signature_required | SX dhl_dedicated_delivery | TA dhl_early_delivery | TB dhl_time_window_delivery | TC dhl_evening_delivery | TD dhl_delivery_on_appointment | TE dhl_return_undeliverable | TG dhl_swap_delivery | TH dhl_unloading_waiting | TJ dhl_residential_delivery | TK dhl_repeat_delivery | TN dhl_alternative_date | TT dhl_no_partial_delivery | TU dhl_service_point_24_7 | TV dhl_pre_9_00 | TW dhl_pre_10_30 | TX dhl_pre_12_00 | TY dhl_thermo_packaging | UA dhl_ambient_vialsafe | UB dhl_ambient_non_insulated | UC dhl_ambient_insulated | UD dhl_ambient_extreme | UE dhl_chilled_box_s | UF dhl_chilled_box_m | UG dhl_chilled_box_l | UH dhl_frozen_no_ice_s | UI dhl_frozen_no_ice_m | UJ dhl_frozen_no_ice_l | UK dhl_frozen_ice_sticks_s | UL dhl_frozen_ice_sticks_m | UM dhl_frozen_ice_sticks_l | UN dhl_frozen_ice_plates_s | UO dhl_frozen_ice_plates_m | UP dhl_frozen_ice_plates_l | UQ dhl_combination_no_ice | UR dhl_combination_dry_ice | US dhl_frozen_ice_sticks_e | UT dhl_frozen_ice_plates_e | UV dhl_customer_tcp_1 | UW dhl_thermo_accessories | VA dhl_absorbent_sleeve | VB dhl_cooland_wrap | VC dhl_dry_ice_supplies | VD dhl_pressure_bag_s | VE dhl_pressure_bag_m | VF dhl_pressure_bag_l | VG dhl_informal_clearance | WA dhl_formal_clearance | WB dhl_payment_deferment | WC dhl_clearance_authorization | WD dhl_multiline_entry | WE dhl_post_clearance_modification | WF dhl_handover_to_broker | WG dhl_physical_intervention | WH dhl_bio_phyto_veterinary_controls | WI dhl_obtaining_permits_and_licences | WJ dhl_bonded_storage | WK dhl_bonded_transit_documents | WL dhl_temporary_import_export | WM dhl_under_bond_guarantee | WN dhl_export_declaration | WO dhl_exporter_validation | WP dhl_certificate_of_origin | WQ dhl_document_translation | WR dhl_personal_effects | WS dhl_paperless_trade | WY dhl_import_export_taxes | XB dhl_unrecoverable_origin_tax | XC dhl_quarantine_inspection | XD dhl_merchandise_process | XE dhl_domestic_postal_tax | XF dhl_tier_two_tax | XG dhl_tier_three_tax | XH dhl_import_penalty | XI dhl_cargo_zone_process | XJ dhl_import_export_duties | XX dhl_premium_09_00 | Y1 dhl_premium_10_30 | Y2 dhl_premium_12_00 | Y3 dhl_over_sized_piece_b | YB dhl_over_handled_piece_c | YC dhl_multipiece_shipment | YE dhl_over_weight_piece_f | YF dhl_over_sized_piece_g | YG dhl_over_handled_piece_h | YH dhl_premium_9_00_i | YI dhl_premium_10_30_j | YJ dhl_premium_12_00_k | YK dhl_paket_shipment | YV dhl_breakbulk_mother | YW dhl_breakbulk_baby | YX dhl_over_weight_piece_y | YY dhl_customer_claim | ZA dhl_damage_compensation | ZB dhl_loss_compensation | ZC dhl_customer_rebate | ZD dhl_e_com_discount | ZE

### FedEx
Code | Identifier --- | --- blind_shipment | BLIND_SHIPMENT broker_select_option | BROKER_SELECT_OPTION call_before_delivery | CALL_BEFORE_DELIVERY cod | COD cod_remittance | COD_REMITTANCE custom_delivery_window | CUSTOM_DELIVERY_WINDOW cut_flowers | CUT_FLOWERS dangerous_goods | DANGEROUS_GOODS delivery_on_invoice_acceptance | DELIVERY_ON_INVOICE_ACCEPTANCE detention | DETENTION do_not_break_down_pallets | DO_NOT_BREAK_DOWN_PALLETS do_not_stack_pallets | DO_NOT_STACK_PALLETS dry_ice | DRY_ICE east_coast_special | EAST_COAST_SPECIAL electronic_trade_documents | ELECTRONIC_TRADE_DOCUMENTS event_notification | EVENT_NOTIFICATION exclude_from_consolidation | EXCLUDE_FROM_CONSOLIDATION exclusive_use | EXCLUSIVE_USE exhibition_delivery | EXHIBITION_DELIVERY exhibition_pickup | EXHIBITION_PICKUP expedited_alternate_delivery_route | EXPEDITED_ALTERNATE_DELIVERY_ROUTE expedited_one_day_earlier | EXPEDITED_ONE_DAY_EARLIER expedited_service_monitoring_and_delivery | EXPEDITED_SERVICE_MONITORING_AND_DELIVERY expedited_standard_day_early_delivery | EXPEDITED_STANDARD_DAY_EARLY_DELIVERY extra_labor | EXTRA_LABOR extreme_length | EXTREME_LENGTH fedex_one_rate | FEDEX_ONE_RATE flatbed_trailer | FLATBED_TRAILER food | FOOD freight_guarantee | FREIGHT_GUARANTEE freight_to_collect | FREIGHT_TO_COLLECT future_day_shipment | FUTURE_DAY_SHIPMENT hold_at_location | HOLD_AT_LOCATION holiday_delivery | HOLIDAY_DELIVERY holiday_guarantee | HOLIDAY_GUARANTEE home_delivery_premium | HOME_DELIVERY_PREMIUM inside_delivery | INSIDE_DELIVERY inside_pickup | INSIDE_PICKUP international_controlled_export_service | INTERNATIONAL_CONTROLLED_EXPORT_SERVICE international_mail_service | INTERNATIONAL_MAIL_SERVICE international_traffic_in_arms_regulations | INTERNATIONAL_TRAFFIC_IN_ARMS_REGULATIONS liftgate_delivery | LIFTGATE_DELIVERY liftgate_pickup | LIFTGATE_PICKUP limited_access_delivery | LIMITED_ACCESS_DELIVERY limited_access_pickup | LIMITED_ACCESS_PICKUP marking_or_tagging | MARKING_OR_TAGGING non_business_time | NON_BUSINESS_TIME pallet_shrinkwrap | PALLET_SHRINKWRAP pallet_weight_allowance | PALLET_WEIGHT_ALLOWANCE pallets_provided | PALLETS_PROVIDED pending_complete | PENDING_COMPLETE pending_shipment | PENDING_SHIPMENT permit | PERMIT pharmacy_delivery | PHARMACY_DELIVERY poison | POISON port_delivery | PORT_DELIVERY port_pickup | PORT_PICKUP pre_delivery_notification | PRE_DELIVERY_NOTIFICATION pre_eig_processing | PRE_EIG_PROCESSING pre_multiplier_processing | PRE_MULTIPLIER_PROCESSING protection_from_freezing | PROTECTION_FROM_FREEZING regional_mall_delivery | REGIONAL_MALL_DELIVERY regional_mall_pickup | REGIONAL_MALL_PICKUP return_shipment | RETURN_SHIPMENT returns_clearance | RETURNS_CLEARANCE returns_clearance_special_routing_required | RETURNS_CLEARANCE_SPECIAL_ROUTING_REQUIRED saturday_delivery | SATURDAY_DELIVERY saturday_pickup | SATURDAY_PICKUP shipment_assembly | SHIPMENT_ASSEMBLY sort_and_segregate | SORT_AND_SEGREGATE special_delivery | SPECIAL_DELIVERY special_equipment | SPECIAL_EQUIPMENT storage | STORAGE sunday_delivery | SUNDAY_DELIVERY third_party_consignee | THIRD_PARTY_CONSIGNEE top_load | TOP_LOAD usps_delivery | USPS_DELIVERY usps_pickup | USPS_PICKUP weighing | WEIGHING

### Purolator
Code | Identifier --- | --- dangerous_goods | Dangerous Goods chain_of_signature | Chain of Signature express_cheque | ExpressCheque hold_for_pickup | Hold For Pickup return_services | Return Services saturday_service | Saturday Service origin_signature_not_required | Origin Signature Not Required (OSNR) adult_signature_required | Adult Signature Required (ASR) special_handling | Special Handling

### UPS
Code | Identifier --- | --- saturday_delivery_indicator | SaturdayDeliveryIndicator access_point_cod | AccessPointCOD deliver_to_addressee_only_indicator | DeliverToAddresseeOnlyIndicator direct_delivery_only_indicator | DirectDeliveryOnlyIndicator cod | COD delivery_confirmation | DeliveryConfirmation return_of_document_indicator | ReturnOfDocumentIndicator up_scarbonneutral_indicator | UPScarbonneutralIndicator certificate_of_origin_indicator | CertificateOfOriginIndicator pickup_options | PickupOptions delivery_options | DeliveryOptions restricted_articles | RestrictedArticles shipper_export_declaration_indicator | ShipperExportDeclarationIndicator commercial_invoice_removal_indicator | CommercialInvoiceRemovalIndicator import_control | ImportControl return_service | ReturnService sdl_shipment_indicator | SDLShipmentIndicator epra_indicator | EPRAIndicator

### Freightcom
Code | Identifier --- | --- freightcom_saturday_pickup_required | saturdayPickupRequired freightcom_homeland_security | homelandSecurity freightcom_exhibition_convention_site | exhibitionConventionSite freightcom_military_base_delivery | militaryBaseDelivery freightcom_customs_in_bond_freight | customsIn_bondFreight freightcom_limited_access | limitedAccess freightcom_excess_length | excessLength freightcom_tailgate_pickup | tailgatePickup freightcom_residential_pickup | residentialPickup freightcom_cross_border_fee | crossBorderFee freightcom_notify_recipient | notifyRecipient freightcom_single_shipment | singleShipment freightcom_tailgate_delivery | tailgateDelivery freightcom_residential_delivery | residentialDelivery freightcom_insurance_type | insuranceType freightcom_inside_delivery | insideDelivery freightcom_is_saturday_service | isSaturdayService freightcom_dangerous_goods_type | dangerousGoodsType freightcom_stackable | stackable

### eShipper
Code | Identifier --- | --- eshipper_saturday_pickup_required | saturdayPickupRequired eshipper_homeland_security | homelandSecurity eshipper_exhibition_convention_site | exhibitionConventionSite eshipper_military_base_delivery | militaryBaseDelivery eshipper_customs_in_bond_freight | customsIn_bondFreight eshipper_limited_access | limitedAccess eshipper_excess_length | excessLength eshipper_tailgate_pickup | tailgatePickup eshipper_residential_pickup | residentialPickup eshipper_cross_border_fee | crossBorderFee eshipper_notify_recipient | notifyRecipient eshipper_single_shipment | singleShipment eshipper_tailgate_delivery | tailgateDelivery eshipper_residential_delivery | residentialDelivery eshipper_insurance_type | insuranceType eshipper_inside_delivery | insideDelivery eshipper_is_saturday_service | isSaturdayService eshipper_dangerous_goods_type | dangerousGoodsType eshipper_stackable | stackable


## Shipment Services
### Canada Post
Code | Identifier --- | --- canadapost_regular_parcel | DOM.RP canadapost_expedited_parcel | DOM.EP canadapost_xpresspost | DOM.XP canadapost_priority | DOM.PC canadapost_library_books | DOM.LIB canadapost_expedited_parcel_usa | USA.EP canadapost_priority_worldwide_envelope_usa | USA.PW.ENV canadapost_priority_worldwide_pak_usa | USA.PW.PAK canadapost_priority_worldwide_parcel_usa | USA.PW.PARCEL canadapost_small_packet_usa_air | USA.SP.AIR canadapost_tracked_packet_usa | USA.TP canadapost_tracked_packet_usa_lvm | USA.TP.LVM canadapost_xpresspost_usa | USA.XP canadapost_xpresspost_international | INT.XP canadapost_international_parcel_air | INT.IP.AIR canadapost_international_parcel_surface | INT.IP.SURF canadapost_priority_worldwide_envelope_intl | INT.PW.ENV canadapost_priority_worldwide_pak_intl | INT.PW.PAK canadapost_priority_worldwide_parcel_intl | INT.PW.PARCEL canadapost_small_packet_international_air | INT.SP.AIR canadapost_small_packet_international_surface | INT.SP.SURF canadapost_tracked_packet_international | INT.TP

### DHL
Code | Identifier --- | --- dhl_logistics_services | LOGISTICS SERVICES dhl_domestic_express_12_00_doc | DOMESTIC EXPRESS 12:00 DOC dhl_b2_c_doc | B2C DOC dhl_b2_c_nondoc | B2C NONDOC dhl_jetline | JETLINE dhl_sprintline | SPRINTLINE dhl_express_easy_doc | EXPRESS EASY DOC dhl_express_easy_nondoc | EXPRESS EASY NONDOC dhl_europack_doc | EUROPACK DOC dhl_auto_reversals | AUTO REVERSALS dhl_breakbulk_express_doc | BREAKBULK EXPRESS DOC dhl_medical_express_doc | MEDICAL EXPRESS DOC dhl_express_worldwide_doc | EXPRESS WORLDWIDE DOC dhl_express_9_00_nondoc | EXPRESS 9:00 NONDOC dhl_freight_worldwide_nondoc | FREIGHT WORLDWIDE NONDOC dhl_domestic_economy_select_doc | DOMESTIC ECONOMY SELECT DOC dhl_economy_select_nondoc | ECONOMY SELECT NONDOC dhl_domestic_express_9_00_doc | DOMESTIC EXPRESS 9:00 DOC dhl_jumbo_box_nondoc | JUMBO BOX NONDOC dhl_express_9_00_doc | EXPRESS 9:00 DOC dhl_express_10_30_doc | EXPRESS 10:30 DOC dhl_express_10_30_nondoc | EXPRESS 10:30 NONDOC dhl_domestic_express_doc | DOMESTIC EXPRESS DOC dhl_domestic_express_10_30_doc | DOMESTIC EXPRESS 10:30 DOC dhl_express_worldwide_nondoc | EXPRESS WORLDWIDE NONDOC dhl_medical_express_nondoc | MEDICAL EXPRESS NONDOC dhl_globalmail_business_doc | GLOBALMAIL BUSINESS DOC dhl_same_day_doc | SAME DAY DOC dhl_express_12_00_doc | EXPRESS 12:00 DOC dhl_europack_nondoc | EUROPACK NONDOC dhl_economy_select_doc | ECONOMY SELECT DOC dhl_express_envelope_doc | EXPRESS ENVELOPE DOC dhl_express_12_00_nondoc | EXPRESS 12:00 NONDOC dhl_destination_charges | Destination Charges

### FedEx
Code | Identifier --- | --- europe_first_international_priority | EUROPE_FIRST_INTERNATIONAL_PRIORITY fedex_1_day_freight | FEDEX_1_DAY_FREIGHT fedex_2_day | FEDEX_2_DAY fedex_2_day_am | FEDEX_2_DAY_AM fedex_2_day_freight | FEDEX_2_DAY_FREIGHT fedex_3_day_freight | FEDEX_3_DAY_FREIGHT fedex_cargo_airport_to_airport | FEDEX_CARGO_AIRPORT_TO_AIRPORT fedex_cargo_freight_forwarding | FEDEX_CARGO_FREIGHT_FORWARDING fedex_cargo_international_express_freight | FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT fedex_cargo_international_premium | FEDEX_CARGO_INTERNATIONAL_PREMIUM fedex_cargo_mail | FEDEX_CARGO_MAIL fedex_cargo_registered_mail | FEDEX_CARGO_REGISTERED_MAIL fedex_cargo_surface_mail | FEDEX_CARGO_SURFACE_MAIL fedex_custom_critical_air_expedite | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE fedex_custom_critical_air_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_air_expedite_network | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK fedex_custom_critical_charter_air | FEDEX_CUSTOM_CRITICAL_CHARTER_AIR fedex_custom_critical_point_to_point | FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT fedex_custom_critical_surface_expedite | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE fedex_custom_critical_surface_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_temp_assure_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR fedex_custom_critical_temp_assure_validated_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR fedex_custom_critical_white_glove_services | FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES fedex_distance_deferred | FEDEX_DISTANCE_DEFERRED fedex_express_saver | FEDEX_EXPRESS_SAVER fedex_first_freight | FEDEX_FIRST_FREIGHT fedex_freight_economy | FEDEX_FREIGHT_ECONOMY fedex_freight_priority | FEDEX_FREIGHT_PRIORITY fedex_ground | FEDEX_GROUND fedex_international_priority_plus | FEDEX_INTERNATIONAL_PRIORITY_PLUS fedex_next_day_afternoon | FEDEX_NEXT_DAY_AFTERNOON fedex_next_day_early_morning | FEDEX_NEXT_DAY_EARLY_MORNING fedex_next_day_end_of_day | FEDEX_NEXT_DAY_END_OF_DAY fedex_next_day_freight | FEDEX_NEXT_DAY_FREIGHT fedex_next_day_mid_morning | FEDEX_NEXT_DAY_MID_MORNING first_overnight | FIRST_OVERNIGHT ground_home_delivery | GROUND_HOME_DELIVERY international_distribution_freight | INTERNATIONAL_DISTRIBUTION_FREIGHT international_economy | INTERNATIONAL_ECONOMY international_economy_distribution | INTERNATIONAL_ECONOMY_DISTRIBUTION international_economy_freight | INTERNATIONAL_ECONOMY_FREIGHT international_first | INTERNATIONAL_FIRST international_ground | INTERNATIONAL_GROUND international_priority | INTERNATIONAL_PRIORITY international_priority_distribution | INTERNATIONAL_PRIORITY_DISTRIBUTION international_priority_express | INTERNATIONAL_PRIORITY_EXPRESS international_priority_freight | INTERNATIONAL_PRIORITY_FREIGHT priority_overnight | PRIORITY_OVERNIGHT same_day | SAME_DAY same_day_city | SAME_DAY_CITY same_day_metro_afternoon | SAME_DAY_METRO_AFTERNOON same_day_metro_morning | SAME_DAY_METRO_MORNING same_day_metro_rush | SAME_DAY_METRO_RUSH smart_post | SMART_POST standard_overnight | STANDARD_OVERNIGHT transborder_distribution_consolidation | TRANSBORDER_DISTRIBUTION_CONSOLIDATION

### Purolator
Code | Identifier --- | --- purolator_express_9_am | PurolatorExpress9AM purolator_express_us | PurolatorExpressU.S. purolator_express_10_30_am | PurolatorExpress10:30AM purolator_express_us_9_am | PurolatorExpressU.S.9AM purolator_express_12_pm | PurolatorExpress12PM purolator_express_us_10_30_am | PurolatorExpressU.S.10:30AM purolator_express | PurolatorExpress purolator_express_us_12_00 | PurolatorExpressU.S.12:00 purolator_express_evening | PurolatorExpressEvening purolator_express_envelope_us | PurolatorExpressEnvelopeU.S. purolator_express_envelope_9_am | PurolatorExpressEnvelope9AM purolator_express_us_envelope_9_am | PurolatorExpressU.S.Envelope9AM purolator_express_envelope_10_30_am | PurolatorExpressEnvelope10:30AM purolator_express_us_envelope_10_30_am | PurolatorExpressU.S.Envelope10:30AM purolator_express_envelope_12_pm | PurolatorExpressEnvelope12PM purolator_express_us_envelope_12_00 | PurolatorExpressU.S.Envelope12:00 purolator_express_envelope | PurolatorExpressEnvelope purolator_express_pack_us | PurolatorExpressPackU.S. purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening purolator_express_us_pack_9_am | PurolatorExpressU.S.Pack9AM purolator_express_pack_9_am | PurolatorExpressPack9AM purolator_express_us_pack_10_30_am | PurolatorExpressU.S.Pack10:30AM purolator_express_pack10_30_am | PurolatorExpressPack10:30AM purolator_express_us_pack_12_00 | PurolatorExpressU.S.Pack12:00 purolator_express_pack_12_pm | PurolatorExpressPack12PM purolator_express_box_us | PurolatorExpressBoxU.S. purolator_express_pack | PurolatorExpressPack purolator_express_us_box_9_am | PurolatorExpressU.S.Box9AM purolator_express_pack_evening | PurolatorExpressPackEvening purolator_express_us_box_10_30_am | PurolatorExpressU.S.Box10:30AM purolator_express_box_9_am | PurolatorExpressBox9AM purolator_express_us_box_12_00 | PurolatorExpressU.S.Box12:00 purolator_express_box_10_30_am | PurolatorExpressBox10:30AM purolator_ground_us | PurolatorGroundU.S. purolator_express_box_12_pm | PurolatorExpressBox12PM purolator_express_international | PurolatorExpressInternational purolator_express_box | PurolatorExpressBox purolator_express_international_9_am | PurolatorExpressInternational9AM purolator_express_box_evening | PurolatorExpressBoxEvening purolator_express_international_10_30_am | PurolatorExpressInternational10:30AM purolator_ground | PurolatorGround purolator_express_international_12_00 | PurolatorExpressInternational12:00 purolator_ground9_am | PurolatorGround9AM purolator_express_envelope_international | PurolatorExpressEnvelopeInternational purolator_ground10_30_am | PurolatorGround10:30AM purolator_express_international_envelope_9_am | PurolatorExpressInternationalEnvelope9AM purolator_ground_evening | PurolatorGroundEvening purolator_express_international_envelope_10_30_am | PurolatorExpressInternationalEnvelope10:30AM purolator_quick_ship | PurolatorQuickShip purolator_express_international_envelope_12_00 | PurolatorExpressInternationalEnvelope12:00 purolator_quick_ship_envelope | PurolatorQuickShipEnvelope purolator_express_pack_international | PurolatorExpressPackInternational purolator_quick_ship_pack | PurolatorQuickShipPack purolator_express_international_pack_9_am | PurolatorExpressInternationalPack9AM purolator_quick_ship_box | PurolatorQuickShipBox purolator_express_international_pack_10_30_am | PurolatorExpressInternationalPack10:30AM purolator_express_international_pack_12_00 | PurolatorExpressInternationalPack12:00 purolator_express_box_international | PurolatorExpressBoxInternational purolator_express_international_box_9_am | PurolatorExpressInternationalBox9AM purolator_express_international_box_10_30_am | PurolatorExpressInternationalBox10:30AM purolator_express_international_box_12_00 | PurolatorExpressInternationalBox12:00

### UPS
Code | Identifier --- | --- ups_standard | 11 ups_worldwide_expedited | 08 ups_worldwide_express | 07 ups_worldwide_express_plus | 54 ups_worldwide_saver | 65 ups_2nd_day_air | 02 ups_2nd_day_air_am | 59 ups_3_day_select | 12 ups_expedited_mail_innovations | M4 ups_first_class_mail | M2 ups_ground | 03 ups_next_day_air | 01 ups_next_day_air_early | 14 ups_next_day_air_saver | 13 ups_priority_mail | M3 ups_access_point_economy | 70 ups_today_dedicated_courier | 83 ups_today_express | 85 ups_today_express_saver | 86 ups_today_standard | 82 ups_worldwide_express_freight | 96 ups_priority_mail_innovations | M5 ups_economy_mail_innovations | M6

### Freightcom
Code | Identifier --- | --- freightcom_central_transport | 2029 freigthcom_estes | 2107 freigthcom_usf_holland | 1911 freightcom_fedex_ground | 4101 freightcom_ups_standard | 4600 freightcom_fedex_2_day | 4102 freightcom_fedex_priority_overnight | 4104 freightcom_fedex_standard_overnight | 4105 freightcom_ground | 3400 freightcom_ups_expedited | 4601 freightcom_ups_express_saver | 4602 freightcom_ups_express | 4603 freightcom_fedex_express_saver | 4100 freightcom_ups_express_early | 4604 freightcom_select | 3404 freightcom_dayr_e_comm_ground_service | 5707 freightcom_overnight | 3407 freightcom_purolator_ground | 4000 freightcom_purolator_express | 4003 freightcom_purolator_express_10_30_am | 4005 freightcom_fedex_first_overnight | 4106 freightcom_purolator_express_9_am | 4004 freightcom_dayr_e_comm_am_service | 5706

### eShipper
Code | Identifier --- | --- eshipper_fedex_priority | 1 eshipper_fedex_first_overnight | 2 eshipper_fedex_ground | 3 eshipper_fedex_standard_overnight | 28 eshipper_fedex_2nd_day | 29 eshipper_fedex_express_saver | 30 eshipper_purolator_air | 4 eshipper_purolator_air_9_am | 5 eshipper_purolator_air_10_30 | 6 eshipper_puroletter | 7 eshipper_puroletter_9_am | 8 eshipper_puroletter_10_30 | 9 eshipper_puro_pak | 10 eshipper_puro_pak_9_am | 11 eshipper_puro_pak_10_30 | 12 eshipper_purolator_ground | 13 eshipper_purolator_ground_9_am | 19 eshipper_purolator_ground_10_30 | 20 eshipper_canada_worldwide_same_day | 14 eshipper_canada_worldwide_next_flight_out | 15 eshipper_canada_worldwide_air_freight | 16 eshipper_canada_worldwide_ltl | 17 eshipper_dhl_international_express | 106 eshipper_ups_express_next_day_air | 600 eshipper_ups_expedited_second_day_air | 601 eshipper_ups_worldwide_express | 602 eshipper_ups_worldwide_expedited | 603 eshipper_ups_standard_ground | 604 eshipper_ups_express_early_am_next_day_air_early_am | 605 eshipper_ups_three_day_select | 606 eshipper_ups_saver | 607 eshipper_ups_ground | 608 eshipper_next_day_saver | 609 eshipper_worldwide_express_plus | 610 eshipper_second_day_air_am | 611 eshipper_canada_post_priority | 500 eshipper_canada_post_xpress_post | 501 eshipper_canada_post_expedited | 502 eshipper_canada_post_regular | 503 eshipper_canada_post_xpress_post_usa | 504 eshipper_canada_post_xpress_post_intl | 505 eshipper_canada_post_air_parcel_intl | 506 eshipper_canada_post_surface_parcel_intl | 507 eshipper_canada_post_expedited_parcel_usa | 508 eshipper_tst_ltl | 1100 eshipper_ltl_chicago_suburban_express | 1500 eshipper_ltl_fedex_freight_east | 1501 eshipper_ltl_fedex_freight_west | 1502 eshipper_ltl_mid_states_express | 1503 eshipper_ltl_new_england_motor_freight | 1504 eshipper_ltl_new_penn | 1505 eshipper_ltl_oak_harbor | 1506 eshipper_ltl_pitt_ohio | 1507 eshipper_ltl_r_l_carriers | 1508 eshipper_ltl_saia | 1509 eshipper_ltl_usf_reddaway | 1510 eshipper_ltl_vitran_express | 1511 eshipper_ltl_wilson_trucking | 1512 eshipper_ltl_yellow_transportation | 1513 eshipper_ltl_roadway | 1514 eshipper_ltl_fedex_national | 1515 eshipper_wilson_trucking_tfc | 1800 eshipper_aaa_cooper_transportation | 1801 eshipper_roadrunner_dawes | 1802 eshipper_new_england_motor_freight | 1803 eshipper_new_penn_motor_express | 1804 eshipper_dayton_freight | 1805 eshipper_southeastern_freightway | 1806 eshipper_saia_inc | 1807 eshipper_conway | 1808 eshipper_roadway | 1809 eshipper_usf_reddaway | 1810 eshipper_usf_holland | 1811 eshipper_dependable_highway_express | 1812 eshipper_day_and_ross | 1813 eshipper_day_and_ross_r_and_l | 1814 eshipper_ups | 1815 eshipper_aaa_cooper | 1816 eshipper_ama_transportation | 1817 eshipper_averitt_express | 1818 eshipper_central_freight | 1819 eshipper_conway_us | 1820 eshipper_dayton | 1821 eshipper_drug_transport | 1822 eshipper_estes | 1823 eshipper_land_air_express | 1824 eshipper_fedex_west | 1825 eshipper_fedex_national | 1826 eshipper_usf_holland_us | 1827 eshipper_lakeville_m_express | 1828 eshipper_milan_express | 1829 eshipper_nebraska_transport | 1830 eshipper_new_england | 1831 eshipper_new_penn | 1832 eshipper_a_duie_pyle | 1833 eshipper_roadway_us | 1834 eshipper_usf_reddaway_us | 1835 eshipper_rhody_transportation | 1836 eshipper_saia_motor_freight | 1837 eshipper_southeastern_frgt | 1838 eshipper_pitt_ohio | 1839 eshipper_ward | 1840 eshipper_wilson | 1841 eshipper_chi_cargo | 1842 eshipper_tax_air | 1843 eshipper_fedex_east | 1844 eshipper_central_transport | 1845 eshipper_roadrunner | 1846 eshipper_r_and_l_carriers | 1847 eshipper_estes_us | 1848 eshipper_yrc_roadway | 1849 eshipper_central_transport_us | 1850 eshipper_absolute_transportation_services | 1851 eshipper_blue_sky_express | 1852 eshipper_galasso_trucking | 1853 eshipper_griley_air_freight | 1854 eshipper_jet_transportation | 1855 eshipper_metro_transportation_logistics | 1856 eshipper_oak_harbor | 1857 eshipper_stream_links_express | 1858 eshipper_tiffany_trucking | 1859 eshipper_ups_freight | 1860 eshipper_roadrunner_us | 1861 eshipper_global_mail_parcel_priority | 3500 eshipper_global_mail_parcel_standard | 3501 eshipper_global_mail_packet_plus_priority | 3502 eshipper_global_mail_packet_priority | 3503 eshipper_global_mail_packet_standard | 3504 eshipper_global_mail_business_priority | 3505 eshipper_global_mail_business_standard | 3506 eshipper_global_mail_parcel_direct_priority | 3507 eshipper_global_mail_parcel_direct_standard | 3508 eshipper_ground | 4500 eshipper_select_parcel | 4504 eshipper_express_parcel | 4507


# noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.references_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :return: References - If the method is called asynchronously, - returns the request thread. - """ - - all_params = [] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in six.iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method references" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 - - return self.api_client.call_api( - '/references', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='References', # noqa: E501 - auth_settings=auth_settings, - async_req=params.get('async_req'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def print_label(self, data, **kwargs): # noqa: E501 - """Print a Label # noqa: E501 - - Returns a label PDF file. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.print_label(data, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param LabelPrintingRequest data: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.print_label_with_http_info(data, **kwargs) # noqa: E501 - else: - (data) = self.print_label_with_http_info(data, **kwargs) # noqa: E501 - return data - - def print_label_with_http_info(self, data, **kwargs): # noqa: E501 - """Print a Label # noqa: E501 - - Returns a label PDF file. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.print_label_with_http_info(data, async_req=True) - >>> result = thread.get() - - :param async_req bool - :param LabelPrintingRequest data: (required) - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['data'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in six.iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method print_label" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'data' is set - if ('data' not in params or - params['data'] is None): - raise ValueError("Missing the required parameter `data` when calling `print_label`") # noqa: E501 - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'data' in params: - body_params = params['data'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/octet-stream', 'application/vnd.oai.openapi+json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 - - return self.api_client.call_api( - '/labels', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=params.get('async_req'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) diff --git a/purplship/api/utils_api.py b/purplship/api/utils_api.py new file mode 100644 index 0000000..5cd8cc9 --- /dev/null +++ b/purplship/api/utils_api.py @@ -0,0 +1,224 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2020.8.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from purplship.api_client import ApiClient + + +class UtilsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def print_label(self, data, **kwargs): # noqa: E501 + """Print a Label # noqa: E501 + + Returns a label PDF file. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.print_label(data, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param LabelPrintingRequest data: (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.print_label_with_http_info(data, **kwargs) # noqa: E501 + else: + (data) = self.print_label_with_http_info(data, **kwargs) # noqa: E501 + return data + + def print_label_with_http_info(self, data, **kwargs): # noqa: E501 + """Print a Label # noqa: E501 + + Returns a label PDF file. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.print_label_with_http_info(data, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param LabelPrintingRequest data: (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['data'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method print_label" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'data' is set + if ('data' not in params or + params['data'] is None): + raise ValueError("Missing the required parameter `data` when calling `print_label`") # noqa: E501 + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in params: + body_params = params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/octet-stream', 'application/vnd.oai.openapi+json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 + + return self.api_client.call_api( + '/labels', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def references(self, **kwargs): # noqa: E501 + """Data References # noqa: E501 + + ## Countries
Code | Name --- | --- AD | ANDORRA AE | UNITED ARAB EMIRATES AF | AFGHANISTAN AG | ANTIGUA AI | ANGUILLA AL | ALBANIA AM | ARMENIA AN | NETHERLANDS ANTILLES AO | ANGOLA AR | ARGENTINA AS | AMERICAN SAMOA AT | AUSTRIA AU | AUSTRALIA AW | ARUBA AZ | AZERBAIJAN BA | BOSNIA AND HERZEGOVINA BB | BARBADOS BD | BANGLADESH BE | BELGIUM BF | BURKINA FASO BG | BULGARIA BH | BAHRAIN BI | BURUNDI BJ | BENIN BM | BERMUDA BN | BRUNEI BO | BOLIVIA BR | BRAZIL BS | BAHAMAS BT | BHUTAN BW | BOTSWANA BY | BELARUS BZ | BELIZE CA | CANADA CD | CONGO, THE DEMOCRATIC REPUBLIC OF CF | CENTRAL AFRICAN REPUBLIC CG | CONGO CH | SWITZERLAND CI | COTE D IVOIRE CK | COOK ISLANDS CL | CHILE CM | CAMEROON CN | CHINA, PEOPLES REPUBLIC CO | COLOMBIA CR | COSTA RICA CU | CUBA CV | CAPE VERDE CY | CYPRUS CZ | CZECH REPUBLIC, THE DE | GERMANY DJ | DJIBOUTI DK | DENMARK DM | DOMINICA DO | DOMINICAN REPUBLIC DZ | ALGERIA EC | ECUADOR EE | ESTONIA EG | EGYPT ER | ERITREA ES | SPAIN ET | ETHIOPIA FI | FINLAND FJ | FIJI FK | FALKLAND ISLANDS FM | MICRONESIA, FEDERATED STATES OF FO | FAROE ISLANDS FR | FRANCE GA | GABON GB | UNITED KINGDOM GD | GRENADA GE | GEORGIA GF | FRENCH GUYANA GG | GUERNSEY GH | GHANA GI | GIBRALTAR GL | GREENLAND GM | GAMBIA GN | GUINEA REPUBLIC GP | GUADELOUPE GQ | GUINEA-EQUATORIAL GR | GREECE GT | GUATEMALA GU | GUAM GW | GUINEA-BISSAU GY | GUYANA (BRITISH) HK | HONG KONG HN | HONDURAS HR | CROATIA HT | HAITI HU | HUNGARY IC | CANARY ISLANDS, THE ID | INDONESIA IE | IRELAND, REPUBLIC OF IL | ISRAEL IN | INDIA IQ | IRAQ IR | IRAN (ISLAMIC REPUBLIC OF) IS | ICELAND IT | ITALY JE | JERSEY JM | JAMAICA JO | JORDAN JP | JAPAN KE | KENYA KG | KYRGYZSTAN KH | CAMBODIA KI | KIRIBATI KM | COMOROS KN | ST. KITTS KP | KOREA, THE D.P.R OF (NORTH K.) KR | KOREA, REPUBLIC OF (SOUTH K.) KV | KOSOVO KW | KUWAIT KY | CAYMAN ISLANDS KZ | KAZAKHSTAN LA | LAO PEOPLES DEMOCRATIC REPUBLIC LB | LEBANON LC | ST. LUCIA LI | LIECHTENSTEIN LK | SRI LANKA LR | LIBERIA LS | LESOTHO LT | LITHUANIA LU | LUXEMBOURG LV | LATVIA LY | LIBYA MA | MOROCCO MC | MONACO MD | MOLDOVA, REPUBLIC OF ME | MONTENEGRO, REPUBLIC OF MG | MADAGASCAR MH | MARSHALL ISLANDS MK | MACEDONIA, REPUBLIC OF ML | MALI MM | MYANMAR MN | MONGOLIA MO | MACAU MP | COMMONWEALTH NO. MARIANA ISLANDS MQ | MARTINIQUE MR | MAURITANIA MS | MONTSERRAT MT | MALTA MU | MAURITIUS MV | MALDIVES MW | MALAWI MX | MEXICO MY | MALAYSIA MZ | MOZAMBIQUE NA | NAMIBIA NC | NEW CALEDONIA NE | NIGER NG | NIGERIA NI | NICARAGUA NL | NETHERLANDS, THE NO | NORWAY NP | NEPAL NR | NAURU, REPUBLIC OF NU | NIUE NZ | NEW ZEALAND OM | OMAN PA | PANAMA PE | PERU PF | TAHITI PG | PAPUA NEW GUINEA PH | PHILIPPINES, THE PK | PAKISTAN PL | POLAND PR | PUERTO RICO PT | PORTUGAL PW | PALAU PY | PARAGUAY QA | QATAR RE | REUNION, ISLAND OF RO | ROMANIA RS | SERBIA, REPUBLIC OF RU | RUSSIAN FEDERATION, THE RW | RWANDA SA | SAUDI ARABIA SB | SOLOMON ISLANDS SC | SEYCHELLES SD | SUDAN SE | SWEDEN SG | SINGAPORE SH | SAINT HELENA SI | SLOVENIA SK | SLOVAKIA SL | SIERRA LEONE SM | SAN MARINO SN | SENEGAL SO | SOMALIA SR | SURINAME SS | SOUTH SUDAN ST | SAO TOME AND PRINCIPE SV | EL SALVADOR SY | SYRIA SZ | SWAZILAND TC | TURKS AND CAICOS ISLANDS TD | CHAD TG | TOGO TH | THAILAND TJ | TAJIKISTAN TL | TIMOR LESTE TN | TUNISIA TO | TONGA TR | TURKEY TT | TRINIDAD AND TOBAGO TV | TUVALU TW | TAIWAN TZ | TANZANIA UA | UKRAINE UG | UGANDA US | UNITED STATES OF AMERICA UY | URUGUAY UZ | UZBEKISTAN VA | VATICAN CITY STATE VC | ST. VINCENT VE | VENEZUELA VG | VIRGIN ISLANDS (BRITISH) VI | VIRGIN ISLANDS (US) VN | VIETNAM VU | VANUATU WS | SAMOA XB | BONAIRE XC | CURACAO XE | ST. EUSTATIUS XM | ST. MAARTEN XN | NEVIS XS | SOMALILAND, REP OF (NORTH SOMALIA) XY | ST. BARTHELEMY YE | YEMEN, REPUBLIC OF YT | MAYOTTE ZA | SOUTH AFRICA ZM | ZAMBIA ZW | ZIMBABWE

## States and Provinces
### UNITED ARAB EMIRATES
Code | Name --- | --- AB | Abu Dhabi AJ | Ajman DU | Dubai FU | Fujairah RA | Ras al-Khaimah SH | Sharjah UM | Umm al-Qaiwain

### CANADA
Code | Name --- | --- AB | Alberta BC | British Columbia MB | Manitoba NB | New Brunswick NL | Newfoundland NT | Northwest Territories NS | Nova Scotia NU | Nunavut ON | Ontario PE | Prince Edward Island QC | Quebec SK | Saskatchewan YT | Yukon

### CHINA, PEOPLES REPUBLIC
Code | Name --- | --- anhui | Anhui hainan | Hainan jiangxi | Jiangxi shanghai | Shanghai beijing | Beijing hebei | Hebei jilin | Jilin shanxi | Shanxi chongqing | Chongqing heilongjiang | Heilongjiang liaoning | Liaoning sichuan | Sichuan fujian | Fujian henan | Henan nei_mongol | Nei Mongol tianjin | Tianjin gansu | Gansu hubei | Hubei qinghai | Qinghai xinjiang | Xinjiang guangdong | Guangdong hunan | Hunan shaanxi | Shaanxi yunnan | Yunnan guizhou | Guizhou jiangsu | Jiangsu shandong | Shandong zhejiang | Zhejiang

### INDIA
Code | Name --- | --- AN | Andaman & Nicobar (U.T) AP | Andhra Pradesh AR | Arunachal Pradesh AS | Assam BR | Bihar CG | Chattisgarh CH | Chandigarh (U.T.) DD | Daman & Diu (U.T.) DL | Delhi (U.T.) DN | Dadra and Nagar Haveli (U.T.) GA | Goa GJ | Gujarat HP | Himachal Pradesh HR | Haryana JH | Jharkhand JK | Jammu & Kashmir KA | Karnataka KL | Kerala LD | Lakshadweep (U.T) MH | Maharashtra ML | Meghalaya MN | Manipur MP | Madhya Pradesh MZ | Mizoram NL | Nagaland OR | Orissa PB | Punjab PY | Puducherry (U.T.) RJ | Rajasthan SK | Sikkim TN | Tamil Nadu TR | Tripura UA | Uttaranchal UP | Uttar Pradesh WB | West Bengal

### MEXICO
Code | Name --- | --- AG | Aguascalientes BC | Baja California BS | Baja California Sur CM | Campeche CS | Chiapas CH | Chihuahua CO | Coahuila CL | Colima DF | Ciudad de México DG | Durango GT | Guanajuato GR | Guerrero HG | Hidalgo JA | Jalisco EM | Estado de México MI | Michoacán MO | Morelos NA | Nayarit NL | Nuevo León OA | Oaxaca PU | Puebla QE | Querétaro QR | Quintana Roo SL | San Luis Potosí SI | Sinaloa SO | Sonora TB | Tabasco TM | Tamaulipas TL | Tlaxcala VE | Veracruz YU | Yucatán ZA | Zacatecas

### UNITED STATES OF AMERICA
Code | Name --- | --- AL | Alabama AK | Alaska AZ | Arizona AR | Arkansas CA | California CO | Colorado CT | Connecticut DE | Delaware DC | District of Columbia FL | Florida GA | Georgia HI | Hawaii ID | Idaho IL | Illinois IN | Indiana IA | Iowa KS | Kansas KY | Kentucky LA | Louisiana ME | Maine MD | Maryland MA | Massachusetts MI | Michigan MN | Minnesota MS | Mississippi MO | Missouri MT | Montana NE | Nebraska NV | Nevada NH | New Hampshire NJ | New Jersey NM | New Mexico NY | New York NC | North Carolina ND | North Dakota OH | Ohio OK | Oklahoma OR | Oregon PA | Pennsylvania RI | Rhode Island SC | South Carolina SD | South Dakota TN | Tennessee TX | Texas UT | Utah VT | Vermont VA | Virginia WA | Washington State WV | West Virginia WI | Wisconsin WY | Wyoming PR | Puerto Rico


## Currencies
Code | Name --- | --- EUR | Euro AED | UAE Dirham USD | US Dollar XCD | East Caribbean Dollar AMD | Dran ANG | Netherlands Antilles Guilder AOA | Kwanza ARS | Argentine Peso AUD | Australian Dollar AWG | Aruba Guilder AZN | Manat BAM | Convertible Marks BBD | Barbadian Dollar BDT | Taka XOF | CFA Franc West Africa BGN | Bulgarian Lev BHD | Bahraini Dinar BIF | Burundese Franc BMD | Bermudian Dollar BND | Brunei Dollar BOB | Boliviano BRL | Real BSD | Bahamian Dollar BTN | Ngultrum BWP | Pula BYN | Belarussian Ruble BZD | Belize Dollar CAD | Canadian Dollar CDF | Franc Congolais XAF | CFA Franc Central Africa CHF | Swiss Franc NZD | New Zealand Dollar CLP | New Chile Peso CNY | Yuan (Ren Min Bi) COP | Colombian Peso CRC | Costa Rican Colon CUC | Peso Convertible CVE | Cape Verde Escudo CZK | Czech Koruna DJF | Djibouti Franc DKK | Danish Krone DOP | Dominican Republic Peso DZD | Algerian Dinar EGP | Egyptian Pound ERN | Nakfa ETB | Birr FJD | Fijian Dollar GBP | Pound Sterling GEL | Georgian Lari GHS | Cedi GMD | Dalasi GNF | Guinea Franc GTQ | Quetzal GYD | Guyanan Dollar HKD | Hong Kong Dollar HNL | Lempira HRK | Croatian Kuna HTG | Gourde HUF | Forint IDR | Rupiah ILS | New Israeli Shekel INR | Indian Rupee IRR | Iranian Rial ISK | Icelandic Krona JMD | Jamaican Dollar JOD | Jordanian Dinar JPY | Yen KES | Kenyan Shilling KGS | Som KHR | Khmer Rial KMF | Comoros Franc KPW | North Korean Won KRW | Won KWD | Kuwaiti Dinar KYD | Cayman Islands Dollar KZT | Tenge LAK | Kip LKR | Sri Lankan Rupee LRD | Liberian Dollar LSL | Loti LYD | Libyan Dinar MAD | Moroccan Dirham MDL | Leu MGA | Ariary MKD | Denar MMK | Kyat MNT | Tugrik MOP | Pataca MRO | Ouguiya MUR | Mauritius Rupee MVR | Rufiyaa MWK | Kwacha MXN | Mexican Nuevo Peso MYR | Ringgit MZN | Mozambique Metical NAD | Namibian Dollar XPF | CFP Franc NGN | Naira NIO | Cordoba Oro NOK | Norwegian Krone NPR | Nepalese Rupee OMR | Omani Rial PEN | Nuevo Sol PGK | Kina PHP | Phillipines Peso PKR | Pakistani Rupee PLN | Zloty PYG | Guarani QAR | Qatar Rial RSD | Serbia, Dinars RUB | Russian Ruble RWF | Rwanda Franc SAR | Saudi Riyal SBD | Solomon Islands Dollar SCR | Seychelles Rupee SDG | Sudanese Pound SEK | Swedish Krona SGD | Singapore Dollar SHP | St. Helena Pound SLL | Leone SOS | Somali Shilling SRD | Suriname Dollar SSP | South Sudanese pound STD | Dobra SYP | Syrian Pound SZL | Lilangeni THB | Baht TJS | Somoni TND | Tunisian Dinar TOP | Pa'anga TRY | New Turkish Lira TTD | Trinidad and Tobago Dollar TWD | New Taiwan Dollar TZS | Tanzanian Shilling UAH | Hryvna UYU | Peso Uruguayo UZS | Sum VEF | Bolivar Fuerte VND | Dong VUV | Vanuatu Vatu WST | Tala YER | Yemeni Riyal ZAR | South African Rand

## Packaging Type
### Multi-carrier (purplship)
Code | Identifier --- | --- envelope | Small Envelope pak | Pak tube | Tube pallet | Pallet small_box | Small Box medium_box | Medium Box your_packaging | Your Packaging


## Package Preset
### Canada Post
Code | Dimensions | Note --- | --- | --- canadapost_mailing_box | 15.2 x 10.2 | height x width canadapost_extra_small_mailing_box | 14.0 x 14.0 x 14.0 | height x length x width canadapost_small_mailing_box | 22.9 x 6.4 x 28.6 | height x length x width canadapost_medium_mailing_box | 23.5 x 13.3 x 31.0 | height x length x width canadapost_large_mailing_box | 30.5 x 9.5 x 38.1 | height x length x width canadapost_extra_large_mailing_box | 30.5 x 21.6 x 40.0 | height x length x width canadapost_corrugated_small_box | 32.0 x 32.0 x 42.0 | height x length x width canadapost_corrugated_medium_box | 38.0 x 32.0 x 46.0 | height x length x width canadapost_corrugated_large_box | 46.0 x 40.6 x 46.0 | height x length x width canadapost_xexpresspost_certified_envelope | 15.9 x 1.5 x 0.5 x 26.0 | height x length x weight x width canadapost_xexpresspost_national_large_envelope | 29.2 x 1.5 x 1.36 x 40.0 | height x length x weight x width

### DHL
Code | Dimensions | Note --- | --- | --- dhl_express_envelope | 27.5 x 1.0 x 0.5 x 35.0 | height x length x weight x width dhl_express_standard_flyer | 30.0 x 2.0 x 40.0 | height x weight x width dhl_express_large_flyer | 37.5 x 3.0 x 47.5 | height x weight x width dhl_express_box_2 | 18.2 x 10.0 x 1.0 x 33.7 | height x length x weight x width dhl_express_box_3 | 32.0 x 5.2 x 2.0 x 33.6 | height x length x weight x width dhl_express_box_4 | 32.2 x 18.0 x 5.0 x 33.7 | height x length x weight x width dhl_express_box_5 | 32.2 x 34.5 x 10.0 x 33.7 | height x length x weight x width dhl_express_box_6 | 35.9 x 36.9 x 15.0 x 41.7 | height x length x weight x width dhl_express_box_7 | 40.4 x 38.9 x 20.0 x 48.1 | height x length x weight x width dhl_express_box_8 | 44.4 x 40.9 x 25.0 x 54.2 | height x length x weight x width dhl_express_tube | 15.0 x 15.0 x 5.0 x 96.0 | height x length x weight x width dhl_didgeridoo_box | 13.0 x 162.0 x 10.0 x 13.0 | height x length x weight x width dhl_jumbo_box | 42.7 x 33.0 x 30.0 x 45.0 | height x length x weight x width dhl_jumbo_box_junior | 34.0 x 24.1 x 20.0 x 39.9 | height x length x weight x width

### FedEx
Code | Dimensions | Note --- | --- | --- fedex_envelope_legal_size | 15.5 x 1.0 x 9.5 | height x weight x width fedex_padded_pak | 14.75 x 2.2 x 11.75 | height x weight x width fedex_polyethylene_pak | 15.5 x 2.2 x 12.0 | height x weight x width fedex_clinical_pak | 18.0 x 2.2 x 13.5 | height x weight x width fedex_small_box | 10.9 x 1.5 x 20.0 x 12.25 | height x length x weight x width fedex_medium_box | 11.5 x 2.38 x 20.0 x 13.25 | height x length x weight x width fedex_large_box | 12.38 x 3.0 x 20.0 x 17.88 | height x length x weight x width fedex_10_kg_box | 12.94 x 10.19 x 10.0 x 15.81 | height x length x weight x width fedex_25_kg_box | 16.56 x 13.19 x 25.0 x 21.56 | height x length x weight x width fedex_tube | 6.0 x 6.0 x 20.0 x 38.0 | height x length x weight x width

### Purolator
Code | Dimensions | Note --- | --- | --- purolator_express_envelope | 1.0 | weight purolator_express_pack | 3.0 | weight purolator_express_box | 7.0 | weight

### UPS
Code | Dimensions | Note --- | --- | --- ups_small_express_box | 11.0 x 2.0 x 30.0 x 13.0 | height x length x weight x width ups_medium_express_box | 11.0 x 3.0 x 30.0 x 16.0 | height x length x weight x width ups_large_express_box | 13.0 x 3.0 x 30.0 x 18.0 | height x length x weight x width ups_express_tube | 6.0 x 6.0 x 38.0 | height x length x width ups_express_pak | 11.75 x 16.0 | height x width ups_world_document_box | 12.5 x 3.0 x 17.5 | height x length x width


## Shipment Options
### Canada Post
Code | Identifier --- | --- canadapost_signature | SO canadapost_coverage | COV canadapost_collect_on_delivery | COD canadapost_proof_of_age_required_18 | PA18 canadapost_proof_of_age_required_19 | PA19 canadapost_card_for_pickup | HFP canadapost_do_not_safe_drop | DNS canadapost_leave_at_door | LAD canadapost_deliver_to_post_office | D2PO canadapost_return_at_senders_expense | RASE canadapost_return_to_sender | RTS canadapost_abandon | ABAN

### DHL
Code | Identifier --- | --- dhl_logistics_services | 0A dhl_mailroom_management | 0B dhl_pallet_administration | 0C dhl_warehousing | 0D dhl_express_logistics_centre | 0E dhl_strategic_parts_centre | 0F dhl_local_distribution_centre | 0G dhl_terminal_handling | 0H dhl_cross_docking | 0I dhl_inventory_management | 0J dhl_loading_unloading | 0K dhl_product_kitting | 0L dhl_priority_account_desk | 0M dhl_document_archiving | 0N dhl_saturday_delivery | AA dhl_saturday_pickup | AB dhl_holiday_delivery | AC dhl_holiday_pickup | AD dhl_domestic_saturday_delivery | AG dhl_standard | BA dhl_globalmail_item | BB dhl_letter | BC dhl_packet | BD dhl_letter_plus | BE dhl_packet_plus | BF dhl_elevated_risk | CA dhl_restricted_destination | CB dhl_security_validation | CC dhl_secure_protection | CD dhl_proof_of_identity | CE dhl_secure_storage | CF dhl_diplomatic_material | CG dhl_smart_sensor | CH dhl_visa_program | CI dhl_onboard_courier | CJ dhl_secure_safebox | CK dhl_smart_sentry | CL dhl_split_duties_and_tax | DC dhl_duties_and_taxes_paid | DD dhl_receiver_paid | DE dhl_duties_and_taxes_unpaid | DS dhl_import_billing | DT dhl_importer_of_record | DU dhl_go_green_carbon_neutral | EA dhl_go_green_carbon_footprint | EB dhl_go_green_carbon_estimate | EC dhl_fuel_surcharge_b | FB dhl_fuel_surcharge_c | FC dhl_fuel_surcharge_f | FF dhl_smartphone_box | GA dhl_laptop_box | GB dhl_bottle_box | GC dhl_repacking | GD dhl_tablet_box | GE dhl_filler_material | GF dhl_packaging | GG dhl_diplomatic_bag | GH dhl_pallet_box | GI dhl_lock_box | GJ dhl_lithium_ion_pi965_section_ii | HB dhl_dry_ice_un1845 | HC dhl_lithium_ion_pi965_966_section_ii | HD dhl_dangerous_goods | HE dhl_perishable_cargo | HG dhl_excepted_quantity | HH dhl_spill_cleaning | HI dhl_consumer_commodities | HK dhl_limited_quantities_adr | HL dhl_lithium_metal_pi969_section_ii | HM dhl_adr_load_exemption | HN dhl_lithium_ion_pi967_section_ii | HV dhl_lithium_metal_pi970_section_ii | HW dhl_biological_un3373 | HY dhl_extended_liability | IB dhl_contract_insurance | IC dhl_shipment_insurance | II dhl_delivery_notification | JA dhl_pickup_notification | JC dhl_proactive_tracking | JD dhl_performance_reporting | JE dhl_prealert_notification | JY dhl_change_of_billing | KA dhl_cash_on_delivery | KB dhl_printed_invoice | KD dhl_waybill_copy | KE dhl_import_paperwork | KF dhl_payment_on_pickup | KY dhl_shipment_intercept | LA dhl_shipment_redirect | LC dhl_storage_at_facility | LE dhl_cold_storage | LG dhl_specific_routing | LH dhl_service_recovery | LV dhl_alternative_address | LW dhl_hold_for_collection | LX dhl_address_correction_a | MA dhl_address_correction_b | MB dhl_neutral_delivery | NN dhl_remote_area_pickup | OB dhl_remote_area_delivery_c | OC dhl_out_of_service_area | OE dhl_remote_area_delivery_o | OO dhl_shipment_preparation | PA dhl_shipment_labeling | PB dhl_shipment_consolidation | PC dhl_relabeling_data_entry | PD dhl_preprinted_waybill | PE dhl_piece_labelling | PS dhl_data_staging_03 | PT dhl_data_staging_06 | PU dhl_data_staging_12 | PV dhl_data_staging_24 | PW dhl_standard_pickup | PX dhl_scheduled_pickup | PY dhl_dedicated_pickup | QA dhl_early_pickup | QB dhl_late_pickup | QD dhl_residential_pickup | QE dhl_loading_waiting | QF dhl_bypass_injection | QH dhl_direct_injection | QI dhl_drop_off_at_facility | QY dhl_delivery_signature | SA dhl_content_signature | SB dhl_named_signature | SC dhl_adult_signature | SD dhl_contract_signature | SE dhl_alternative_signature | SW dhl_no_signature_required | SX dhl_dedicated_delivery | TA dhl_early_delivery | TB dhl_time_window_delivery | TC dhl_evening_delivery | TD dhl_delivery_on_appointment | TE dhl_return_undeliverable | TG dhl_swap_delivery | TH dhl_unloading_waiting | TJ dhl_residential_delivery | TK dhl_repeat_delivery | TN dhl_alternative_date | TT dhl_no_partial_delivery | TU dhl_service_point_24_7 | TV dhl_pre_9_00 | TW dhl_pre_10_30 | TX dhl_pre_12_00 | TY dhl_thermo_packaging | UA dhl_ambient_vialsafe | UB dhl_ambient_non_insulated | UC dhl_ambient_insulated | UD dhl_ambient_extreme | UE dhl_chilled_box_s | UF dhl_chilled_box_m | UG dhl_chilled_box_l | UH dhl_frozen_no_ice_s | UI dhl_frozen_no_ice_m | UJ dhl_frozen_no_ice_l | UK dhl_frozen_ice_sticks_s | UL dhl_frozen_ice_sticks_m | UM dhl_frozen_ice_sticks_l | UN dhl_frozen_ice_plates_s | UO dhl_frozen_ice_plates_m | UP dhl_frozen_ice_plates_l | UQ dhl_combination_no_ice | UR dhl_combination_dry_ice | US dhl_frozen_ice_sticks_e | UT dhl_frozen_ice_plates_e | UV dhl_customer_tcp_1 | UW dhl_thermo_accessories | VA dhl_absorbent_sleeve | VB dhl_cooland_wrap | VC dhl_dry_ice_supplies | VD dhl_pressure_bag_s | VE dhl_pressure_bag_m | VF dhl_pressure_bag_l | VG dhl_informal_clearance | WA dhl_formal_clearance | WB dhl_payment_deferment | WC dhl_clearance_authorization | WD dhl_multiline_entry | WE dhl_post_clearance_modification | WF dhl_handover_to_broker | WG dhl_physical_intervention | WH dhl_bio_phyto_veterinary_controls | WI dhl_obtaining_permits_and_licences | WJ dhl_bonded_storage | WK dhl_bonded_transit_documents | WL dhl_temporary_import_export | WM dhl_under_bond_guarantee | WN dhl_export_declaration | WO dhl_exporter_validation | WP dhl_certificate_of_origin | WQ dhl_document_translation | WR dhl_personal_effects | WS dhl_paperless_trade | WY dhl_import_export_taxes | XB dhl_unrecoverable_origin_tax | XC dhl_quarantine_inspection | XD dhl_merchandise_process | XE dhl_domestic_postal_tax | XF dhl_tier_two_tax | XG dhl_tier_three_tax | XH dhl_import_penalty | XI dhl_cargo_zone_process | XJ dhl_import_export_duties | XX dhl_premium_09_00 | Y1 dhl_premium_10_30 | Y2 dhl_premium_12_00 | Y3 dhl_over_sized_piece_b | YB dhl_over_handled_piece_c | YC dhl_multipiece_shipment | YE dhl_over_weight_piece_f | YF dhl_over_sized_piece_g | YG dhl_over_handled_piece_h | YH dhl_premium_9_00_i | YI dhl_premium_10_30_j | YJ dhl_premium_12_00_k | YK dhl_paket_shipment | YV dhl_breakbulk_mother | YW dhl_breakbulk_baby | YX dhl_over_weight_piece_y | YY dhl_customer_claim | ZA dhl_damage_compensation | ZB dhl_loss_compensation | ZC dhl_customer_rebate | ZD dhl_e_com_discount | ZE

### FedEx
Code | Identifier --- | --- blind_shipment | BLIND_SHIPMENT broker_select_option | BROKER_SELECT_OPTION call_before_delivery | CALL_BEFORE_DELIVERY cod | COD cod_remittance | COD_REMITTANCE custom_delivery_window | CUSTOM_DELIVERY_WINDOW cut_flowers | CUT_FLOWERS dangerous_goods | DANGEROUS_GOODS delivery_on_invoice_acceptance | DELIVERY_ON_INVOICE_ACCEPTANCE detention | DETENTION do_not_break_down_pallets | DO_NOT_BREAK_DOWN_PALLETS do_not_stack_pallets | DO_NOT_STACK_PALLETS dry_ice | DRY_ICE east_coast_special | EAST_COAST_SPECIAL electronic_trade_documents | ELECTRONIC_TRADE_DOCUMENTS event_notification | EVENT_NOTIFICATION exclude_from_consolidation | EXCLUDE_FROM_CONSOLIDATION exclusive_use | EXCLUSIVE_USE exhibition_delivery | EXHIBITION_DELIVERY exhibition_pickup | EXHIBITION_PICKUP expedited_alternate_delivery_route | EXPEDITED_ALTERNATE_DELIVERY_ROUTE expedited_one_day_earlier | EXPEDITED_ONE_DAY_EARLIER expedited_service_monitoring_and_delivery | EXPEDITED_SERVICE_MONITORING_AND_DELIVERY expedited_standard_day_early_delivery | EXPEDITED_STANDARD_DAY_EARLY_DELIVERY extra_labor | EXTRA_LABOR extreme_length | EXTREME_LENGTH fedex_one_rate | FEDEX_ONE_RATE flatbed_trailer | FLATBED_TRAILER food | FOOD freight_guarantee | FREIGHT_GUARANTEE freight_to_collect | FREIGHT_TO_COLLECT future_day_shipment | FUTURE_DAY_SHIPMENT hold_at_location | HOLD_AT_LOCATION holiday_delivery | HOLIDAY_DELIVERY holiday_guarantee | HOLIDAY_GUARANTEE home_delivery_premium | HOME_DELIVERY_PREMIUM inside_delivery | INSIDE_DELIVERY inside_pickup | INSIDE_PICKUP international_controlled_export_service | INTERNATIONAL_CONTROLLED_EXPORT_SERVICE international_mail_service | INTERNATIONAL_MAIL_SERVICE international_traffic_in_arms_regulations | INTERNATIONAL_TRAFFIC_IN_ARMS_REGULATIONS liftgate_delivery | LIFTGATE_DELIVERY liftgate_pickup | LIFTGATE_PICKUP limited_access_delivery | LIMITED_ACCESS_DELIVERY limited_access_pickup | LIMITED_ACCESS_PICKUP marking_or_tagging | MARKING_OR_TAGGING non_business_time | NON_BUSINESS_TIME pallet_shrinkwrap | PALLET_SHRINKWRAP pallet_weight_allowance | PALLET_WEIGHT_ALLOWANCE pallets_provided | PALLETS_PROVIDED pending_complete | PENDING_COMPLETE pending_shipment | PENDING_SHIPMENT permit | PERMIT pharmacy_delivery | PHARMACY_DELIVERY poison | POISON port_delivery | PORT_DELIVERY port_pickup | PORT_PICKUP pre_delivery_notification | PRE_DELIVERY_NOTIFICATION pre_eig_processing | PRE_EIG_PROCESSING pre_multiplier_processing | PRE_MULTIPLIER_PROCESSING protection_from_freezing | PROTECTION_FROM_FREEZING regional_mall_delivery | REGIONAL_MALL_DELIVERY regional_mall_pickup | REGIONAL_MALL_PICKUP return_shipment | RETURN_SHIPMENT returns_clearance | RETURNS_CLEARANCE returns_clearance_special_routing_required | RETURNS_CLEARANCE_SPECIAL_ROUTING_REQUIRED saturday_delivery | SATURDAY_DELIVERY saturday_pickup | SATURDAY_PICKUP shipment_assembly | SHIPMENT_ASSEMBLY sort_and_segregate | SORT_AND_SEGREGATE special_delivery | SPECIAL_DELIVERY special_equipment | SPECIAL_EQUIPMENT storage | STORAGE sunday_delivery | SUNDAY_DELIVERY third_party_consignee | THIRD_PARTY_CONSIGNEE top_load | TOP_LOAD usps_delivery | USPS_DELIVERY usps_pickup | USPS_PICKUP weighing | WEIGHING

### Purolator
Code | Identifier --- | --- dangerous_goods | Dangerous Goods chain_of_signature | Chain of Signature express_cheque | ExpressCheque hold_for_pickup | Hold For Pickup return_services | Return Services saturday_service | Saturday Service origin_signature_not_required | Origin Signature Not Required (OSNR) adult_signature_required | Adult Signature Required (ASR) special_handling | Special Handling

### UPS
Code | Identifier --- | --- saturday_delivery_indicator | SaturdayDeliveryIndicator access_point_cod | AccessPointCOD deliver_to_addressee_only_indicator | DeliverToAddresseeOnlyIndicator direct_delivery_only_indicator | DirectDeliveryOnlyIndicator cod | COD delivery_confirmation | DeliveryConfirmation return_of_document_indicator | ReturnOfDocumentIndicator up_scarbonneutral_indicator | UPScarbonneutralIndicator certificate_of_origin_indicator | CertificateOfOriginIndicator pickup_options | PickupOptions delivery_options | DeliveryOptions restricted_articles | RestrictedArticles shipper_export_declaration_indicator | ShipperExportDeclarationIndicator commercial_invoice_removal_indicator | CommercialInvoiceRemovalIndicator import_control | ImportControl return_service | ReturnService sdl_shipment_indicator | SDLShipmentIndicator epra_indicator | EPRAIndicator

### Freightcom
Code | Identifier --- | --- freightcom_saturday_pickup_required | saturdayPickupRequired freightcom_homeland_security | homelandSecurity freightcom_exhibition_convention_site | exhibitionConventionSite freightcom_military_base_delivery | militaryBaseDelivery freightcom_customs_in_bond_freight | customsIn_bondFreight freightcom_limited_access | limitedAccess freightcom_excess_length | excessLength freightcom_tailgate_pickup | tailgatePickup freightcom_residential_pickup | residentialPickup freightcom_cross_border_fee | crossBorderFee freightcom_notify_recipient | notifyRecipient freightcom_single_shipment | singleShipment freightcom_tailgate_delivery | tailgateDelivery freightcom_residential_delivery | residentialDelivery freightcom_insurance_type | insuranceType freightcom_inside_delivery | insideDelivery freightcom_is_saturday_service | isSaturdayService freightcom_dangerous_goods_type | dangerousGoodsType freightcom_stackable | stackable

### eShipper
Code | Identifier --- | --- eshipper_saturday_pickup_required | saturdayPickupRequired eshipper_homeland_security | homelandSecurity eshipper_exhibition_convention_site | exhibitionConventionSite eshipper_military_base_delivery | militaryBaseDelivery eshipper_customs_in_bond_freight | customsIn_bondFreight eshipper_limited_access | limitedAccess eshipper_excess_length | excessLength eshipper_tailgate_pickup | tailgatePickup eshipper_residential_pickup | residentialPickup eshipper_cross_border_fee | crossBorderFee eshipper_notify_recipient | notifyRecipient eshipper_single_shipment | singleShipment eshipper_tailgate_delivery | tailgateDelivery eshipper_residential_delivery | residentialDelivery eshipper_insurance_type | insuranceType eshipper_inside_delivery | insideDelivery eshipper_is_saturday_service | isSaturdayService eshipper_dangerous_goods_type | dangerousGoodsType eshipper_stackable | stackable


## Shipment Services
### Canada Post
Code | Identifier --- | --- canadapost_regular_parcel | DOM.RP canadapost_expedited_parcel | DOM.EP canadapost_xpresspost | DOM.XP canadapost_priority | DOM.PC canadapost_library_books | DOM.LIB canadapost_expedited_parcel_usa | USA.EP canadapost_priority_worldwide_envelope_usa | USA.PW.ENV canadapost_priority_worldwide_pak_usa | USA.PW.PAK canadapost_priority_worldwide_parcel_usa | USA.PW.PARCEL canadapost_small_packet_usa_air | USA.SP.AIR canadapost_tracked_packet_usa | USA.TP canadapost_tracked_packet_usa_lvm | USA.TP.LVM canadapost_xpresspost_usa | USA.XP canadapost_xpresspost_international | INT.XP canadapost_international_parcel_air | INT.IP.AIR canadapost_international_parcel_surface | INT.IP.SURF canadapost_priority_worldwide_envelope_intl | INT.PW.ENV canadapost_priority_worldwide_pak_intl | INT.PW.PAK canadapost_priority_worldwide_parcel_intl | INT.PW.PARCEL canadapost_small_packet_international_air | INT.SP.AIR canadapost_small_packet_international_surface | INT.SP.SURF canadapost_tracked_packet_international | INT.TP

### DHL
Code | Identifier --- | --- dhl_logistics_services | LOGISTICS SERVICES dhl_domestic_express_12_00_doc | DOMESTIC EXPRESS 12:00 DOC dhl_b2_c_doc | B2C DOC dhl_b2_c_nondoc | B2C NONDOC dhl_jetline | JETLINE dhl_sprintline | SPRINTLINE dhl_express_easy_doc | EXPRESS EASY DOC dhl_express_easy_nondoc | EXPRESS EASY NONDOC dhl_europack_doc | EUROPACK DOC dhl_auto_reversals | AUTO REVERSALS dhl_breakbulk_express_doc | BREAKBULK EXPRESS DOC dhl_medical_express_doc | MEDICAL EXPRESS DOC dhl_express_worldwide_doc | EXPRESS WORLDWIDE DOC dhl_express_9_00_nondoc | EXPRESS 9:00 NONDOC dhl_freight_worldwide_nondoc | FREIGHT WORLDWIDE NONDOC dhl_domestic_economy_select_doc | DOMESTIC ECONOMY SELECT DOC dhl_economy_select_nondoc | ECONOMY SELECT NONDOC dhl_domestic_express_9_00_doc | DOMESTIC EXPRESS 9:00 DOC dhl_jumbo_box_nondoc | JUMBO BOX NONDOC dhl_express_9_00_doc | EXPRESS 9:00 DOC dhl_express_10_30_doc | EXPRESS 10:30 DOC dhl_express_10_30_nondoc | EXPRESS 10:30 NONDOC dhl_domestic_express_doc | DOMESTIC EXPRESS DOC dhl_domestic_express_10_30_doc | DOMESTIC EXPRESS 10:30 DOC dhl_express_worldwide_nondoc | EXPRESS WORLDWIDE NONDOC dhl_medical_express_nondoc | MEDICAL EXPRESS NONDOC dhl_globalmail_business_doc | GLOBALMAIL BUSINESS DOC dhl_same_day_doc | SAME DAY DOC dhl_express_12_00_doc | EXPRESS 12:00 DOC dhl_europack_nondoc | EUROPACK NONDOC dhl_economy_select_doc | ECONOMY SELECT DOC dhl_express_envelope_doc | EXPRESS ENVELOPE DOC dhl_express_12_00_nondoc | EXPRESS 12:00 NONDOC dhl_destination_charges | Destination Charges

### FedEx
Code | Identifier --- | --- europe_first_international_priority | EUROPE_FIRST_INTERNATIONAL_PRIORITY fedex_1_day_freight | FEDEX_1_DAY_FREIGHT fedex_2_day | FEDEX_2_DAY fedex_2_day_am | FEDEX_2_DAY_AM fedex_2_day_freight | FEDEX_2_DAY_FREIGHT fedex_3_day_freight | FEDEX_3_DAY_FREIGHT fedex_cargo_airport_to_airport | FEDEX_CARGO_AIRPORT_TO_AIRPORT fedex_cargo_freight_forwarding | FEDEX_CARGO_FREIGHT_FORWARDING fedex_cargo_international_express_freight | FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT fedex_cargo_international_premium | FEDEX_CARGO_INTERNATIONAL_PREMIUM fedex_cargo_mail | FEDEX_CARGO_MAIL fedex_cargo_registered_mail | FEDEX_CARGO_REGISTERED_MAIL fedex_cargo_surface_mail | FEDEX_CARGO_SURFACE_MAIL fedex_custom_critical_air_expedite | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE fedex_custom_critical_air_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_air_expedite_network | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK fedex_custom_critical_charter_air | FEDEX_CUSTOM_CRITICAL_CHARTER_AIR fedex_custom_critical_point_to_point | FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT fedex_custom_critical_surface_expedite | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE fedex_custom_critical_surface_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_temp_assure_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR fedex_custom_critical_temp_assure_validated_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR fedex_custom_critical_white_glove_services | FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES fedex_distance_deferred | FEDEX_DISTANCE_DEFERRED fedex_express_saver | FEDEX_EXPRESS_SAVER fedex_first_freight | FEDEX_FIRST_FREIGHT fedex_freight_economy | FEDEX_FREIGHT_ECONOMY fedex_freight_priority | FEDEX_FREIGHT_PRIORITY fedex_ground | FEDEX_GROUND fedex_international_priority_plus | FEDEX_INTERNATIONAL_PRIORITY_PLUS fedex_next_day_afternoon | FEDEX_NEXT_DAY_AFTERNOON fedex_next_day_early_morning | FEDEX_NEXT_DAY_EARLY_MORNING fedex_next_day_end_of_day | FEDEX_NEXT_DAY_END_OF_DAY fedex_next_day_freight | FEDEX_NEXT_DAY_FREIGHT fedex_next_day_mid_morning | FEDEX_NEXT_DAY_MID_MORNING first_overnight | FIRST_OVERNIGHT ground_home_delivery | GROUND_HOME_DELIVERY international_distribution_freight | INTERNATIONAL_DISTRIBUTION_FREIGHT international_economy | INTERNATIONAL_ECONOMY international_economy_distribution | INTERNATIONAL_ECONOMY_DISTRIBUTION international_economy_freight | INTERNATIONAL_ECONOMY_FREIGHT international_first | INTERNATIONAL_FIRST international_ground | INTERNATIONAL_GROUND international_priority | INTERNATIONAL_PRIORITY international_priority_distribution | INTERNATIONAL_PRIORITY_DISTRIBUTION international_priority_express | INTERNATIONAL_PRIORITY_EXPRESS international_priority_freight | INTERNATIONAL_PRIORITY_FREIGHT priority_overnight | PRIORITY_OVERNIGHT same_day | SAME_DAY same_day_city | SAME_DAY_CITY same_day_metro_afternoon | SAME_DAY_METRO_AFTERNOON same_day_metro_morning | SAME_DAY_METRO_MORNING same_day_metro_rush | SAME_DAY_METRO_RUSH smart_post | SMART_POST standard_overnight | STANDARD_OVERNIGHT transborder_distribution_consolidation | TRANSBORDER_DISTRIBUTION_CONSOLIDATION

### Purolator
Code | Identifier --- | --- purolator_express_9_am | PurolatorExpress9AM purolator_express_us | PurolatorExpressU.S. purolator_express_10_30_am | PurolatorExpress10:30AM purolator_express_us_9_am | PurolatorExpressU.S.9AM purolator_express_12_pm | PurolatorExpress12PM purolator_express_us_10_30_am | PurolatorExpressU.S.10:30AM purolator_express | PurolatorExpress purolator_express_us_12_00 | PurolatorExpressU.S.12:00 purolator_express_evening | PurolatorExpressEvening purolator_express_envelope_us | PurolatorExpressEnvelopeU.S. purolator_express_envelope_9_am | PurolatorExpressEnvelope9AM purolator_express_us_envelope_9_am | PurolatorExpressU.S.Envelope9AM purolator_express_envelope_10_30_am | PurolatorExpressEnvelope10:30AM purolator_express_us_envelope_10_30_am | PurolatorExpressU.S.Envelope10:30AM purolator_express_envelope_12_pm | PurolatorExpressEnvelope12PM purolator_express_us_envelope_12_00 | PurolatorExpressU.S.Envelope12:00 purolator_express_envelope | PurolatorExpressEnvelope purolator_express_pack_us | PurolatorExpressPackU.S. purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening purolator_express_us_pack_9_am | PurolatorExpressU.S.Pack9AM purolator_express_pack_9_am | PurolatorExpressPack9AM purolator_express_us_pack_10_30_am | PurolatorExpressU.S.Pack10:30AM purolator_express_pack10_30_am | PurolatorExpressPack10:30AM purolator_express_us_pack_12_00 | PurolatorExpressU.S.Pack12:00 purolator_express_pack_12_pm | PurolatorExpressPack12PM purolator_express_box_us | PurolatorExpressBoxU.S. purolator_express_pack | PurolatorExpressPack purolator_express_us_box_9_am | PurolatorExpressU.S.Box9AM purolator_express_pack_evening | PurolatorExpressPackEvening purolator_express_us_box_10_30_am | PurolatorExpressU.S.Box10:30AM purolator_express_box_9_am | PurolatorExpressBox9AM purolator_express_us_box_12_00 | PurolatorExpressU.S.Box12:00 purolator_express_box_10_30_am | PurolatorExpressBox10:30AM purolator_ground_us | PurolatorGroundU.S. purolator_express_box_12_pm | PurolatorExpressBox12PM purolator_express_international | PurolatorExpressInternational purolator_express_box | PurolatorExpressBox purolator_express_international_9_am | PurolatorExpressInternational9AM purolator_express_box_evening | PurolatorExpressBoxEvening purolator_express_international_10_30_am | PurolatorExpressInternational10:30AM purolator_ground | PurolatorGround purolator_express_international_12_00 | PurolatorExpressInternational12:00 purolator_ground9_am | PurolatorGround9AM purolator_express_envelope_international | PurolatorExpressEnvelopeInternational purolator_ground10_30_am | PurolatorGround10:30AM purolator_express_international_envelope_9_am | PurolatorExpressInternationalEnvelope9AM purolator_ground_evening | PurolatorGroundEvening purolator_express_international_envelope_10_30_am | PurolatorExpressInternationalEnvelope10:30AM purolator_quick_ship | PurolatorQuickShip purolator_express_international_envelope_12_00 | PurolatorExpressInternationalEnvelope12:00 purolator_quick_ship_envelope | PurolatorQuickShipEnvelope purolator_express_pack_international | PurolatorExpressPackInternational purolator_quick_ship_pack | PurolatorQuickShipPack purolator_express_international_pack_9_am | PurolatorExpressInternationalPack9AM purolator_quick_ship_box | PurolatorQuickShipBox purolator_express_international_pack_10_30_am | PurolatorExpressInternationalPack10:30AM purolator_express_international_pack_12_00 | PurolatorExpressInternationalPack12:00 purolator_express_box_international | PurolatorExpressBoxInternational purolator_express_international_box_9_am | PurolatorExpressInternationalBox9AM purolator_express_international_box_10_30_am | PurolatorExpressInternationalBox10:30AM purolator_express_international_box_12_00 | PurolatorExpressInternationalBox12:00

### UPS
Code | Identifier --- | --- ups_standard | 11 ups_worldwide_expedited | 08 ups_worldwide_express | 07 ups_worldwide_express_plus | 54 ups_worldwide_saver | 65 ups_2nd_day_air | 02 ups_2nd_day_air_am | 59 ups_3_day_select | 12 ups_expedited_mail_innovations | M4 ups_first_class_mail | M2 ups_ground | 03 ups_next_day_air | 01 ups_next_day_air_early | 14 ups_next_day_air_saver | 13 ups_priority_mail | M3 ups_access_point_economy | 70 ups_today_dedicated_courier | 83 ups_today_express | 85 ups_today_express_saver | 86 ups_today_standard | 82 ups_worldwide_express_freight | 96 ups_priority_mail_innovations | M5 ups_economy_mail_innovations | M6

### Freightcom
Code | Identifier --- | --- freightcom_central_transport | 2029 freigthcom_estes | 2107 freigthcom_usf_holland | 1911 freightcom_fedex_ground | 4101 freightcom_ups_standard | 4600 freightcom_fedex_2_day | 4102 freightcom_fedex_priority_overnight | 4104 freightcom_fedex_standard_overnight | 4105 freightcom_ground | 3400 freightcom_ups_expedited | 4601 freightcom_ups_express_saver | 4602 freightcom_ups_express | 4603 freightcom_fedex_express_saver | 4100 freightcom_ups_express_early | 4604 freightcom_select | 3404 freightcom_dayr_e_comm_ground_service | 5707 freightcom_overnight | 3407 freightcom_purolator_ground | 4000 freightcom_purolator_express | 4003 freightcom_purolator_express_10_30_am | 4005 freightcom_fedex_first_overnight | 4106 freightcom_purolator_express_9_am | 4004 freightcom_dayr_e_comm_am_service | 5706

### eShipper
Code | Identifier --- | --- eshipper_fedex_priority | 1 eshipper_fedex_first_overnight | 2 eshipper_fedex_ground | 3 eshipper_fedex_standard_overnight | 28 eshipper_fedex_2nd_day | 29 eshipper_fedex_express_saver | 30 eshipper_purolator_air | 4 eshipper_purolator_air_9_am | 5 eshipper_purolator_air_10_30 | 6 eshipper_puroletter | 7 eshipper_puroletter_9_am | 8 eshipper_puroletter_10_30 | 9 eshipper_puro_pak | 10 eshipper_puro_pak_9_am | 11 eshipper_puro_pak_10_30 | 12 eshipper_purolator_ground | 13 eshipper_purolator_ground_9_am | 19 eshipper_purolator_ground_10_30 | 20 eshipper_canada_worldwide_same_day | 14 eshipper_canada_worldwide_next_flight_out | 15 eshipper_canada_worldwide_air_freight | 16 eshipper_canada_worldwide_ltl | 17 eshipper_dhl_international_express | 106 eshipper_ups_express_next_day_air | 600 eshipper_ups_expedited_second_day_air | 601 eshipper_ups_worldwide_express | 602 eshipper_ups_worldwide_expedited | 603 eshipper_ups_standard_ground | 604 eshipper_ups_express_early_am_next_day_air_early_am | 605 eshipper_ups_three_day_select | 606 eshipper_ups_saver | 607 eshipper_ups_ground | 608 eshipper_next_day_saver | 609 eshipper_worldwide_express_plus | 610 eshipper_second_day_air_am | 611 eshipper_canada_post_priority | 500 eshipper_canada_post_xpress_post | 501 eshipper_canada_post_expedited | 502 eshipper_canada_post_regular | 503 eshipper_canada_post_xpress_post_usa | 504 eshipper_canada_post_xpress_post_intl | 505 eshipper_canada_post_air_parcel_intl | 506 eshipper_canada_post_surface_parcel_intl | 507 eshipper_canada_post_expedited_parcel_usa | 508 eshipper_tst_ltl | 1100 eshipper_ltl_chicago_suburban_express | 1500 eshipper_ltl_fedex_freight_east | 1501 eshipper_ltl_fedex_freight_west | 1502 eshipper_ltl_mid_states_express | 1503 eshipper_ltl_new_england_motor_freight | 1504 eshipper_ltl_new_penn | 1505 eshipper_ltl_oak_harbor | 1506 eshipper_ltl_pitt_ohio | 1507 eshipper_ltl_r_l_carriers | 1508 eshipper_ltl_saia | 1509 eshipper_ltl_usf_reddaway | 1510 eshipper_ltl_vitran_express | 1511 eshipper_ltl_wilson_trucking | 1512 eshipper_ltl_yellow_transportation | 1513 eshipper_ltl_roadway | 1514 eshipper_ltl_fedex_national | 1515 eshipper_wilson_trucking_tfc | 1800 eshipper_aaa_cooper_transportation | 1801 eshipper_roadrunner_dawes | 1802 eshipper_new_england_motor_freight | 1803 eshipper_new_penn_motor_express | 1804 eshipper_dayton_freight | 1805 eshipper_southeastern_freightway | 1806 eshipper_saia_inc | 1807 eshipper_conway | 1808 eshipper_roadway | 1809 eshipper_usf_reddaway | 1810 eshipper_usf_holland | 1811 eshipper_dependable_highway_express | 1812 eshipper_day_and_ross | 1813 eshipper_day_and_ross_r_and_l | 1814 eshipper_ups | 1815 eshipper_aaa_cooper | 1816 eshipper_ama_transportation | 1817 eshipper_averitt_express | 1818 eshipper_central_freight | 1819 eshipper_conway_us | 1820 eshipper_dayton | 1821 eshipper_drug_transport | 1822 eshipper_estes | 1823 eshipper_land_air_express | 1824 eshipper_fedex_west | 1825 eshipper_fedex_national | 1826 eshipper_usf_holland_us | 1827 eshipper_lakeville_m_express | 1828 eshipper_milan_express | 1829 eshipper_nebraska_transport | 1830 eshipper_new_england | 1831 eshipper_new_penn | 1832 eshipper_a_duie_pyle | 1833 eshipper_roadway_us | 1834 eshipper_usf_reddaway_us | 1835 eshipper_rhody_transportation | 1836 eshipper_saia_motor_freight | 1837 eshipper_southeastern_frgt | 1838 eshipper_pitt_ohio | 1839 eshipper_ward | 1840 eshipper_wilson | 1841 eshipper_chi_cargo | 1842 eshipper_tax_air | 1843 eshipper_fedex_east | 1844 eshipper_central_transport | 1845 eshipper_roadrunner | 1846 eshipper_r_and_l_carriers | 1847 eshipper_estes_us | 1848 eshipper_yrc_roadway | 1849 eshipper_central_transport_us | 1850 eshipper_absolute_transportation_services | 1851 eshipper_blue_sky_express | 1852 eshipper_galasso_trucking | 1853 eshipper_griley_air_freight | 1854 eshipper_jet_transportation | 1855 eshipper_metro_transportation_logistics | 1856 eshipper_oak_harbor | 1857 eshipper_stream_links_express | 1858 eshipper_tiffany_trucking | 1859 eshipper_ups_freight | 1860 eshipper_roadrunner_us | 1861 eshipper_global_mail_parcel_priority | 3500 eshipper_global_mail_parcel_standard | 3501 eshipper_global_mail_packet_plus_priority | 3502 eshipper_global_mail_packet_priority | 3503 eshipper_global_mail_packet_standard | 3504 eshipper_global_mail_business_priority | 3505 eshipper_global_mail_business_standard | 3506 eshipper_global_mail_parcel_direct_priority | 3507 eshipper_global_mail_parcel_direct_standard | 3508 eshipper_ground | 4500 eshipper_select_parcel | 4504 eshipper_express_parcel | 4507


# noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.references(async_req=True) + >>> result = thread.get() + + :param async_req bool + :return: References + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.references_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.references_with_http_info(**kwargs) # noqa: E501 + return data + + def references_with_http_info(self, **kwargs): # noqa: E501 + """Data References # noqa: E501 + + ## Countries
Code | Name --- | --- AD | ANDORRA AE | UNITED ARAB EMIRATES AF | AFGHANISTAN AG | ANTIGUA AI | ANGUILLA AL | ALBANIA AM | ARMENIA AN | NETHERLANDS ANTILLES AO | ANGOLA AR | ARGENTINA AS | AMERICAN SAMOA AT | AUSTRIA AU | AUSTRALIA AW | ARUBA AZ | AZERBAIJAN BA | BOSNIA AND HERZEGOVINA BB | BARBADOS BD | BANGLADESH BE | BELGIUM BF | BURKINA FASO BG | BULGARIA BH | BAHRAIN BI | BURUNDI BJ | BENIN BM | BERMUDA BN | BRUNEI BO | BOLIVIA BR | BRAZIL BS | BAHAMAS BT | BHUTAN BW | BOTSWANA BY | BELARUS BZ | BELIZE CA | CANADA CD | CONGO, THE DEMOCRATIC REPUBLIC OF CF | CENTRAL AFRICAN REPUBLIC CG | CONGO CH | SWITZERLAND CI | COTE D IVOIRE CK | COOK ISLANDS CL | CHILE CM | CAMEROON CN | CHINA, PEOPLES REPUBLIC CO | COLOMBIA CR | COSTA RICA CU | CUBA CV | CAPE VERDE CY | CYPRUS CZ | CZECH REPUBLIC, THE DE | GERMANY DJ | DJIBOUTI DK | DENMARK DM | DOMINICA DO | DOMINICAN REPUBLIC DZ | ALGERIA EC | ECUADOR EE | ESTONIA EG | EGYPT ER | ERITREA ES | SPAIN ET | ETHIOPIA FI | FINLAND FJ | FIJI FK | FALKLAND ISLANDS FM | MICRONESIA, FEDERATED STATES OF FO | FAROE ISLANDS FR | FRANCE GA | GABON GB | UNITED KINGDOM GD | GRENADA GE | GEORGIA GF | FRENCH GUYANA GG | GUERNSEY GH | GHANA GI | GIBRALTAR GL | GREENLAND GM | GAMBIA GN | GUINEA REPUBLIC GP | GUADELOUPE GQ | GUINEA-EQUATORIAL GR | GREECE GT | GUATEMALA GU | GUAM GW | GUINEA-BISSAU GY | GUYANA (BRITISH) HK | HONG KONG HN | HONDURAS HR | CROATIA HT | HAITI HU | HUNGARY IC | CANARY ISLANDS, THE ID | INDONESIA IE | IRELAND, REPUBLIC OF IL | ISRAEL IN | INDIA IQ | IRAQ IR | IRAN (ISLAMIC REPUBLIC OF) IS | ICELAND IT | ITALY JE | JERSEY JM | JAMAICA JO | JORDAN JP | JAPAN KE | KENYA KG | KYRGYZSTAN KH | CAMBODIA KI | KIRIBATI KM | COMOROS KN | ST. KITTS KP | KOREA, THE D.P.R OF (NORTH K.) KR | KOREA, REPUBLIC OF (SOUTH K.) KV | KOSOVO KW | KUWAIT KY | CAYMAN ISLANDS KZ | KAZAKHSTAN LA | LAO PEOPLES DEMOCRATIC REPUBLIC LB | LEBANON LC | ST. LUCIA LI | LIECHTENSTEIN LK | SRI LANKA LR | LIBERIA LS | LESOTHO LT | LITHUANIA LU | LUXEMBOURG LV | LATVIA LY | LIBYA MA | MOROCCO MC | MONACO MD | MOLDOVA, REPUBLIC OF ME | MONTENEGRO, REPUBLIC OF MG | MADAGASCAR MH | MARSHALL ISLANDS MK | MACEDONIA, REPUBLIC OF ML | MALI MM | MYANMAR MN | MONGOLIA MO | MACAU MP | COMMONWEALTH NO. MARIANA ISLANDS MQ | MARTINIQUE MR | MAURITANIA MS | MONTSERRAT MT | MALTA MU | MAURITIUS MV | MALDIVES MW | MALAWI MX | MEXICO MY | MALAYSIA MZ | MOZAMBIQUE NA | NAMIBIA NC | NEW CALEDONIA NE | NIGER NG | NIGERIA NI | NICARAGUA NL | NETHERLANDS, THE NO | NORWAY NP | NEPAL NR | NAURU, REPUBLIC OF NU | NIUE NZ | NEW ZEALAND OM | OMAN PA | PANAMA PE | PERU PF | TAHITI PG | PAPUA NEW GUINEA PH | PHILIPPINES, THE PK | PAKISTAN PL | POLAND PR | PUERTO RICO PT | PORTUGAL PW | PALAU PY | PARAGUAY QA | QATAR RE | REUNION, ISLAND OF RO | ROMANIA RS | SERBIA, REPUBLIC OF RU | RUSSIAN FEDERATION, THE RW | RWANDA SA | SAUDI ARABIA SB | SOLOMON ISLANDS SC | SEYCHELLES SD | SUDAN SE | SWEDEN SG | SINGAPORE SH | SAINT HELENA SI | SLOVENIA SK | SLOVAKIA SL | SIERRA LEONE SM | SAN MARINO SN | SENEGAL SO | SOMALIA SR | SURINAME SS | SOUTH SUDAN ST | SAO TOME AND PRINCIPE SV | EL SALVADOR SY | SYRIA SZ | SWAZILAND TC | TURKS AND CAICOS ISLANDS TD | CHAD TG | TOGO TH | THAILAND TJ | TAJIKISTAN TL | TIMOR LESTE TN | TUNISIA TO | TONGA TR | TURKEY TT | TRINIDAD AND TOBAGO TV | TUVALU TW | TAIWAN TZ | TANZANIA UA | UKRAINE UG | UGANDA US | UNITED STATES OF AMERICA UY | URUGUAY UZ | UZBEKISTAN VA | VATICAN CITY STATE VC | ST. VINCENT VE | VENEZUELA VG | VIRGIN ISLANDS (BRITISH) VI | VIRGIN ISLANDS (US) VN | VIETNAM VU | VANUATU WS | SAMOA XB | BONAIRE XC | CURACAO XE | ST. EUSTATIUS XM | ST. MAARTEN XN | NEVIS XS | SOMALILAND, REP OF (NORTH SOMALIA) XY | ST. BARTHELEMY YE | YEMEN, REPUBLIC OF YT | MAYOTTE ZA | SOUTH AFRICA ZM | ZAMBIA ZW | ZIMBABWE

## States and Provinces
### UNITED ARAB EMIRATES
Code | Name --- | --- AB | Abu Dhabi AJ | Ajman DU | Dubai FU | Fujairah RA | Ras al-Khaimah SH | Sharjah UM | Umm al-Qaiwain

### CANADA
Code | Name --- | --- AB | Alberta BC | British Columbia MB | Manitoba NB | New Brunswick NL | Newfoundland NT | Northwest Territories NS | Nova Scotia NU | Nunavut ON | Ontario PE | Prince Edward Island QC | Quebec SK | Saskatchewan YT | Yukon

### CHINA, PEOPLES REPUBLIC
Code | Name --- | --- anhui | Anhui hainan | Hainan jiangxi | Jiangxi shanghai | Shanghai beijing | Beijing hebei | Hebei jilin | Jilin shanxi | Shanxi chongqing | Chongqing heilongjiang | Heilongjiang liaoning | Liaoning sichuan | Sichuan fujian | Fujian henan | Henan nei_mongol | Nei Mongol tianjin | Tianjin gansu | Gansu hubei | Hubei qinghai | Qinghai xinjiang | Xinjiang guangdong | Guangdong hunan | Hunan shaanxi | Shaanxi yunnan | Yunnan guizhou | Guizhou jiangsu | Jiangsu shandong | Shandong zhejiang | Zhejiang

### INDIA
Code | Name --- | --- AN | Andaman & Nicobar (U.T) AP | Andhra Pradesh AR | Arunachal Pradesh AS | Assam BR | Bihar CG | Chattisgarh CH | Chandigarh (U.T.) DD | Daman & Diu (U.T.) DL | Delhi (U.T.) DN | Dadra and Nagar Haveli (U.T.) GA | Goa GJ | Gujarat HP | Himachal Pradesh HR | Haryana JH | Jharkhand JK | Jammu & Kashmir KA | Karnataka KL | Kerala LD | Lakshadweep (U.T) MH | Maharashtra ML | Meghalaya MN | Manipur MP | Madhya Pradesh MZ | Mizoram NL | Nagaland OR | Orissa PB | Punjab PY | Puducherry (U.T.) RJ | Rajasthan SK | Sikkim TN | Tamil Nadu TR | Tripura UA | Uttaranchal UP | Uttar Pradesh WB | West Bengal

### MEXICO
Code | Name --- | --- AG | Aguascalientes BC | Baja California BS | Baja California Sur CM | Campeche CS | Chiapas CH | Chihuahua CO | Coahuila CL | Colima DF | Ciudad de México DG | Durango GT | Guanajuato GR | Guerrero HG | Hidalgo JA | Jalisco EM | Estado de México MI | Michoacán MO | Morelos NA | Nayarit NL | Nuevo León OA | Oaxaca PU | Puebla QE | Querétaro QR | Quintana Roo SL | San Luis Potosí SI | Sinaloa SO | Sonora TB | Tabasco TM | Tamaulipas TL | Tlaxcala VE | Veracruz YU | Yucatán ZA | Zacatecas

### UNITED STATES OF AMERICA
Code | Name --- | --- AL | Alabama AK | Alaska AZ | Arizona AR | Arkansas CA | California CO | Colorado CT | Connecticut DE | Delaware DC | District of Columbia FL | Florida GA | Georgia HI | Hawaii ID | Idaho IL | Illinois IN | Indiana IA | Iowa KS | Kansas KY | Kentucky LA | Louisiana ME | Maine MD | Maryland MA | Massachusetts MI | Michigan MN | Minnesota MS | Mississippi MO | Missouri MT | Montana NE | Nebraska NV | Nevada NH | New Hampshire NJ | New Jersey NM | New Mexico NY | New York NC | North Carolina ND | North Dakota OH | Ohio OK | Oklahoma OR | Oregon PA | Pennsylvania RI | Rhode Island SC | South Carolina SD | South Dakota TN | Tennessee TX | Texas UT | Utah VT | Vermont VA | Virginia WA | Washington State WV | West Virginia WI | Wisconsin WY | Wyoming PR | Puerto Rico


## Currencies
Code | Name --- | --- EUR | Euro AED | UAE Dirham USD | US Dollar XCD | East Caribbean Dollar AMD | Dran ANG | Netherlands Antilles Guilder AOA | Kwanza ARS | Argentine Peso AUD | Australian Dollar AWG | Aruba Guilder AZN | Manat BAM | Convertible Marks BBD | Barbadian Dollar BDT | Taka XOF | CFA Franc West Africa BGN | Bulgarian Lev BHD | Bahraini Dinar BIF | Burundese Franc BMD | Bermudian Dollar BND | Brunei Dollar BOB | Boliviano BRL | Real BSD | Bahamian Dollar BTN | Ngultrum BWP | Pula BYN | Belarussian Ruble BZD | Belize Dollar CAD | Canadian Dollar CDF | Franc Congolais XAF | CFA Franc Central Africa CHF | Swiss Franc NZD | New Zealand Dollar CLP | New Chile Peso CNY | Yuan (Ren Min Bi) COP | Colombian Peso CRC | Costa Rican Colon CUC | Peso Convertible CVE | Cape Verde Escudo CZK | Czech Koruna DJF | Djibouti Franc DKK | Danish Krone DOP | Dominican Republic Peso DZD | Algerian Dinar EGP | Egyptian Pound ERN | Nakfa ETB | Birr FJD | Fijian Dollar GBP | Pound Sterling GEL | Georgian Lari GHS | Cedi GMD | Dalasi GNF | Guinea Franc GTQ | Quetzal GYD | Guyanan Dollar HKD | Hong Kong Dollar HNL | Lempira HRK | Croatian Kuna HTG | Gourde HUF | Forint IDR | Rupiah ILS | New Israeli Shekel INR | Indian Rupee IRR | Iranian Rial ISK | Icelandic Krona JMD | Jamaican Dollar JOD | Jordanian Dinar JPY | Yen KES | Kenyan Shilling KGS | Som KHR | Khmer Rial KMF | Comoros Franc KPW | North Korean Won KRW | Won KWD | Kuwaiti Dinar KYD | Cayman Islands Dollar KZT | Tenge LAK | Kip LKR | Sri Lankan Rupee LRD | Liberian Dollar LSL | Loti LYD | Libyan Dinar MAD | Moroccan Dirham MDL | Leu MGA | Ariary MKD | Denar MMK | Kyat MNT | Tugrik MOP | Pataca MRO | Ouguiya MUR | Mauritius Rupee MVR | Rufiyaa MWK | Kwacha MXN | Mexican Nuevo Peso MYR | Ringgit MZN | Mozambique Metical NAD | Namibian Dollar XPF | CFP Franc NGN | Naira NIO | Cordoba Oro NOK | Norwegian Krone NPR | Nepalese Rupee OMR | Omani Rial PEN | Nuevo Sol PGK | Kina PHP | Phillipines Peso PKR | Pakistani Rupee PLN | Zloty PYG | Guarani QAR | Qatar Rial RSD | Serbia, Dinars RUB | Russian Ruble RWF | Rwanda Franc SAR | Saudi Riyal SBD | Solomon Islands Dollar SCR | Seychelles Rupee SDG | Sudanese Pound SEK | Swedish Krona SGD | Singapore Dollar SHP | St. Helena Pound SLL | Leone SOS | Somali Shilling SRD | Suriname Dollar SSP | South Sudanese pound STD | Dobra SYP | Syrian Pound SZL | Lilangeni THB | Baht TJS | Somoni TND | Tunisian Dinar TOP | Pa'anga TRY | New Turkish Lira TTD | Trinidad and Tobago Dollar TWD | New Taiwan Dollar TZS | Tanzanian Shilling UAH | Hryvna UYU | Peso Uruguayo UZS | Sum VEF | Bolivar Fuerte VND | Dong VUV | Vanuatu Vatu WST | Tala YER | Yemeni Riyal ZAR | South African Rand

## Packaging Type
### Multi-carrier (purplship)
Code | Identifier --- | --- envelope | Small Envelope pak | Pak tube | Tube pallet | Pallet small_box | Small Box medium_box | Medium Box your_packaging | Your Packaging


## Package Preset
### Canada Post
Code | Dimensions | Note --- | --- | --- canadapost_mailing_box | 15.2 x 10.2 | height x width canadapost_extra_small_mailing_box | 14.0 x 14.0 x 14.0 | height x length x width canadapost_small_mailing_box | 22.9 x 6.4 x 28.6 | height x length x width canadapost_medium_mailing_box | 23.5 x 13.3 x 31.0 | height x length x width canadapost_large_mailing_box | 30.5 x 9.5 x 38.1 | height x length x width canadapost_extra_large_mailing_box | 30.5 x 21.6 x 40.0 | height x length x width canadapost_corrugated_small_box | 32.0 x 32.0 x 42.0 | height x length x width canadapost_corrugated_medium_box | 38.0 x 32.0 x 46.0 | height x length x width canadapost_corrugated_large_box | 46.0 x 40.6 x 46.0 | height x length x width canadapost_xexpresspost_certified_envelope | 15.9 x 1.5 x 0.5 x 26.0 | height x length x weight x width canadapost_xexpresspost_national_large_envelope | 29.2 x 1.5 x 1.36 x 40.0 | height x length x weight x width

### DHL
Code | Dimensions | Note --- | --- | --- dhl_express_envelope | 27.5 x 1.0 x 0.5 x 35.0 | height x length x weight x width dhl_express_standard_flyer | 30.0 x 2.0 x 40.0 | height x weight x width dhl_express_large_flyer | 37.5 x 3.0 x 47.5 | height x weight x width dhl_express_box_2 | 18.2 x 10.0 x 1.0 x 33.7 | height x length x weight x width dhl_express_box_3 | 32.0 x 5.2 x 2.0 x 33.6 | height x length x weight x width dhl_express_box_4 | 32.2 x 18.0 x 5.0 x 33.7 | height x length x weight x width dhl_express_box_5 | 32.2 x 34.5 x 10.0 x 33.7 | height x length x weight x width dhl_express_box_6 | 35.9 x 36.9 x 15.0 x 41.7 | height x length x weight x width dhl_express_box_7 | 40.4 x 38.9 x 20.0 x 48.1 | height x length x weight x width dhl_express_box_8 | 44.4 x 40.9 x 25.0 x 54.2 | height x length x weight x width dhl_express_tube | 15.0 x 15.0 x 5.0 x 96.0 | height x length x weight x width dhl_didgeridoo_box | 13.0 x 162.0 x 10.0 x 13.0 | height x length x weight x width dhl_jumbo_box | 42.7 x 33.0 x 30.0 x 45.0 | height x length x weight x width dhl_jumbo_box_junior | 34.0 x 24.1 x 20.0 x 39.9 | height x length x weight x width

### FedEx
Code | Dimensions | Note --- | --- | --- fedex_envelope_legal_size | 15.5 x 1.0 x 9.5 | height x weight x width fedex_padded_pak | 14.75 x 2.2 x 11.75 | height x weight x width fedex_polyethylene_pak | 15.5 x 2.2 x 12.0 | height x weight x width fedex_clinical_pak | 18.0 x 2.2 x 13.5 | height x weight x width fedex_small_box | 10.9 x 1.5 x 20.0 x 12.25 | height x length x weight x width fedex_medium_box | 11.5 x 2.38 x 20.0 x 13.25 | height x length x weight x width fedex_large_box | 12.38 x 3.0 x 20.0 x 17.88 | height x length x weight x width fedex_10_kg_box | 12.94 x 10.19 x 10.0 x 15.81 | height x length x weight x width fedex_25_kg_box | 16.56 x 13.19 x 25.0 x 21.56 | height x length x weight x width fedex_tube | 6.0 x 6.0 x 20.0 x 38.0 | height x length x weight x width

### Purolator
Code | Dimensions | Note --- | --- | --- purolator_express_envelope | 1.0 | weight purolator_express_pack | 3.0 | weight purolator_express_box | 7.0 | weight

### UPS
Code | Dimensions | Note --- | --- | --- ups_small_express_box | 11.0 x 2.0 x 30.0 x 13.0 | height x length x weight x width ups_medium_express_box | 11.0 x 3.0 x 30.0 x 16.0 | height x length x weight x width ups_large_express_box | 13.0 x 3.0 x 30.0 x 18.0 | height x length x weight x width ups_express_tube | 6.0 x 6.0 x 38.0 | height x length x width ups_express_pak | 11.75 x 16.0 | height x width ups_world_document_box | 12.5 x 3.0 x 17.5 | height x length x width


## Shipment Options
### Canada Post
Code | Identifier --- | --- canadapost_signature | SO canadapost_coverage | COV canadapost_collect_on_delivery | COD canadapost_proof_of_age_required_18 | PA18 canadapost_proof_of_age_required_19 | PA19 canadapost_card_for_pickup | HFP canadapost_do_not_safe_drop | DNS canadapost_leave_at_door | LAD canadapost_deliver_to_post_office | D2PO canadapost_return_at_senders_expense | RASE canadapost_return_to_sender | RTS canadapost_abandon | ABAN

### DHL
Code | Identifier --- | --- dhl_logistics_services | 0A dhl_mailroom_management | 0B dhl_pallet_administration | 0C dhl_warehousing | 0D dhl_express_logistics_centre | 0E dhl_strategic_parts_centre | 0F dhl_local_distribution_centre | 0G dhl_terminal_handling | 0H dhl_cross_docking | 0I dhl_inventory_management | 0J dhl_loading_unloading | 0K dhl_product_kitting | 0L dhl_priority_account_desk | 0M dhl_document_archiving | 0N dhl_saturday_delivery | AA dhl_saturday_pickup | AB dhl_holiday_delivery | AC dhl_holiday_pickup | AD dhl_domestic_saturday_delivery | AG dhl_standard | BA dhl_globalmail_item | BB dhl_letter | BC dhl_packet | BD dhl_letter_plus | BE dhl_packet_plus | BF dhl_elevated_risk | CA dhl_restricted_destination | CB dhl_security_validation | CC dhl_secure_protection | CD dhl_proof_of_identity | CE dhl_secure_storage | CF dhl_diplomatic_material | CG dhl_smart_sensor | CH dhl_visa_program | CI dhl_onboard_courier | CJ dhl_secure_safebox | CK dhl_smart_sentry | CL dhl_split_duties_and_tax | DC dhl_duties_and_taxes_paid | DD dhl_receiver_paid | DE dhl_duties_and_taxes_unpaid | DS dhl_import_billing | DT dhl_importer_of_record | DU dhl_go_green_carbon_neutral | EA dhl_go_green_carbon_footprint | EB dhl_go_green_carbon_estimate | EC dhl_fuel_surcharge_b | FB dhl_fuel_surcharge_c | FC dhl_fuel_surcharge_f | FF dhl_smartphone_box | GA dhl_laptop_box | GB dhl_bottle_box | GC dhl_repacking | GD dhl_tablet_box | GE dhl_filler_material | GF dhl_packaging | GG dhl_diplomatic_bag | GH dhl_pallet_box | GI dhl_lock_box | GJ dhl_lithium_ion_pi965_section_ii | HB dhl_dry_ice_un1845 | HC dhl_lithium_ion_pi965_966_section_ii | HD dhl_dangerous_goods | HE dhl_perishable_cargo | HG dhl_excepted_quantity | HH dhl_spill_cleaning | HI dhl_consumer_commodities | HK dhl_limited_quantities_adr | HL dhl_lithium_metal_pi969_section_ii | HM dhl_adr_load_exemption | HN dhl_lithium_ion_pi967_section_ii | HV dhl_lithium_metal_pi970_section_ii | HW dhl_biological_un3373 | HY dhl_extended_liability | IB dhl_contract_insurance | IC dhl_shipment_insurance | II dhl_delivery_notification | JA dhl_pickup_notification | JC dhl_proactive_tracking | JD dhl_performance_reporting | JE dhl_prealert_notification | JY dhl_change_of_billing | KA dhl_cash_on_delivery | KB dhl_printed_invoice | KD dhl_waybill_copy | KE dhl_import_paperwork | KF dhl_payment_on_pickup | KY dhl_shipment_intercept | LA dhl_shipment_redirect | LC dhl_storage_at_facility | LE dhl_cold_storage | LG dhl_specific_routing | LH dhl_service_recovery | LV dhl_alternative_address | LW dhl_hold_for_collection | LX dhl_address_correction_a | MA dhl_address_correction_b | MB dhl_neutral_delivery | NN dhl_remote_area_pickup | OB dhl_remote_area_delivery_c | OC dhl_out_of_service_area | OE dhl_remote_area_delivery_o | OO dhl_shipment_preparation | PA dhl_shipment_labeling | PB dhl_shipment_consolidation | PC dhl_relabeling_data_entry | PD dhl_preprinted_waybill | PE dhl_piece_labelling | PS dhl_data_staging_03 | PT dhl_data_staging_06 | PU dhl_data_staging_12 | PV dhl_data_staging_24 | PW dhl_standard_pickup | PX dhl_scheduled_pickup | PY dhl_dedicated_pickup | QA dhl_early_pickup | QB dhl_late_pickup | QD dhl_residential_pickup | QE dhl_loading_waiting | QF dhl_bypass_injection | QH dhl_direct_injection | QI dhl_drop_off_at_facility | QY dhl_delivery_signature | SA dhl_content_signature | SB dhl_named_signature | SC dhl_adult_signature | SD dhl_contract_signature | SE dhl_alternative_signature | SW dhl_no_signature_required | SX dhl_dedicated_delivery | TA dhl_early_delivery | TB dhl_time_window_delivery | TC dhl_evening_delivery | TD dhl_delivery_on_appointment | TE dhl_return_undeliverable | TG dhl_swap_delivery | TH dhl_unloading_waiting | TJ dhl_residential_delivery | TK dhl_repeat_delivery | TN dhl_alternative_date | TT dhl_no_partial_delivery | TU dhl_service_point_24_7 | TV dhl_pre_9_00 | TW dhl_pre_10_30 | TX dhl_pre_12_00 | TY dhl_thermo_packaging | UA dhl_ambient_vialsafe | UB dhl_ambient_non_insulated | UC dhl_ambient_insulated | UD dhl_ambient_extreme | UE dhl_chilled_box_s | UF dhl_chilled_box_m | UG dhl_chilled_box_l | UH dhl_frozen_no_ice_s | UI dhl_frozen_no_ice_m | UJ dhl_frozen_no_ice_l | UK dhl_frozen_ice_sticks_s | UL dhl_frozen_ice_sticks_m | UM dhl_frozen_ice_sticks_l | UN dhl_frozen_ice_plates_s | UO dhl_frozen_ice_plates_m | UP dhl_frozen_ice_plates_l | UQ dhl_combination_no_ice | UR dhl_combination_dry_ice | US dhl_frozen_ice_sticks_e | UT dhl_frozen_ice_plates_e | UV dhl_customer_tcp_1 | UW dhl_thermo_accessories | VA dhl_absorbent_sleeve | VB dhl_cooland_wrap | VC dhl_dry_ice_supplies | VD dhl_pressure_bag_s | VE dhl_pressure_bag_m | VF dhl_pressure_bag_l | VG dhl_informal_clearance | WA dhl_formal_clearance | WB dhl_payment_deferment | WC dhl_clearance_authorization | WD dhl_multiline_entry | WE dhl_post_clearance_modification | WF dhl_handover_to_broker | WG dhl_physical_intervention | WH dhl_bio_phyto_veterinary_controls | WI dhl_obtaining_permits_and_licences | WJ dhl_bonded_storage | WK dhl_bonded_transit_documents | WL dhl_temporary_import_export | WM dhl_under_bond_guarantee | WN dhl_export_declaration | WO dhl_exporter_validation | WP dhl_certificate_of_origin | WQ dhl_document_translation | WR dhl_personal_effects | WS dhl_paperless_trade | WY dhl_import_export_taxes | XB dhl_unrecoverable_origin_tax | XC dhl_quarantine_inspection | XD dhl_merchandise_process | XE dhl_domestic_postal_tax | XF dhl_tier_two_tax | XG dhl_tier_three_tax | XH dhl_import_penalty | XI dhl_cargo_zone_process | XJ dhl_import_export_duties | XX dhl_premium_09_00 | Y1 dhl_premium_10_30 | Y2 dhl_premium_12_00 | Y3 dhl_over_sized_piece_b | YB dhl_over_handled_piece_c | YC dhl_multipiece_shipment | YE dhl_over_weight_piece_f | YF dhl_over_sized_piece_g | YG dhl_over_handled_piece_h | YH dhl_premium_9_00_i | YI dhl_premium_10_30_j | YJ dhl_premium_12_00_k | YK dhl_paket_shipment | YV dhl_breakbulk_mother | YW dhl_breakbulk_baby | YX dhl_over_weight_piece_y | YY dhl_customer_claim | ZA dhl_damage_compensation | ZB dhl_loss_compensation | ZC dhl_customer_rebate | ZD dhl_e_com_discount | ZE

### FedEx
Code | Identifier --- | --- blind_shipment | BLIND_SHIPMENT broker_select_option | BROKER_SELECT_OPTION call_before_delivery | CALL_BEFORE_DELIVERY cod | COD cod_remittance | COD_REMITTANCE custom_delivery_window | CUSTOM_DELIVERY_WINDOW cut_flowers | CUT_FLOWERS dangerous_goods | DANGEROUS_GOODS delivery_on_invoice_acceptance | DELIVERY_ON_INVOICE_ACCEPTANCE detention | DETENTION do_not_break_down_pallets | DO_NOT_BREAK_DOWN_PALLETS do_not_stack_pallets | DO_NOT_STACK_PALLETS dry_ice | DRY_ICE east_coast_special | EAST_COAST_SPECIAL electronic_trade_documents | ELECTRONIC_TRADE_DOCUMENTS event_notification | EVENT_NOTIFICATION exclude_from_consolidation | EXCLUDE_FROM_CONSOLIDATION exclusive_use | EXCLUSIVE_USE exhibition_delivery | EXHIBITION_DELIVERY exhibition_pickup | EXHIBITION_PICKUP expedited_alternate_delivery_route | EXPEDITED_ALTERNATE_DELIVERY_ROUTE expedited_one_day_earlier | EXPEDITED_ONE_DAY_EARLIER expedited_service_monitoring_and_delivery | EXPEDITED_SERVICE_MONITORING_AND_DELIVERY expedited_standard_day_early_delivery | EXPEDITED_STANDARD_DAY_EARLY_DELIVERY extra_labor | EXTRA_LABOR extreme_length | EXTREME_LENGTH fedex_one_rate | FEDEX_ONE_RATE flatbed_trailer | FLATBED_TRAILER food | FOOD freight_guarantee | FREIGHT_GUARANTEE freight_to_collect | FREIGHT_TO_COLLECT future_day_shipment | FUTURE_DAY_SHIPMENT hold_at_location | HOLD_AT_LOCATION holiday_delivery | HOLIDAY_DELIVERY holiday_guarantee | HOLIDAY_GUARANTEE home_delivery_premium | HOME_DELIVERY_PREMIUM inside_delivery | INSIDE_DELIVERY inside_pickup | INSIDE_PICKUP international_controlled_export_service | INTERNATIONAL_CONTROLLED_EXPORT_SERVICE international_mail_service | INTERNATIONAL_MAIL_SERVICE international_traffic_in_arms_regulations | INTERNATIONAL_TRAFFIC_IN_ARMS_REGULATIONS liftgate_delivery | LIFTGATE_DELIVERY liftgate_pickup | LIFTGATE_PICKUP limited_access_delivery | LIMITED_ACCESS_DELIVERY limited_access_pickup | LIMITED_ACCESS_PICKUP marking_or_tagging | MARKING_OR_TAGGING non_business_time | NON_BUSINESS_TIME pallet_shrinkwrap | PALLET_SHRINKWRAP pallet_weight_allowance | PALLET_WEIGHT_ALLOWANCE pallets_provided | PALLETS_PROVIDED pending_complete | PENDING_COMPLETE pending_shipment | PENDING_SHIPMENT permit | PERMIT pharmacy_delivery | PHARMACY_DELIVERY poison | POISON port_delivery | PORT_DELIVERY port_pickup | PORT_PICKUP pre_delivery_notification | PRE_DELIVERY_NOTIFICATION pre_eig_processing | PRE_EIG_PROCESSING pre_multiplier_processing | PRE_MULTIPLIER_PROCESSING protection_from_freezing | PROTECTION_FROM_FREEZING regional_mall_delivery | REGIONAL_MALL_DELIVERY regional_mall_pickup | REGIONAL_MALL_PICKUP return_shipment | RETURN_SHIPMENT returns_clearance | RETURNS_CLEARANCE returns_clearance_special_routing_required | RETURNS_CLEARANCE_SPECIAL_ROUTING_REQUIRED saturday_delivery | SATURDAY_DELIVERY saturday_pickup | SATURDAY_PICKUP shipment_assembly | SHIPMENT_ASSEMBLY sort_and_segregate | SORT_AND_SEGREGATE special_delivery | SPECIAL_DELIVERY special_equipment | SPECIAL_EQUIPMENT storage | STORAGE sunday_delivery | SUNDAY_DELIVERY third_party_consignee | THIRD_PARTY_CONSIGNEE top_load | TOP_LOAD usps_delivery | USPS_DELIVERY usps_pickup | USPS_PICKUP weighing | WEIGHING

### Purolator
Code | Identifier --- | --- dangerous_goods | Dangerous Goods chain_of_signature | Chain of Signature express_cheque | ExpressCheque hold_for_pickup | Hold For Pickup return_services | Return Services saturday_service | Saturday Service origin_signature_not_required | Origin Signature Not Required (OSNR) adult_signature_required | Adult Signature Required (ASR) special_handling | Special Handling

### UPS
Code | Identifier --- | --- saturday_delivery_indicator | SaturdayDeliveryIndicator access_point_cod | AccessPointCOD deliver_to_addressee_only_indicator | DeliverToAddresseeOnlyIndicator direct_delivery_only_indicator | DirectDeliveryOnlyIndicator cod | COD delivery_confirmation | DeliveryConfirmation return_of_document_indicator | ReturnOfDocumentIndicator up_scarbonneutral_indicator | UPScarbonneutralIndicator certificate_of_origin_indicator | CertificateOfOriginIndicator pickup_options | PickupOptions delivery_options | DeliveryOptions restricted_articles | RestrictedArticles shipper_export_declaration_indicator | ShipperExportDeclarationIndicator commercial_invoice_removal_indicator | CommercialInvoiceRemovalIndicator import_control | ImportControl return_service | ReturnService sdl_shipment_indicator | SDLShipmentIndicator epra_indicator | EPRAIndicator

### Freightcom
Code | Identifier --- | --- freightcom_saturday_pickup_required | saturdayPickupRequired freightcom_homeland_security | homelandSecurity freightcom_exhibition_convention_site | exhibitionConventionSite freightcom_military_base_delivery | militaryBaseDelivery freightcom_customs_in_bond_freight | customsIn_bondFreight freightcom_limited_access | limitedAccess freightcom_excess_length | excessLength freightcom_tailgate_pickup | tailgatePickup freightcom_residential_pickup | residentialPickup freightcom_cross_border_fee | crossBorderFee freightcom_notify_recipient | notifyRecipient freightcom_single_shipment | singleShipment freightcom_tailgate_delivery | tailgateDelivery freightcom_residential_delivery | residentialDelivery freightcom_insurance_type | insuranceType freightcom_inside_delivery | insideDelivery freightcom_is_saturday_service | isSaturdayService freightcom_dangerous_goods_type | dangerousGoodsType freightcom_stackable | stackable

### eShipper
Code | Identifier --- | --- eshipper_saturday_pickup_required | saturdayPickupRequired eshipper_homeland_security | homelandSecurity eshipper_exhibition_convention_site | exhibitionConventionSite eshipper_military_base_delivery | militaryBaseDelivery eshipper_customs_in_bond_freight | customsIn_bondFreight eshipper_limited_access | limitedAccess eshipper_excess_length | excessLength eshipper_tailgate_pickup | tailgatePickup eshipper_residential_pickup | residentialPickup eshipper_cross_border_fee | crossBorderFee eshipper_notify_recipient | notifyRecipient eshipper_single_shipment | singleShipment eshipper_tailgate_delivery | tailgateDelivery eshipper_residential_delivery | residentialDelivery eshipper_insurance_type | insuranceType eshipper_inside_delivery | insideDelivery eshipper_is_saturday_service | isSaturdayService eshipper_dangerous_goods_type | dangerousGoodsType eshipper_stackable | stackable


## Shipment Services
### Canada Post
Code | Identifier --- | --- canadapost_regular_parcel | DOM.RP canadapost_expedited_parcel | DOM.EP canadapost_xpresspost | DOM.XP canadapost_priority | DOM.PC canadapost_library_books | DOM.LIB canadapost_expedited_parcel_usa | USA.EP canadapost_priority_worldwide_envelope_usa | USA.PW.ENV canadapost_priority_worldwide_pak_usa | USA.PW.PAK canadapost_priority_worldwide_parcel_usa | USA.PW.PARCEL canadapost_small_packet_usa_air | USA.SP.AIR canadapost_tracked_packet_usa | USA.TP canadapost_tracked_packet_usa_lvm | USA.TP.LVM canadapost_xpresspost_usa | USA.XP canadapost_xpresspost_international | INT.XP canadapost_international_parcel_air | INT.IP.AIR canadapost_international_parcel_surface | INT.IP.SURF canadapost_priority_worldwide_envelope_intl | INT.PW.ENV canadapost_priority_worldwide_pak_intl | INT.PW.PAK canadapost_priority_worldwide_parcel_intl | INT.PW.PARCEL canadapost_small_packet_international_air | INT.SP.AIR canadapost_small_packet_international_surface | INT.SP.SURF canadapost_tracked_packet_international | INT.TP

### DHL
Code | Identifier --- | --- dhl_logistics_services | LOGISTICS SERVICES dhl_domestic_express_12_00_doc | DOMESTIC EXPRESS 12:00 DOC dhl_b2_c_doc | B2C DOC dhl_b2_c_nondoc | B2C NONDOC dhl_jetline | JETLINE dhl_sprintline | SPRINTLINE dhl_express_easy_doc | EXPRESS EASY DOC dhl_express_easy_nondoc | EXPRESS EASY NONDOC dhl_europack_doc | EUROPACK DOC dhl_auto_reversals | AUTO REVERSALS dhl_breakbulk_express_doc | BREAKBULK EXPRESS DOC dhl_medical_express_doc | MEDICAL EXPRESS DOC dhl_express_worldwide_doc | EXPRESS WORLDWIDE DOC dhl_express_9_00_nondoc | EXPRESS 9:00 NONDOC dhl_freight_worldwide_nondoc | FREIGHT WORLDWIDE NONDOC dhl_domestic_economy_select_doc | DOMESTIC ECONOMY SELECT DOC dhl_economy_select_nondoc | ECONOMY SELECT NONDOC dhl_domestic_express_9_00_doc | DOMESTIC EXPRESS 9:00 DOC dhl_jumbo_box_nondoc | JUMBO BOX NONDOC dhl_express_9_00_doc | EXPRESS 9:00 DOC dhl_express_10_30_doc | EXPRESS 10:30 DOC dhl_express_10_30_nondoc | EXPRESS 10:30 NONDOC dhl_domestic_express_doc | DOMESTIC EXPRESS DOC dhl_domestic_express_10_30_doc | DOMESTIC EXPRESS 10:30 DOC dhl_express_worldwide_nondoc | EXPRESS WORLDWIDE NONDOC dhl_medical_express_nondoc | MEDICAL EXPRESS NONDOC dhl_globalmail_business_doc | GLOBALMAIL BUSINESS DOC dhl_same_day_doc | SAME DAY DOC dhl_express_12_00_doc | EXPRESS 12:00 DOC dhl_europack_nondoc | EUROPACK NONDOC dhl_economy_select_doc | ECONOMY SELECT DOC dhl_express_envelope_doc | EXPRESS ENVELOPE DOC dhl_express_12_00_nondoc | EXPRESS 12:00 NONDOC dhl_destination_charges | Destination Charges

### FedEx
Code | Identifier --- | --- europe_first_international_priority | EUROPE_FIRST_INTERNATIONAL_PRIORITY fedex_1_day_freight | FEDEX_1_DAY_FREIGHT fedex_2_day | FEDEX_2_DAY fedex_2_day_am | FEDEX_2_DAY_AM fedex_2_day_freight | FEDEX_2_DAY_FREIGHT fedex_3_day_freight | FEDEX_3_DAY_FREIGHT fedex_cargo_airport_to_airport | FEDEX_CARGO_AIRPORT_TO_AIRPORT fedex_cargo_freight_forwarding | FEDEX_CARGO_FREIGHT_FORWARDING fedex_cargo_international_express_freight | FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT fedex_cargo_international_premium | FEDEX_CARGO_INTERNATIONAL_PREMIUM fedex_cargo_mail | FEDEX_CARGO_MAIL fedex_cargo_registered_mail | FEDEX_CARGO_REGISTERED_MAIL fedex_cargo_surface_mail | FEDEX_CARGO_SURFACE_MAIL fedex_custom_critical_air_expedite | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE fedex_custom_critical_air_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_air_expedite_network | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK fedex_custom_critical_charter_air | FEDEX_CUSTOM_CRITICAL_CHARTER_AIR fedex_custom_critical_point_to_point | FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT fedex_custom_critical_surface_expedite | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE fedex_custom_critical_surface_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_temp_assure_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR fedex_custom_critical_temp_assure_validated_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR fedex_custom_critical_white_glove_services | FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES fedex_distance_deferred | FEDEX_DISTANCE_DEFERRED fedex_express_saver | FEDEX_EXPRESS_SAVER fedex_first_freight | FEDEX_FIRST_FREIGHT fedex_freight_economy | FEDEX_FREIGHT_ECONOMY fedex_freight_priority | FEDEX_FREIGHT_PRIORITY fedex_ground | FEDEX_GROUND fedex_international_priority_plus | FEDEX_INTERNATIONAL_PRIORITY_PLUS fedex_next_day_afternoon | FEDEX_NEXT_DAY_AFTERNOON fedex_next_day_early_morning | FEDEX_NEXT_DAY_EARLY_MORNING fedex_next_day_end_of_day | FEDEX_NEXT_DAY_END_OF_DAY fedex_next_day_freight | FEDEX_NEXT_DAY_FREIGHT fedex_next_day_mid_morning | FEDEX_NEXT_DAY_MID_MORNING first_overnight | FIRST_OVERNIGHT ground_home_delivery | GROUND_HOME_DELIVERY international_distribution_freight | INTERNATIONAL_DISTRIBUTION_FREIGHT international_economy | INTERNATIONAL_ECONOMY international_economy_distribution | INTERNATIONAL_ECONOMY_DISTRIBUTION international_economy_freight | INTERNATIONAL_ECONOMY_FREIGHT international_first | INTERNATIONAL_FIRST international_ground | INTERNATIONAL_GROUND international_priority | INTERNATIONAL_PRIORITY international_priority_distribution | INTERNATIONAL_PRIORITY_DISTRIBUTION international_priority_express | INTERNATIONAL_PRIORITY_EXPRESS international_priority_freight | INTERNATIONAL_PRIORITY_FREIGHT priority_overnight | PRIORITY_OVERNIGHT same_day | SAME_DAY same_day_city | SAME_DAY_CITY same_day_metro_afternoon | SAME_DAY_METRO_AFTERNOON same_day_metro_morning | SAME_DAY_METRO_MORNING same_day_metro_rush | SAME_DAY_METRO_RUSH smart_post | SMART_POST standard_overnight | STANDARD_OVERNIGHT transborder_distribution_consolidation | TRANSBORDER_DISTRIBUTION_CONSOLIDATION

### Purolator
Code | Identifier --- | --- purolator_express_9_am | PurolatorExpress9AM purolator_express_us | PurolatorExpressU.S. purolator_express_10_30_am | PurolatorExpress10:30AM purolator_express_us_9_am | PurolatorExpressU.S.9AM purolator_express_12_pm | PurolatorExpress12PM purolator_express_us_10_30_am | PurolatorExpressU.S.10:30AM purolator_express | PurolatorExpress purolator_express_us_12_00 | PurolatorExpressU.S.12:00 purolator_express_evening | PurolatorExpressEvening purolator_express_envelope_us | PurolatorExpressEnvelopeU.S. purolator_express_envelope_9_am | PurolatorExpressEnvelope9AM purolator_express_us_envelope_9_am | PurolatorExpressU.S.Envelope9AM purolator_express_envelope_10_30_am | PurolatorExpressEnvelope10:30AM purolator_express_us_envelope_10_30_am | PurolatorExpressU.S.Envelope10:30AM purolator_express_envelope_12_pm | PurolatorExpressEnvelope12PM purolator_express_us_envelope_12_00 | PurolatorExpressU.S.Envelope12:00 purolator_express_envelope | PurolatorExpressEnvelope purolator_express_pack_us | PurolatorExpressPackU.S. purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening purolator_express_us_pack_9_am | PurolatorExpressU.S.Pack9AM purolator_express_pack_9_am | PurolatorExpressPack9AM purolator_express_us_pack_10_30_am | PurolatorExpressU.S.Pack10:30AM purolator_express_pack10_30_am | PurolatorExpressPack10:30AM purolator_express_us_pack_12_00 | PurolatorExpressU.S.Pack12:00 purolator_express_pack_12_pm | PurolatorExpressPack12PM purolator_express_box_us | PurolatorExpressBoxU.S. purolator_express_pack | PurolatorExpressPack purolator_express_us_box_9_am | PurolatorExpressU.S.Box9AM purolator_express_pack_evening | PurolatorExpressPackEvening purolator_express_us_box_10_30_am | PurolatorExpressU.S.Box10:30AM purolator_express_box_9_am | PurolatorExpressBox9AM purolator_express_us_box_12_00 | PurolatorExpressU.S.Box12:00 purolator_express_box_10_30_am | PurolatorExpressBox10:30AM purolator_ground_us | PurolatorGroundU.S. purolator_express_box_12_pm | PurolatorExpressBox12PM purolator_express_international | PurolatorExpressInternational purolator_express_box | PurolatorExpressBox purolator_express_international_9_am | PurolatorExpressInternational9AM purolator_express_box_evening | PurolatorExpressBoxEvening purolator_express_international_10_30_am | PurolatorExpressInternational10:30AM purolator_ground | PurolatorGround purolator_express_international_12_00 | PurolatorExpressInternational12:00 purolator_ground9_am | PurolatorGround9AM purolator_express_envelope_international | PurolatorExpressEnvelopeInternational purolator_ground10_30_am | PurolatorGround10:30AM purolator_express_international_envelope_9_am | PurolatorExpressInternationalEnvelope9AM purolator_ground_evening | PurolatorGroundEvening purolator_express_international_envelope_10_30_am | PurolatorExpressInternationalEnvelope10:30AM purolator_quick_ship | PurolatorQuickShip purolator_express_international_envelope_12_00 | PurolatorExpressInternationalEnvelope12:00 purolator_quick_ship_envelope | PurolatorQuickShipEnvelope purolator_express_pack_international | PurolatorExpressPackInternational purolator_quick_ship_pack | PurolatorQuickShipPack purolator_express_international_pack_9_am | PurolatorExpressInternationalPack9AM purolator_quick_ship_box | PurolatorQuickShipBox purolator_express_international_pack_10_30_am | PurolatorExpressInternationalPack10:30AM purolator_express_international_pack_12_00 | PurolatorExpressInternationalPack12:00 purolator_express_box_international | PurolatorExpressBoxInternational purolator_express_international_box_9_am | PurolatorExpressInternationalBox9AM purolator_express_international_box_10_30_am | PurolatorExpressInternationalBox10:30AM purolator_express_international_box_12_00 | PurolatorExpressInternationalBox12:00

### UPS
Code | Identifier --- | --- ups_standard | 11 ups_worldwide_expedited | 08 ups_worldwide_express | 07 ups_worldwide_express_plus | 54 ups_worldwide_saver | 65 ups_2nd_day_air | 02 ups_2nd_day_air_am | 59 ups_3_day_select | 12 ups_expedited_mail_innovations | M4 ups_first_class_mail | M2 ups_ground | 03 ups_next_day_air | 01 ups_next_day_air_early | 14 ups_next_day_air_saver | 13 ups_priority_mail | M3 ups_access_point_economy | 70 ups_today_dedicated_courier | 83 ups_today_express | 85 ups_today_express_saver | 86 ups_today_standard | 82 ups_worldwide_express_freight | 96 ups_priority_mail_innovations | M5 ups_economy_mail_innovations | M6

### Freightcom
Code | Identifier --- | --- freightcom_central_transport | 2029 freigthcom_estes | 2107 freigthcom_usf_holland | 1911 freightcom_fedex_ground | 4101 freightcom_ups_standard | 4600 freightcom_fedex_2_day | 4102 freightcom_fedex_priority_overnight | 4104 freightcom_fedex_standard_overnight | 4105 freightcom_ground | 3400 freightcom_ups_expedited | 4601 freightcom_ups_express_saver | 4602 freightcom_ups_express | 4603 freightcom_fedex_express_saver | 4100 freightcom_ups_express_early | 4604 freightcom_select | 3404 freightcom_dayr_e_comm_ground_service | 5707 freightcom_overnight | 3407 freightcom_purolator_ground | 4000 freightcom_purolator_express | 4003 freightcom_purolator_express_10_30_am | 4005 freightcom_fedex_first_overnight | 4106 freightcom_purolator_express_9_am | 4004 freightcom_dayr_e_comm_am_service | 5706

### eShipper
Code | Identifier --- | --- eshipper_fedex_priority | 1 eshipper_fedex_first_overnight | 2 eshipper_fedex_ground | 3 eshipper_fedex_standard_overnight | 28 eshipper_fedex_2nd_day | 29 eshipper_fedex_express_saver | 30 eshipper_purolator_air | 4 eshipper_purolator_air_9_am | 5 eshipper_purolator_air_10_30 | 6 eshipper_puroletter | 7 eshipper_puroletter_9_am | 8 eshipper_puroletter_10_30 | 9 eshipper_puro_pak | 10 eshipper_puro_pak_9_am | 11 eshipper_puro_pak_10_30 | 12 eshipper_purolator_ground | 13 eshipper_purolator_ground_9_am | 19 eshipper_purolator_ground_10_30 | 20 eshipper_canada_worldwide_same_day | 14 eshipper_canada_worldwide_next_flight_out | 15 eshipper_canada_worldwide_air_freight | 16 eshipper_canada_worldwide_ltl | 17 eshipper_dhl_international_express | 106 eshipper_ups_express_next_day_air | 600 eshipper_ups_expedited_second_day_air | 601 eshipper_ups_worldwide_express | 602 eshipper_ups_worldwide_expedited | 603 eshipper_ups_standard_ground | 604 eshipper_ups_express_early_am_next_day_air_early_am | 605 eshipper_ups_three_day_select | 606 eshipper_ups_saver | 607 eshipper_ups_ground | 608 eshipper_next_day_saver | 609 eshipper_worldwide_express_plus | 610 eshipper_second_day_air_am | 611 eshipper_canada_post_priority | 500 eshipper_canada_post_xpress_post | 501 eshipper_canada_post_expedited | 502 eshipper_canada_post_regular | 503 eshipper_canada_post_xpress_post_usa | 504 eshipper_canada_post_xpress_post_intl | 505 eshipper_canada_post_air_parcel_intl | 506 eshipper_canada_post_surface_parcel_intl | 507 eshipper_canada_post_expedited_parcel_usa | 508 eshipper_tst_ltl | 1100 eshipper_ltl_chicago_suburban_express | 1500 eshipper_ltl_fedex_freight_east | 1501 eshipper_ltl_fedex_freight_west | 1502 eshipper_ltl_mid_states_express | 1503 eshipper_ltl_new_england_motor_freight | 1504 eshipper_ltl_new_penn | 1505 eshipper_ltl_oak_harbor | 1506 eshipper_ltl_pitt_ohio | 1507 eshipper_ltl_r_l_carriers | 1508 eshipper_ltl_saia | 1509 eshipper_ltl_usf_reddaway | 1510 eshipper_ltl_vitran_express | 1511 eshipper_ltl_wilson_trucking | 1512 eshipper_ltl_yellow_transportation | 1513 eshipper_ltl_roadway | 1514 eshipper_ltl_fedex_national | 1515 eshipper_wilson_trucking_tfc | 1800 eshipper_aaa_cooper_transportation | 1801 eshipper_roadrunner_dawes | 1802 eshipper_new_england_motor_freight | 1803 eshipper_new_penn_motor_express | 1804 eshipper_dayton_freight | 1805 eshipper_southeastern_freightway | 1806 eshipper_saia_inc | 1807 eshipper_conway | 1808 eshipper_roadway | 1809 eshipper_usf_reddaway | 1810 eshipper_usf_holland | 1811 eshipper_dependable_highway_express | 1812 eshipper_day_and_ross | 1813 eshipper_day_and_ross_r_and_l | 1814 eshipper_ups | 1815 eshipper_aaa_cooper | 1816 eshipper_ama_transportation | 1817 eshipper_averitt_express | 1818 eshipper_central_freight | 1819 eshipper_conway_us | 1820 eshipper_dayton | 1821 eshipper_drug_transport | 1822 eshipper_estes | 1823 eshipper_land_air_express | 1824 eshipper_fedex_west | 1825 eshipper_fedex_national | 1826 eshipper_usf_holland_us | 1827 eshipper_lakeville_m_express | 1828 eshipper_milan_express | 1829 eshipper_nebraska_transport | 1830 eshipper_new_england | 1831 eshipper_new_penn | 1832 eshipper_a_duie_pyle | 1833 eshipper_roadway_us | 1834 eshipper_usf_reddaway_us | 1835 eshipper_rhody_transportation | 1836 eshipper_saia_motor_freight | 1837 eshipper_southeastern_frgt | 1838 eshipper_pitt_ohio | 1839 eshipper_ward | 1840 eshipper_wilson | 1841 eshipper_chi_cargo | 1842 eshipper_tax_air | 1843 eshipper_fedex_east | 1844 eshipper_central_transport | 1845 eshipper_roadrunner | 1846 eshipper_r_and_l_carriers | 1847 eshipper_estes_us | 1848 eshipper_yrc_roadway | 1849 eshipper_central_transport_us | 1850 eshipper_absolute_transportation_services | 1851 eshipper_blue_sky_express | 1852 eshipper_galasso_trucking | 1853 eshipper_griley_air_freight | 1854 eshipper_jet_transportation | 1855 eshipper_metro_transportation_logistics | 1856 eshipper_oak_harbor | 1857 eshipper_stream_links_express | 1858 eshipper_tiffany_trucking | 1859 eshipper_ups_freight | 1860 eshipper_roadrunner_us | 1861 eshipper_global_mail_parcel_priority | 3500 eshipper_global_mail_parcel_standard | 3501 eshipper_global_mail_packet_plus_priority | 3502 eshipper_global_mail_packet_priority | 3503 eshipper_global_mail_packet_standard | 3504 eshipper_global_mail_business_priority | 3505 eshipper_global_mail_business_standard | 3506 eshipper_global_mail_parcel_direct_priority | 3507 eshipper_global_mail_parcel_direct_standard | 3508 eshipper_ground | 4500 eshipper_select_parcel | 4504 eshipper_express_parcel | 4507


# noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.references_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :return: References + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method references" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['OAuth2 password', 'Token'] # noqa: E501 + + return self.api_client.call_api( + '/references', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='References', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/purplship/models/__init__.py b/purplship/models/__init__.py index a8c8bf8..79441e3 100644 --- a/purplship/models/__init__.py +++ b/purplship/models/__init__.py @@ -6,7 +6,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,7 +41,7 @@ from purplship.models.shipment_purchase_data import ShipmentPurchaseData from purplship.models.shipment_response import ShipmentResponse from purplship.models.shipping_request import ShippingRequest -from purplship.models.tracking import Tracking from purplship.models.tracking_details import TrackingDetails from purplship.models.tracking_event import TrackingEvent from purplship.models.tracking_response import TrackingResponse +from purplship.models.tracking_status import TrackingStatus diff --git a/purplship/models/address.py b/purplship/models/address.py index 9e2c82a..54ed4ba 100644 --- a/purplship/models/address.py +++ b/purplship/models/address.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/address_data.py b/purplship/models/address_data.py index 5cc7346..434afb5 100644 --- a/purplship/models/address_data.py +++ b/purplship/models/address_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/card.py b/purplship/models/card.py index e8ad484..2153252 100644 --- a/purplship/models/card.py +++ b/purplship/models/card.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/carrier_settings.py b/purplship/models/carrier_settings.py index b7ae06e..e942a99 100644 --- a/purplship/models/carrier_settings.py +++ b/purplship/models/carrier_settings.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/charge.py b/purplship/models/charge.py index f4c5db7..6754b3c 100644 --- a/purplship/models/charge.py +++ b/purplship/models/charge.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/commodity.py b/purplship/models/commodity.py index faede6d..e55d1bb 100644 --- a/purplship/models/commodity.py +++ b/purplship/models/commodity.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/customs.py b/purplship/models/customs.py index a55a872..749ec74 100644 --- a/purplship/models/customs.py +++ b/purplship/models/customs.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/customs_data.py b/purplship/models/customs_data.py index 868a439..8a3de97 100644 --- a/purplship/models/customs_data.py +++ b/purplship/models/customs_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/doc.py b/purplship/models/doc.py index 22d0cbb..2623912 100644 --- a/purplship/models/doc.py +++ b/purplship/models/doc.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/error_response.py b/purplship/models/error_response.py index 7963890..0875a50 100644 --- a/purplship/models/error_response.py +++ b/purplship/models/error_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/invoice.py b/purplship/models/invoice.py index 03e50d4..25dd85a 100644 --- a/purplship/models/invoice.py +++ b/purplship/models/invoice.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/label_printing_request.py b/purplship/models/label_printing_request.py index 18c1106..42bf799 100644 --- a/purplship/models/label_printing_request.py +++ b/purplship/models/label_printing_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/message.py b/purplship/models/message.py index a1302e8..e4dc06c 100644 --- a/purplship/models/message.py +++ b/purplship/models/message.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/parcel.py b/purplship/models/parcel.py index ebcc388..9a44a6b 100644 --- a/purplship/models/parcel.py +++ b/purplship/models/parcel.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -223,7 +223,7 @@ def length(self, length): def packaging_type(self): """Gets the packaging_type of this Parcel. # noqa: E501 - The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult the API reference. # noqa: E501 :return: The packaging_type of this Parcel. # noqa: E501 :rtype: str @@ -234,7 +234,7 @@ def packaging_type(self): def packaging_type(self, packaging_type): """Sets the packaging_type of this Parcel. - The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult the API reference. # noqa: E501 :param packaging_type: The packaging_type of this Parcel. # noqa: E501 :type: str @@ -246,7 +246,7 @@ def packaging_type(self, packaging_type): def package_preset(self): """Gets the package_preset of this Parcel. # noqa: E501 - The parcel's package preset. For specific carriers package preset, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's package preset. For specific carriers package preset, please consult the API reference. # noqa: E501 :return: The package_preset of this Parcel. # noqa: E501 :rtype: str @@ -257,7 +257,7 @@ def package_preset(self): def package_preset(self, package_preset): """Sets the package_preset of this Parcel. - The parcel's package preset. For specific carriers package preset, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's package preset. For specific carriers package preset, please consult the API reference. # noqa: E501 :param package_preset: The package_preset of this Parcel. # noqa: E501 :type: str diff --git a/purplship/models/parcel_data.py b/purplship/models/parcel_data.py index 7006e68..16093b1 100644 --- a/purplship/models/parcel_data.py +++ b/purplship/models/parcel_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -193,7 +193,7 @@ def length(self, length): def packaging_type(self): """Gets the packaging_type of this ParcelData. # noqa: E501 - The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult the API reference. # noqa: E501 :return: The packaging_type of this ParcelData. # noqa: E501 :rtype: str @@ -204,7 +204,7 @@ def packaging_type(self): def packaging_type(self, packaging_type): """Sets the packaging_type of this ParcelData. - The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's packaging type. **Note that the packaging is optional when using a package preset** values:
- **envelope**
- **pak**
- **tube**
- **pallet**
- **small_box**
- **medium_box**
- **your_packaging** For specific carriers packaging type, please consult the API reference. # noqa: E501 :param packaging_type: The packaging_type of this ParcelData. # noqa: E501 :type: str @@ -216,7 +216,7 @@ def packaging_type(self, packaging_type): def package_preset(self): """Gets the package_preset of this ParcelData. # noqa: E501 - The parcel's package preset. For specific carriers package preset, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's package preset. For specific carriers package preset, please consult the API reference. # noqa: E501 :return: The package_preset of this ParcelData. # noqa: E501 :rtype: str @@ -227,7 +227,7 @@ def package_preset(self): def package_preset(self, package_preset): """Sets the package_preset of this ParcelData. - The parcel's package preset. For specific carriers package preset, please consult [the reference](#operation/all_references). # noqa: E501 + The parcel's package preset. For specific carriers package preset, please consult the API reference. # noqa: E501 :param package_preset: The package_preset of this ParcelData. # noqa: E501 :type: str diff --git a/purplship/models/payment.py b/purplship/models/payment.py index 4ce5a07..a893ea1 100644 --- a/purplship/models/payment.py +++ b/purplship/models/payment.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/payment_data.py b/purplship/models/payment_data.py index 5132ce8..a163a2e 100644 --- a/purplship/models/payment_data.py +++ b/purplship/models/payment_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/rate.py b/purplship/models/rate.py index ccdcf60..541bc1f 100644 --- a/purplship/models/rate.py +++ b/purplship/models/rate.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/rate_request.py b/purplship/models/rate_request.py index 6218404..896be2e 100644 --- a/purplship/models/rate_request.py +++ b/purplship/models/rate_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -149,7 +149,7 @@ def parcels(self, parcels): def services(self): """Gets the services of this RateRequest. # noqa: E501 - The requested carrier service for the shipment.
Please consult [the reference](#operation/all_references) for specific carriers services. Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 + The requested carrier service for the shipment.
Please consult the API reference for specific carriers services. Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 :return: The services of this RateRequest. # noqa: E501 :rtype: list[str] @@ -160,7 +160,7 @@ def services(self): def services(self, services): """Sets the services of this RateRequest. - The requested carrier service for the shipment.
Please consult [the reference](#operation/all_references) for specific carriers services. Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 + The requested carrier service for the shipment.
Please consult the API reference for specific carriers services. Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 :param services: The services of this RateRequest. # noqa: E501 :type: list[str] @@ -172,7 +172,7 @@ def services(self, services): def options(self): """Gets the options of this RateRequest. # noqa: E501 - The options available for the shipment. Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment. Please consult the API reference for additional specific carriers options. # noqa: E501 :return: The options of this RateRequest. # noqa: E501 :rtype: object @@ -183,7 +183,7 @@ def options(self): def options(self, options): """Sets the options of this RateRequest. - The options available for the shipment. Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment. Please consult the API reference for additional specific carriers options. # noqa: E501 :param options: The options of this RateRequest. # noqa: E501 :type: object diff --git a/purplship/models/rate_response.py b/purplship/models/rate_response.py index 3b1a970..abbc299 100644 --- a/purplship/models/rate_response.py +++ b/purplship/models/rate_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/references.py b/purplship/models/references.py index bacb759..381c20d 100644 --- a/purplship/models/references.py +++ b/purplship/models/references.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -36,7 +36,8 @@ class References(object): 'states': 'object', 'services': 'object', 'options': 'object', - 'package_presets': 'object' + 'package_presets': 'object', + 'packaging_types': 'object' } attribute_map = { @@ -45,10 +46,11 @@ class References(object): 'states': 'states', 'services': 'services', 'options': 'options', - 'package_presets': 'packagePresets' + 'package_presets': 'packagePresets', + 'packaging_types': 'packagingTypes' } - def __init__(self, countries=None, currencies=None, states=None, services=None, options=None, package_presets=None): # noqa: E501 + def __init__(self, countries=None, currencies=None, states=None, services=None, options=None, package_presets=None, packaging_types=None): # noqa: E501 """References - a model defined in Swagger""" # noqa: E501 self._countries = None @@ -57,6 +59,7 @@ def __init__(self, countries=None, currencies=None, states=None, services=None, self._services = None self._options = None self._package_presets = None + self._packaging_types = None self.discriminator = None self.countries = countries @@ -65,6 +68,7 @@ def __init__(self, countries=None, currencies=None, states=None, services=None, self.services = services self.options = options self.package_presets = package_presets + self.packaging_types = packaging_types @property def countries(self): @@ -204,6 +208,29 @@ def package_presets(self, package_presets): self._package_presets = package_presets + @property + def packaging_types(self): + """Gets the packaging_types of this References. # noqa: E501 + + + :return: The packaging_types of this References. # noqa: E501 + :rtype: object + """ + return self._packaging_types + + @packaging_types.setter + def packaging_types(self, packaging_types): + """Sets the packaging_types of this References. + + + :param packaging_types: The packaging_types of this References. # noqa: E501 + :type: object + """ + if packaging_types is None: + raise ValueError("Invalid value for `packaging_types`, must not be `None`") # noqa: E501 + + self._packaging_types = packaging_types + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/purplship/models/shipment.py b/purplship/models/shipment.py index 6bda1ff..2ce2745 100644 --- a/purplship/models/shipment.py +++ b/purplship/models/shipment.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -455,7 +455,7 @@ def parcels(self, parcels): def services(self): """Gets the services of this Shipment. # noqa: E501 - The requested carrier service for the shipment. Please consult [the reference](#operation/all_references) for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 + The requested carrier service for the shipment. Please consult the API reference for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 :return: The services of this Shipment. # noqa: E501 :rtype: list[str] @@ -466,7 +466,7 @@ def services(self): def services(self, services): """Sets the services of this Shipment. - The requested carrier service for the shipment. Please consult [the reference](#operation/all_references) for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 + The requested carrier service for the shipment. Please consult the API reference for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 :param services: The services of this Shipment. # noqa: E501 :type: list[str] @@ -478,7 +478,7 @@ def services(self, services): def options(self): """Gets the options of this Shipment. # noqa: E501 - The options available for the shipment.
Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment.
Please consult the API reference for additional specific carriers options. # noqa: E501 :return: The options of this Shipment. # noqa: E501 :rtype: object @@ -489,7 +489,7 @@ def options(self): def options(self, options): """Sets the options of this Shipment. - The options available for the shipment.
Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment.
Please consult the API reference for additional specific carriers options. # noqa: E501 :param options: The options of this Shipment. # noqa: E501 :type: object diff --git a/purplship/models/shipment_data.py b/purplship/models/shipment_data.py index d7cd6c2..1229789 100644 --- a/purplship/models/shipment_data.py +++ b/purplship/models/shipment_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -164,7 +164,7 @@ def parcels(self, parcels): def options(self): """Gets the options of this ShipmentData. # noqa: E501 - The options available for the shipment.
Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment.
Please consult the API reference for additional specific carriers options. # noqa: E501 :return: The options of this ShipmentData. # noqa: E501 :rtype: object @@ -175,7 +175,7 @@ def options(self): def options(self, options): """Sets the options of this ShipmentData. - The options available for the shipment.
Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment.
Please consult the API reference for additional specific carriers options. # noqa: E501 :param options: The options of this ShipmentData. # noqa: E501 :type: object @@ -275,7 +275,7 @@ def reference(self, reference): def services(self): """Gets the services of this ShipmentData. # noqa: E501 - The requested carrier service for the shipment. Please consult [the reference](#operation/all_references) for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 + The requested carrier service for the shipment. Please consult the API reference for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 :return: The services of this ShipmentData. # noqa: E501 :rtype: list[str] @@ -286,7 +286,7 @@ def services(self): def services(self, services): """Sets the services of this ShipmentData. - The requested carrier service for the shipment. Please consult [the reference](#operation/all_references) for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 + The requested carrier service for the shipment. Please consult the API reference for specific carriers services.
Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. # noqa: E501 :param services: The services of this ShipmentData. # noqa: E501 :type: list[str] diff --git a/purplship/models/shipment_purchase_data.py b/purplship/models/shipment_purchase_data.py index 337715e..413b144 100644 --- a/purplship/models/shipment_purchase_data.py +++ b/purplship/models/shipment_purchase_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/shipment_response.py b/purplship/models/shipment_response.py index fae2d96..48b13c9 100644 --- a/purplship/models/shipment_response.py +++ b/purplship/models/shipment_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/shipping_request.py b/purplship/models/shipping_request.py index 9fa35a2..a9a2d15 100644 --- a/purplship/models/shipping_request.py +++ b/purplship/models/shipping_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -161,7 +161,7 @@ def parcels(self, parcels): def options(self): """Gets the options of this ShippingRequest. # noqa: E501 - The options available for the shipment.
Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment.
Please consult the API reference for additional specific carriers options. # noqa: E501 :return: The options of this ShippingRequest. # noqa: E501 :rtype: object @@ -172,7 +172,7 @@ def options(self): def options(self, options): """Sets the options of this ShippingRequest. - The options available for the shipment.
Please consult [the reference](#operation/all_references) for additional specific carriers options. # noqa: E501 + The options available for the shipment.
Please consult the API reference for additional specific carriers options. # noqa: E501 :param options: The options of this ShippingRequest. # noqa: E501 :type: object diff --git a/purplship/models/tracking_details.py b/purplship/models/tracking_details.py index 496ae9e..4e671fe 100644 --- a/purplship/models/tracking_details.py +++ b/purplship/models/tracking_details.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/tracking_event.py b/purplship/models/tracking_event.py index 947b69e..0202358 100644 --- a/purplship/models/tracking_event.py +++ b/purplship/models/tracking_event.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/tracking_response.py b/purplship/models/tracking_response.py index 2b56aee..c2ee3d9 100644 --- a/purplship/models/tracking_response.py +++ b/purplship/models/tracking_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/models/tracking.py b/purplship/models/tracking_status.py similarity index 78% rename from purplship/models/tracking.py rename to purplship/models/tracking_status.py index dbcf54a..2579aab 100644 --- a/purplship/models/tracking.py +++ b/purplship/models/tracking_status.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2020.8.0 + OpenAPI spec version: v1-2020.8.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -17,7 +17,7 @@ import six -class Tracking(object): +class TrackingStatus(object): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -49,7 +49,7 @@ class Tracking(object): } def __init__(self, id=None, carrier_name=None, carrier_id=None, tracking_number=None, events=None, shipment_id=None): # noqa: E501 - """Tracking - a model defined in Swagger""" # noqa: E501 + """TrackingStatus - a model defined in Swagger""" # noqa: E501 self._id = None self._carrier_name = None @@ -71,22 +71,22 @@ def __init__(self, id=None, carrier_name=None, carrier_id=None, tracking_number= @property def id(self): - """Gets the id of this Tracking. # noqa: E501 + """Gets the id of this TrackingStatus. # noqa: E501 A unique identifier # noqa: E501 - :return: The id of this Tracking. # noqa: E501 + :return: The id of this TrackingStatus. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """Sets the id of this Tracking. + """Sets the id of this TrackingStatus. A unique identifier # noqa: E501 - :param id: The id of this Tracking. # noqa: E501 + :param id: The id of this TrackingStatus. # noqa: E501 :type: str """ if id is not None and len(id) < 1: @@ -96,22 +96,22 @@ def id(self, id): @property def carrier_name(self): - """Gets the carrier_name of this Tracking. # noqa: E501 + """Gets the carrier_name of this TrackingStatus. # noqa: E501 The tracking carrier # noqa: E501 - :return: The carrier_name of this Tracking. # noqa: E501 + :return: The carrier_name of this TrackingStatus. # noqa: E501 :rtype: str """ return self._carrier_name @carrier_name.setter def carrier_name(self, carrier_name): - """Sets the carrier_name of this Tracking. + """Sets the carrier_name of this TrackingStatus. The tracking carrier # noqa: E501 - :param carrier_name: The carrier_name of this Tracking. # noqa: E501 + :param carrier_name: The carrier_name of this TrackingStatus. # noqa: E501 :type: str """ if carrier_name is None: @@ -123,22 +123,22 @@ def carrier_name(self, carrier_name): @property def carrier_id(self): - """Gets the carrier_id of this Tracking. # noqa: E501 + """Gets the carrier_id of this TrackingStatus. # noqa: E501 The tracking carrier configured identifier # noqa: E501 - :return: The carrier_id of this Tracking. # noqa: E501 + :return: The carrier_id of this TrackingStatus. # noqa: E501 :rtype: str """ return self._carrier_id @carrier_id.setter def carrier_id(self, carrier_id): - """Sets the carrier_id of this Tracking. + """Sets the carrier_id of this TrackingStatus. The tracking carrier configured identifier # noqa: E501 - :param carrier_id: The carrier_id of this Tracking. # noqa: E501 + :param carrier_id: The carrier_id of this TrackingStatus. # noqa: E501 :type: str """ if carrier_id is None: @@ -150,22 +150,22 @@ def carrier_id(self, carrier_id): @property def tracking_number(self): - """Gets the tracking_number of this Tracking. # noqa: E501 + """Gets the tracking_number of this TrackingStatus. # noqa: E501 The shipment tracking number # noqa: E501 - :return: The tracking_number of this Tracking. # noqa: E501 + :return: The tracking_number of this TrackingStatus. # noqa: E501 :rtype: str """ return self._tracking_number @tracking_number.setter def tracking_number(self, tracking_number): - """Sets the tracking_number of this Tracking. + """Sets the tracking_number of this TrackingStatus. The shipment tracking number # noqa: E501 - :param tracking_number: The tracking_number of this Tracking. # noqa: E501 + :param tracking_number: The tracking_number of this TrackingStatus. # noqa: E501 :type: str """ if tracking_number is None: @@ -177,22 +177,22 @@ def tracking_number(self, tracking_number): @property def events(self): - """Gets the events of this Tracking. # noqa: E501 + """Gets the events of this TrackingStatus. # noqa: E501 The tracking details events # noqa: E501 - :return: The events of this Tracking. # noqa: E501 + :return: The events of this TrackingStatus. # noqa: E501 :rtype: list[TrackingEvent] """ return self._events @events.setter def events(self, events): - """Sets the events of this Tracking. + """Sets the events of this TrackingStatus. The tracking details events # noqa: E501 - :param events: The events of this Tracking. # noqa: E501 + :param events: The events of this TrackingStatus. # noqa: E501 :type: list[TrackingEvent] """ @@ -200,22 +200,22 @@ def events(self, events): @property def shipment_id(self): - """Gets the shipment_id of this Tracking. # noqa: E501 + """Gets the shipment_id of this TrackingStatus. # noqa: E501 The system shipment associated. # noqa: E501 - :return: The shipment_id of this Tracking. # noqa: E501 + :return: The shipment_id of this TrackingStatus. # noqa: E501 :rtype: str """ return self._shipment_id @shipment_id.setter def shipment_id(self, shipment_id): - """Sets the shipment_id of this Tracking. + """Sets the shipment_id of this TrackingStatus. The system shipment associated. # noqa: E501 - :param shipment_id: The shipment_id of this Tracking. # noqa: E501 + :param shipment_id: The shipment_id of this TrackingStatus. # noqa: E501 :type: str """ @@ -242,7 +242,7 @@ def to_dict(self): )) else: result[attr] = value - if issubclass(Tracking, dict): + if issubclass(TrackingStatus, dict): for key, value in self.items(): result[key] = value @@ -258,7 +258,7 @@ def __repr__(self): def __eq__(self, other): """Returns true if both objects are equal""" - if not isinstance(other, Tracking): + if not isinstance(other, TrackingStatus): return False return self.__dict__ == other.__dict__ diff --git a/setup.py b/setup.py index 4f6413d..cbe5fcd 100755 --- a/setup.py +++ b/setup.py @@ -16,7 +16,7 @@ long_description = fh.read() NAME = "purplship-python" -VERSION = "2020.8.1" +VERSION = "2020.8.2" DEV_REQUIRES = [ "wheel",