### Python example for ListCarrierProducts200ResponseInnerServicesInner Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListCarrierProducts200ResponseInnerServicesInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict using the zippendo model class. ```python from zippendo.models.list_carrier_products200_response_inner_services_inner import ListCarrierProducts200ResponseInnerServicesInner # TODO update the JSON string below json = "{}" # create an instance of ListCarrierProducts200ResponseInnerServicesInner from a JSON string list_carrier_products200_response_inner_services_inner_instance = ListCarrierProducts200ResponseInnerServicesInner.from_json(json) # print the JSON string representation of the object print(ListCarrierProducts200ResponseInnerServicesInner.to_json()) # convert the object into a dict list_carrier_products200_response_inner_services_inner_dict = list_carrier_products200_response_inner_services_inner_instance.to_dict() # create an instance of ListCarrierProducts200ResponseInnerServicesInner from a dict list_carrier_products200_response_inner_services_inner_from_dict = ListCarrierProducts200ResponseInnerServicesInner.from_dict(list_carrier_products200_response_inner_services_inner_dict) ``` -------------------------------- ### CreateOrgBrandRequest usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateOrgBrandRequest.md Shows how to create a CreateOrgBrandRequest instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. The example uses a placeholder JSON string that should be updated. ```python from zippendo.models.create_org_brand_request import CreateOrgBrandRequest # TODO update the JSON string below json = "{}" # create an instance of CreateOrgBrandRequest from a JSON string create_org_brand_request_instance = CreateOrgBrandRequest.from_json(json) # print the JSON string representation of the object print(CreateOrgBrandRequest.to_json()) # convert the object into a dict create_org_brand_request_dict = create_org_brand_request_instance.to_dict() # create an instance of CreateOrgBrandRequest from a dict create_org_brand_request_from_dict = CreateOrgBrandRequest.from_dict(create_org_brand_request_dict) ``` -------------------------------- ### CreateOrderChannelRequest usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateOrderChannelRequest.md Shows how to create an instance of CreateOrderChannelRequest from a JSON string, convert it to a dict, and back. The example uses a placeholder JSON string that should be updated. ```python from zippendo.models.create_order_channel_request import CreateOrderChannelRequest # TODO update the JSON string below json = "{}" # create an instance of CreateOrderChannelRequest from a JSON string create_order_channel_request_instance = CreateOrderChannelRequest.from_json(json) # print the JSON string representation of the object print(CreateOrderChannelRequest.to_json()) # convert the object into a dict create_order_channel_request_dict = create_order_channel_request_instance.to_dict() # create an instance of CreateOrderChannelRequest from a dict create_order_channel_request_from_dict = CreateOrderChannelRequest.from_dict(create_order_channel_request_dict) ``` -------------------------------- ### UpdateOrderChannelRequestSettings usage example in Python Source: https://github.com/zippendo/zippendo-python/blob/main/docs/UpdateOrderChannelRequestSettings.md Shows how to create an instance of UpdateOrderChannelRequestSettings from a JSON string and from a dict, and how to print its JSON string representation. The JSON string is a placeholder that should be updated with actual data. ```python from zippendo.models.update_order_channel_request_settings import UpdateOrderChannelRequestSettings # TODO update the JSON string below json = "{}" # create an instance of UpdateOrderChannelRequestSettings from a JSON string update_order_channel_request_settings_instance = UpdateOrderChannelRequestSettings.from_json(json) # print the JSON string representation of the object print(UpdateOrderChannelRequestSettings.to_json()) # convert the object into a dict update_order_channel_request_settings_dict = update_order_channel_request_settings_instance.to_dict() # create an instance of UpdateOrderChannelRequestSettings from a dict update_order_channel_request_settings_from_dict = UpdateOrderChannelRequestSettings.from_dict(update_order_channel_request_settings_dict) ``` -------------------------------- ### GetOrg200Response usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/GetOrg200Response.md Shows how to create a GetOrg200Response instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. The example uses the zippendo.models.get_org200_response module. ```python from zippendo.models.get_org200_response import GetOrg200Response # TODO update the JSON string below json = "{}" # create an instance of GetOrg200Response from a JSON string get_org200_response_instance = GetOrg200Response.from_json(json) # print the JSON string representation of the object print(GetOrg200Response.to_json()) # convert the object into a dict get_org200_response_dict = get_org200_response_instance.to_dict() # create an instance of GetOrg200Response from a dict get_org200_response_from_dict = GetOrg200Response.from_dict(get_org200_response_dict) ``` -------------------------------- ### CreateOrderRequestOrderLinesInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateOrderRequestOrderLinesInner.md Shows how to create an instance from a JSON string and convert it to a dict using the zippendo model. The example includes placeholder JSON and prints the JSON string representation. ```python from zippendo.models.create_order_request_order_lines_inner import CreateOrderRequestOrderLinesInner # TODO update the JSON string below json = "{}" # create an instance of CreateOrderRequestOrderLinesInner from a JSON string create_order_request_order_lines_inner_instance = CreateOrderRequestOrderLinesInner.from_json(json) # print the JSON string representation of the object print(CreateOrderRequestOrderLinesInner.to_json()) # convert the object into a dict create_order_request_order_lines_inner_dict = create_order_request_order_lines_inner_instance.to_dict() # create an instance of CreateOrderRequestOrderLinesInner from a dict create_order_request_order_lines_inner_from_dict = CreateOrderRequestOrderLinesInner.from_dict(create_order_request_order_lines_inner_dict) ``` -------------------------------- ### Python example for TrackShipment200ResponseEventsInner from_json and from_dict Source: https://github.com/zippendo/zippendo-python/blob/main/docs/TrackShipment200ResponseEventsInner.md Shows how to create a TrackShipment200ResponseEventsInner instance from a JSON string using from_json, print its JSON representation with to_json, and convert it to a dict and back using to_dict and from_dict. The JSON string is a placeholder that should be updated before use. ```python from zippendo.models.track_shipment200_response_events_inner import TrackShipment200ResponseEventsInner # TODO update the JSON string below json = "{}" # create an instance of TrackShipment200ResponseEventsInner from a JSON string track_shipment200_response_events_inner_instance = TrackShipment200ResponseEventsInner.from_json(json) # print the JSON string representation of the object print(TrackShipment200ResponseEventsInner.to_json()) # convert the object into a dict track_shipment200_response_events_inner_dict = track_shipment200_response_events_inner_instance.to_dict() # create an instance of TrackShipment200ResponseEventsInner from a dict track_shipment200_response_events_inner_from_dict = TrackShipment200ResponseEventsInner.from_dict(track_shipment200_response_events_inner_dict) ``` -------------------------------- ### VerifyApiToken200Response usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/VerifyApiToken200Response.md Shows how to create a VerifyApiToken200Response instance from a JSON string and convert it to a dict. The JSON string is a placeholder that should be updated. ```python from zippendo.models.verify_api_token200_response import VerifyApiToken200Response # TODO update the JSON string below json = "{}" # create an instance of VerifyApiToken200Response from a JSON string verify_api_token200_response_instance = VerifyApiToken200Response.from_json(json) # print the JSON string representation of the object print(VerifyApiToken200Response.to_json()) # convert the object into a dict verify_api_token200_response_dict = verify_api_token200_response_instance.to_dict() # create an instance of VerifyApiToken200Response from a dict verify_api_token200_response_from_dict = VerifyApiToken200Response.from_dict(verify_api_token200_response_dict) ``` -------------------------------- ### ListOrderChannels200ResponseDataInnerSettings usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListOrderChannels200ResponseDataInnerSettings.md Shows how to create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated. ```python from zippendo.models.list_order_channels200_response_data_inner_settings import ListOrderChannels200ResponseDataInnerSettings # TODO update the JSON string below json = "{}" # create an instance of ListOrderChannels200ResponseDataInnerSettings from a JSON string list_order_channels200_response_data_inner_settings_instance = ListOrderChannels200ResponseDataInnerSettings.from_json(json) # print the JSON string representation of the object print(ListOrderChannels200ResponseDataInnerSettings.to_json()) # convert the object into a dict list_order_channels200_response_data_inner_settings_dict = list_order_channels200_response_data_inner_settings_instance.to_dict() # create an instance of ListOrderChannels200ResponseDataInnerSettings from a dict list_order_channels200_response_data_inner_settings_from_dict = ListOrderChannels200ResponseDataInnerSettings.from_dict(list_order_channels200_response_data_inner_settings_dict) ``` -------------------------------- ### Connect carrier with bearerAuth Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CarriersApi.md Connects a new carrier to the organization with its configuration. Requires a Bearer (JWT) token and an organization ID. The example shows the full client setup and API call. ```python import zippendo from zippendo.models.connect_carrier_request import ConnectCarrierRequest from zippendo.models.list_carriers200_response_data_inner import ListCarriers200ResponseDataInner from zippendo.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.zippendo.com # See configuration.py for a list of all supported configuration parameters. configuration = zippendo.Configuration( host = "https://api.zippendo.com" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure Bearer authorization (JWT): bearerAuth configuration = zippendo.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with zippendo.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = zippendo.CarriersApi(api_client) org_id = 'org_01HZX9K2QF' # str | Organization ID connect_carrier_request = zippendo.ConnectCarrierRequest() # ConnectCarrierRequest | try: # Connect carrier api_response = api_instance.connect_carrier(org_id, connect_carrier_request) print("The response of CarriersApi->connect_carrier:\n") pprint(api_response) except Exception as e: print("Exception when calling CarriersApi->connect_carrier: %s\n" % e) ``` -------------------------------- ### CreateOrgWebhookRequest usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateOrgWebhookRequest.md Shows how to instantiate CreateOrgWebhookRequest from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. ```python from zippendo.models.create_org_webhook_request import CreateOrgWebhookRequest # TODO update the JSON string below json = "{}" # create an instance of CreateOrgWebhookRequest from a JSON string create_org_webhook_request_instance = CreateOrgWebhookRequest.from_json(json) # print the JSON string representation of the object print(CreateOrgWebhookRequest.to_json()) # convert the object into a dict create_org_webhook_request_dict = create_org_webhook_request_instance.to_dict() # create an instance of CreateOrgWebhookRequest from a dict create_org_webhook_request_from_dict = CreateOrgWebhookRequest.from_dict(create_org_webhook_request_dict) ``` -------------------------------- ### Create order with bearerAuth Source: https://github.com/zippendo/zippendo-python/blob/main/docs/OrdersApi.md Creates a new order under an existing order channel for the organization. Requires a Bearer (JWT) token set as the access_token in the configuration. The example shows the full client setup and call to create_order. ```python import zippendo from zippendo.models.create_order201_response import CreateOrder201Response from zippendo.models.create_order_request import CreateOrderRequest from zippendo.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.zippendo.com # See configuration.py for a list of all supported configuration parameters. configuration = zippendo.Configuration( host = "https://api.zippendo.com" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure Bearer authorization (JWT): bearerAuth configuration = zippendo.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with zippendo.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = zippendo.OrdersApi(api_client) org_id = 'org_8f3kd92ld0' # str | Organization ID create_order_request = zippendo.CreateOrderRequest() # CreateOrderRequest | try: # Create order api_response = api_instance.create_order(org_id, create_order_request) print("The response of OrdersApi->create_order:\n") pprint(api_response) except Exception as e: print("Exception when calling OrdersApi->create_order: %s\n" % e) ``` -------------------------------- ### Python example for ListCarrierProducts200ResponseInnerAdditionalParametersInner Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict using the zippendo model class. ```python from zippendo.models.list_carrier_products200_response_inner_additional_parameters_inner import ListCarrierProducts200ResponseInnerAdditionalParametersInner # TODO update the JSON string below json = "{}" # create an instance of ListCarrierProducts200ResponseInnerAdditionalParametersInner from a JSON string list_carrier_products200_response_inner_additional_parameters_inner_instance = ListCarrierProducts200ResponseInnerAdditionalParametersInner.from_json(json) # print the JSON string representation of the object print(ListCarrierProducts200ResponseInnerAdditionalParametersInner.to_json()) # convert the object into a dict list_carrier_products200_response_inner_additional_parameters_inner_dict = list_carrier_products200_response_inner_additional_parameters_inner_instance.to_dict() # create an instance of ListCarrierProducts200ResponseInnerAdditionalParametersInner from a dict list_carrier_products200_response_inner_additional_parameters_inner_from_dict = ListCarrierProducts200ResponseInnerAdditionalParametersInner.from_dict(list_carrier_products200_response_inner_additional_parameters_inner_dict) ``` -------------------------------- ### Get webhook with bearerAuth authentication Source: https://github.com/zippendo/zippendo-python/blob/main/docs/WebhooksApi.md Retrieves a specific webhook including its signing secret. Requires a JWT bearer token set as the BEARER_TOKEN environment variable. The response is a CreateOrgWebhook201Response object. The example prints the response or an exception message. ```python import zippendo from zippendo.models.create_org_webhook201_response import CreateOrgWebhook201Response from zippendo.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.zippendo.com # See configuration.py for a list of all supported configuration parameters. configuration = zippendo.Configuration( host = "https://api.zippendo.com" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure Bearer authorization (JWT): bearerAuth configuration = zippendo.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with zippendo.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = zippendo.WebhooksApi(api_client) org_id = 'org_clx1a2b3c4' # str | Organization ID webhook_id = 'wh_clx1a2b3c4' # str | Webhook ID try: # Get webhook api_response = api_instance.get_org_webhook(org_id, webhook_id) print("The response of WebhooksApi->get_org_webhook:\n") pprint(api_response) except Exception as e: print("Exception when calling WebhooksApi->get_org_webhook: %s\n" % e) ``` -------------------------------- ### Get billing usage with bearerAuth Source: https://github.com/zippendo/zippendo-python/blob/main/docs/BillingApi.md Retrieves usage statistics for the current billing period using the get_billing_usage endpoint. Requires a Bearer (JWT) token set as the BEARER_TOKEN environment variable. The example prints the API response or an exception message. ```python import zippendo from zippendo.models.get_billing_usage200_response import GetBillingUsage200Response from zippendo.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.zippendo.com # See configuration.py for a list of all supported configuration parameters. configuration = zippendo.Configuration( host = "https://api.zippendo.com" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure Bearer authorization (JWT): bearerAuth configuration = zippendo.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with zippendo.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = zippendo.BillingApi(api_client) org_id = 'org_8f3kd92ld0' # str | Organization ID try: # Get usage api_response = api_instance.get_billing_usage(org_id) print("The response of BillingApi->get_billing_usage:\n") pprint(api_response) except Exception as e: print("Exception when calling BillingApi->get_billing_usage: %s\n" % e) ``` -------------------------------- ### Get address with zippendo.AddressesApi.get_address Source: https://github.com/zippendo/zippendo-python/blob/main/docs/AddressesApi.md Returns a single address belonging to the organization, identified by its ID. Requires Bearer (JWT) authentication (bearerAuth). The example sets the host to https://api.zippendo.com and uses an access token from the BEARER_TOKEN environment variable. ```python import zippendo from zippendo.models.list_addresses200_response_data_inner import ListAddresses200ResponseDataInner from zippendo.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.zippendo.com # See configuration.py for a list of all supported configuration parameters. configuration = zippendo.Configuration( host = "https://api.zippendo.com" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure Bearer authorization (JWT): bearerAuth configuration = zippendo.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with zippendo.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = zippendo.AddressesApi(api_client) org_id = 'org_01HZX9K2QF' # str | Organization ID address_id = 'addr_01HZX9K2QF' # str | Address ID try: # Get address api_response = api_instance.get_address(org_id, address_id) print("The response of AddressesApi->get_address:\n") pprint(api_response) except Exception as e: print("Exception when calling AddressesApi->get_address: %s\n" % e) ``` -------------------------------- ### Create and use ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner from JSON Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md Shows how to instantiate the model from a JSON string, print its JSON representation, convert it to a dictionary, and create a new instance from that dictionary. The JSON string is a placeholder and should be updated with actual data. ```python from zippendo.models.list_carrier_products200_response_inner_additional_parameters_inner_options_inner import ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner # TODO update the JSON string below json = "{}" # create an instance of ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner from a JSON string list_carrier_products200_response_inner_additional_parameters_inner_options_inner_instance = ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.from_json(json) # print the JSON string representation of the object print(ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.to_json()) # convert the object into a dict list_carrier_products200_response_inner_additional_parameters_inner_options_inner_dict = list_carrier_products200_response_inner_additional_parameters_inner_options_inner_instance.to_dict() # create an instance of ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner from a dict list_carrier_products200_response_inner_additional_parameters_inner_options_inner_from_dict = ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.from_dict(list_carrier_products200_response_inner_additional_parameters_inner_options_inner_dict) ``` -------------------------------- ### GET /orgs/{orgId}/shipments/{shipmentId} Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ShipmentsApi.md Get shipment. Retrieves details of a specific shipment. ```APIDOC ## GET /orgs/{orgId}/shipments/{shipmentId} ### Description Get shipment. Retrieves details of a specific shipment. ### Method GET ### Endpoint /orgs/{orgId}/shipments/{shipmentId} ### Parameters #### Path Parameters - **orgId** (string) - Required - Organization ID - **shipmentId** (string) - Required - Shipment ID ``` -------------------------------- ### Create ApiClient and resource clients Source: https://github.com/zippendo/zippendo-python/blob/main/README.md Create an ApiClient from the configuration and instantiate resource clients like ShipmentsApi and OrdersApi. Use the `with` statement for proper resource management. ```python with zippendo.ApiClient(config) as client: shipments = zippendo.ShipmentsApi(client) orders = zippendo.OrdersApi(client) ``` -------------------------------- ### GET /orgs/{orgId}/shipments/{shipmentId}/tracking Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ShipmentsApi.md Get shipment tracking. Retrieves tracking information for a specific shipment. ```APIDOC ## GET /orgs/{orgId}/shipments/{shipmentId}/tracking ### Description Get shipment tracking. Retrieves tracking information for a specific shipment. ### Method GET ### Endpoint /orgs/{orgId}/shipments/{shipmentId}/tracking ### Parameters #### Path Parameters - **orgId** (string) - Required - Organization ID - **shipmentId** (string) - Required - Shipment ID ``` -------------------------------- ### Install Zippendo with pip Source: https://github.com/zippendo/zippendo-python/blob/main/README.md Install the Zippendo Python SDK using pip. Requires Python 3.9+. ```sh pip install zippendo ``` -------------------------------- ### ListApiTokens401Response usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListApiTokens401Response.md Shows how to create a ListApiTokens401Response instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. ```python from zippendo.models.list_api_tokens401_response import ListApiTokens401Response # TODO update the JSON string below json = "{}" # create an instance of ListApiTokens401Response from a JSON string list_api_tokens401_response_instance = ListApiTokens401Response.from_json(json) # print the JSON string representation of the object print(ListApiTokens401Response.to_json()) # convert the object into a dict list_api_tokens401_response_dict = list_api_tokens401_response_instance.to_dict() # create an instance of ListApiTokens401Response from a dict list_api_tokens401_response_from_dict = ListApiTokens401Response.from_dict(list_api_tokens401_response_dict) ``` -------------------------------- ### CreateShipment201ResponseDocumentsInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateShipment201ResponseDocumentsInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict using the zippendo model. ```python from zippendo.models.create_shipment201_response_documents_inner import CreateShipment201ResponseDocumentsInner # TODO update the JSON string below json = "{}" # create an instance of CreateShipment201ResponseDocumentsInner from a JSON string create_shipment201_response_documents_inner_instance = CreateShipment201ResponseDocumentsInner.from_json(json) # print the JSON string representation of the object print(CreateShipment201ResponseDocumentsInner.to_json()) # convert the object into a dict create_shipment201_response_documents_inner_dict = create_shipment201_response_documents_inner_instance.to_dict() # create an instance of CreateShipment201ResponseDocumentsInner from a dict create_shipment201_response_documents_inner_from_dict = CreateShipment201ResponseDocumentsInner.from_dict(create_shipment201_response_documents_inner_dict) ``` -------------------------------- ### GET /orgs/{orgId}/billing/usage Source: https://github.com/zippendo/zippendo-python/blob/main/docs/BillingApi.md Get detailed usage statistics for the current billing period. This endpoint requires Bearer (JWT) authentication. ```APIDOC ## GET /orgs/{orgId}/billing/usage ### Description Get detailed usage statistics for the current billing period. ### Method GET ### Endpoint /orgs/{orgId}/billing/usage ### Parameters #### Path Parameters - **orgId** (string) - Required - Organization ID ### Request Example No request body required. ### Response #### Success Response (200) - **GetBillingUsage200Response** - Default Response #### Response Example { "example": "response body" } ### Error Handling - **401** - Default Response - **403** - Default Response ### Authentication - **bearerAuth** (JWT) ### HTTP Headers - **Accept**: application/json - **Content-Type**: Not defined ``` -------------------------------- ### CreateShipmentRequestCarrierSettings from JSON and dict Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateShipmentRequestCarrierSettings.md Shows how to instantiate CreateShipmentRequestCarrierSettings from a JSON string and convert it to a dict, then back to an instance. The JSON string is a placeholder that should be updated with actual data. ```python from zippendo.models.create_shipment_request_carrier_settings import CreateShipmentRequestCarrierSettings # TODO update the JSON string below json = "{}" # create an instance of CreateShipmentRequestCarrierSettings from a JSON string create_shipment_request_carrier_settings_instance = CreateShipmentRequestCarrierSettings.from_json(json) # print the JSON string representation of the object print(CreateShipmentRequestCarrierSettings.to_json()) # convert the object into a dict create_shipment_request_carrier_settings_dict = create_shipment_request_carrier_settings_instance.to_dict() # create an instance of CreateShipmentRequestCarrierSettings from a dict create_shipment_request_carrier_settings_from_dict = CreateShipmentRequestCarrierSettings.from_dict(create_shipment_request_carrier_settings_dict) ``` -------------------------------- ### SplitShipment201Response usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/SplitShipment201Response.md Shows how to create a SplitShipment201Response instance from a JSON string and convert it to a dict. The JSON string is a placeholder that should be updated before use. ```python from zippendo.models.split_shipment201_response import SplitShipment201Response # TODO update the JSON string below json = "{}" # create an instance of SplitShipment201Response from a JSON string split_shipment201_response_instance = SplitShipment201Response.from_json(json) # print the JSON string representation of the object print(SplitShipment201Response.to_json()) # convert the object into a dict split_shipment201_response_dict = split_shipment201_response_instance.to_dict() # create an instance of SplitShipment201Response from a dict split_shipment201_response_from_dict = SplitShipment201Response.from_dict(split_shipment201_response_dict) ``` -------------------------------- ### UpdateShipmentRequestCarrierSettings usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/UpdateShipmentRequestCarrierSettings.md Shows how to create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated. ```python from zippendo.models.update_shipment_request_carrier_settings import UpdateShipmentRequestCarrierSettings # TODO update the JSON string below json = "{}" # create an instance of UpdateShipmentRequestCarrierSettings from a JSON string update_shipment_request_carrier_settings_instance = UpdateShipmentRequestCarrierSettings.from_json(json) # print the JSON string representation of the object print(UpdateShipmentRequestCarrierSettings.to_json()) # convert the object into a dict update_shipment_request_carrier_settings_dict = update_shipment_request_carrier_settings_instance.to_dict() # create an instance of UpdateShipmentRequestCarrierSettings from a dict update_shipment_request_carrier_settings_from_dict = UpdateShipmentRequestCarrierSettings.from_dict(update_shipment_request_carrier_settings_dict) ``` -------------------------------- ### ListOrderChannels200Response Python Example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListOrderChannels200Response.md Shows how to create a ListOrderChannels200Response instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated with actual data. ```python from zippendo.models.list_order_channels200_response import ListOrderChannels200Response # TODO update the JSON string below json = "{}" # create an instance of ListOrderChannels200Response from a JSON string list_order_channels200_response_instance = ListOrderChannels200Response.from_json(json) # print the JSON string representation of the object print(ListOrderChannels200Response.to_json()) # convert the object into a dict list_order_channels200_response_dict = list_order_channels200_response_instance.to_dict() # create an instance of ListOrderChannels200Response from a dict list_order_channels200_response_from_dict = ListOrderChannels200Response.from_dict(list_order_channels200_response_dict) ``` -------------------------------- ### Python example for ListOrderChannels200ResponseDataInner Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListOrderChannels200ResponseDataInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict using the Zippendo Python SDK. ```python from zippendo.models.list_order_channels200_response_data_inner import ListOrderChannels200ResponseDataInner # TODO update the JSON string below json = "{}" # create an instance of ListOrderChannels200ResponseDataInner from a JSON string list_order_channels200_response_data_inner_instance = ListOrderChannels200ResponseDataInner.from_json(json) # print the JSON string representation of the object print(ListOrderChannels200ResponseDataInner.to_json()) # convert the object into a dict list_order_channels200_response_data_inner_dict = list_order_channels200_response_data_inner_instance.to_dict() # create an instance of ListOrderChannels200ResponseDataInner from a dict list_order_channels200_response_data_inner_from_dict = ListOrderChannels200ResponseDataInner.from_dict(list_order_channels200_response_data_inner_dict) ``` -------------------------------- ### CreateShipment201ResponseParcelsInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateShipment201ResponseParcelsInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict using the zippendo model class. ```python from zippendo.models.create_shipment201_response_parcels_inner import CreateShipment201ResponseParcelsInner # TODO update the JSON string below json = "{}" # create an instance of CreateShipment201ResponseParcelsInner from a JSON string create_shipment201_response_parcels_inner_instance = CreateShipment201ResponseParcelsInner.from_json(json) # print the JSON string representation of the object print(CreateShipment201ResponseParcelsInner.to_json()) # convert the object into a dict create_shipment201_response_parcels_inner_dict = create_shipment201_response_parcels_inner_instance.to_dict() # create an instance of CreateShipment201ResponseParcelsInner from a dict create_shipment201_response_parcels_inner_from_dict = CreateShipment201ResponseParcelsInner.from_dict(create_shipment201_response_parcels_inner_dict) ``` -------------------------------- ### CreateShipment201ResponseParcelsInnerOrderLinesInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateShipment201ResponseParcelsInnerOrderLinesInner.md Shows how to create an instance from a JSON string and convert it to a dict using the generated Python client. The example includes a placeholder JSON string that should be updated with actual data. ```python from zippendo.models.create_shipment201_response_parcels_inner_order_lines_inner import CreateShipment201ResponseParcelsInnerOrderLinesInner # TODO update the JSON string below json = "{}" # create an instance of CreateShipment201ResponseParcelsInnerOrderLinesInner from a JSON string create_shipment201_response_parcels_inner_order_lines_inner_instance = CreateShipment201ResponseParcelsInnerOrderLinesInner.from_json(json) # print the JSON string representation of the object print(CreateShipment201ResponseParcelsInnerOrderLinesInner.to_json()) # convert the object into a dict create_shipment201_response_parcels_inner_order_lines_inner_dict = create_shipment201_response_parcels_inner_order_lines_inner_instance.to_dict() # create an instance of CreateShipment201ResponseParcelsInnerOrderLinesInner from a dict create_shipment201_response_parcels_inner_order_lines_inner_from_dict = CreateShipment201ResponseParcelsInnerOrderLinesInner.from_dict(create_shipment201_response_parcels_inner_order_lines_inner_dict) ``` -------------------------------- ### ListOrgWebhookDeliveries200ResponseDataInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListOrgWebhookDeliveries200ResponseDataInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated with actual data. ```python from zippendo.models.list_org_webhook_deliveries200_response_data_inner import ListOrgWebhookDeliveries200ResponseDataInner # TODO update the JSON string below json = "{}" # create an instance of ListOrgWebhookDeliveries200ResponseDataInner from a JSON string list_org_webhook_deliveries200_response_data_inner_instance = ListOrgWebhookDeliveries200ResponseDataInner.from_json(json) # print the JSON string representation of the object print(ListOrgWebhookDeliveries200ResponseDataInner.to_json()) # convert the object into a dict list_org_webhook_deliveries200_response_data_inner_dict = list_org_webhook_deliveries200_response_data_inner_instance.to_dict() # create an instance of ListOrgWebhookDeliveries200ResponseDataInner from a dict list_org_webhook_deliveries200_response_data_inner_from_dict = ListOrgWebhookDeliveries200ResponseDataInner.from_dict(list_org_webhook_deliveries200_response_data_inner_dict) ``` -------------------------------- ### CreateShipment201ResponseActivitiesInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateShipment201ResponseActivitiesInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated. ```python from zippendo.models.create_shipment201_response_activities_inner import CreateShipment201ResponseActivitiesInner # TODO update the JSON string below json = "{}" # create an instance of CreateShipment201ResponseActivitiesInner from a JSON string create_shipment201_response_activities_inner_instance = CreateShipment201ResponseActivitiesInner.from_json(json) # print the JSON string representation of the object print(CreateShipment201ResponseActivitiesInner.to_json()) # convert the object into a dict create_shipment201_response_activities_inner_dict = create_shipment201_response_activities_inner_instance.to_dict() # create an instance of CreateShipment201ResponseActivitiesInner from a dict create_shipment201_response_activities_inner_from_dict = CreateShipment201ResponseActivitiesInner.from_dict(create_shipment201_response_activities_inner_dict) ``` -------------------------------- ### BatchSendShipments200ResponseResultsInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/BatchSendShipments200ResponseResultsInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict using the Zippendo Python SDK. ```python from zippendo.models.batch_send_shipments200_response_results_inner import BatchSendShipments200ResponseResultsInner # TODO update the JSON string below json = "{}" # create an instance of BatchSendShipments200ResponseResultsInner from a JSON string batch_send_shipments200_response_results_inner_instance = BatchSendShipments200ResponseResultsInner.from_json(json) # print the JSON string representation of the object print(BatchSendShipments200ResponseResultsInner.to_json()) # convert the object into a dict batch_send_shipments200_response_results_inner_dict = batch_send_shipments200_response_results_inner_instance.to_dict() # create an instance of BatchSendShipments200ResponseResultsInner from a dict batch_send_shipments200_response_results_inner_from_dict = BatchSendShipments200ResponseResultsInner.from_dict(batch_send_shipments200_response_results_inner_dict) ``` -------------------------------- ### get_carrier example with bearerAuth Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CarriersApi.md Shows how to call the get_carrier endpoint using the zippendo Python client. Requires a bearer token set as the BEARER_TOKEN environment variable. The example prints the response or an exception message. ```python import zippendo from zippendo.models.list_carriers200_response_data_inner import ListCarriers200ResponseDataInner from zippendo.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.zippendo.com # See configuration.py for a list of all supported configuration parameters. configuration = zippendo.Configuration( host = "https://api.zippendo.com" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure Bearer authorization (JWT): bearerAuth configuration = zippendo.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with zippendo.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = zippendo.CarriersApi(api_client) org_id = 'org_01HZX9K2QF' # str | Organization ID carrier_id = 'carr_01HZX9K2QF' # str | Carrier ID try: # Get carrier api_response = api_instance.get_carrier(org_id, carrier_id) print("The response of CarriersApi->get_carrier:\n") pprint(api_response) except Exception as e: print("Exception when calling CarriersApi->get_carrier: %s\n" % e) ``` -------------------------------- ### GetOrderChannelWebhookStatus200ResponseWebhooksInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/GetOrderChannelWebhookStatus200ResponseWebhooksInner.md Shows how to create an instance of GetOrderChannelWebhookStatus200ResponseWebhooksInner from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. The JSON string is a placeholder that should be updated before use. ```python from zippendo.models.get_order_channel_webhook_status200_response_webhooks_inner import GetOrderChannelWebhookStatus200ResponseWebhooksInner # TODO update the JSON string below json = "{}" # create an instance of GetOrderChannelWebhookStatus200ResponseWebhooksInner from a JSON string get_order_channel_webhook_status200_response_webhooks_inner_instance = GetOrderChannelWebhookStatus200ResponseWebhooksInner.from_json(json) # print the JSON string representation of the object print(GetOrderChannelWebhookStatus200ResponseWebhooksInner.to_json()) # convert the object into a dict get_order_channel_webhook_status200_response_webhooks_inner_dict = get_order_channel_webhook_status200_response_webhooks_inner_instance.to_dict() # create an instance of GetOrderChannelWebhookStatus200ResponseWebhooksInner from a dict get_order_channel_webhook_status200_response_webhooks_inner_from_dict = GetOrderChannelWebhookStatus200ResponseWebhooksInner.from_dict(get_order_channel_webhook_status200_response_webhooks_inner_dict) ``` -------------------------------- ### CreateAddressRequest Python Usage Example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CreateAddressRequest.md Example showing how to create a CreateAddressRequest instance from a JSON string, print its JSON representation, convert it to a dict, and recreate it from the dict using the zippendo Python SDK. ```python from zippendo.models.create_address_request import CreateAddressRequest # TODO update the JSON string below json = "{}" # create an instance of CreateAddressRequest from a JSON string create_address_request_instance = CreateAddressRequest.from_json(json) # print the JSON string representation of the object print(CreateAddressRequest.to_json()) # convert the object into a dict create_address_request_dict = create_address_request_instance.to_dict() # create an instance of CreateAddressRequest from a dict create_address_request_from_dict = CreateAddressRequest.from_dict(create_address_request_dict) ``` -------------------------------- ### Python example for list_carrier_product_service_points with bearerAuth Source: https://github.com/zippendo/zippendo-python/blob/main/docs/CarriersApi.md Shows how to call the CarriersApi.list_carrier_product_service_points method using the zippendo Python client. Requires a bearer token (JWT) set via the BEARER_TOKEN environment variable. The example prints the response or an exception message. ```python import zippendo from zippendo.models.list_carrier_product_service_points200_response_inner import ListCarrierProductServicePoints200ResponseInner from zippendo.models.list_carrier_product_service_points_request import ListCarrierProductServicePointsRequest from zippendo.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://api.zippendo.com # See configuration.py for a list of all supported configuration parameters. configuration = zippendo.Configuration( host = "https://api.zippendo.com" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure Bearer authorization (JWT): bearerAuth configuration = zippendo.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with zippendo.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = zippendo.CarriersApi(api_client) org_id = 'org_01HZX9K2QF' # str | Organization ID carrier_id = 'carr_01HZX9K2QF' # str | Carrier ID product_id = 'PNL13' # str | Carrier product ID list_carrier_product_service_points_request = zippendo.ListCarrierProductServicePointsRequest() # ListCarrierProductServicePointsRequest | try: # List product service points api_response = api_instance.list_carrier_product_service_points(org_id, carrier_id, product_id, list_carrier_product_service_points_request) print("The response of CarriersApi->list_carrier_product_service_points:\n") pprint(api_response) except Exception as e: print("Exception when calling CarriersApi->list_carrier_product_service_points: %s\n" % e) ``` -------------------------------- ### BatchSplitShipmentRequestShipmentsInnerOrderLinesInner from_json and to_dict Example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.md Shows how to create a BatchSplitShipmentRequestShipmentsInnerOrderLinesInner instance from a JSON string, print its JSON representation, convert it to a dict, and create a new instance from that dict. The JSON string is a placeholder that should be updated with actual data. ```python from zippendo.models.batch_split_shipment_request_shipments_inner_order_lines_inner import BatchSplitShipmentRequestShipmentsInnerOrderLinesInner # TODO update the JSON string below json = "{}" # create an instance of BatchSplitShipmentRequestShipmentsInnerOrderLinesInner from a JSON string batch_split_shipment_request_shipments_inner_order_lines_inner_instance = BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.from_json(json) # print the JSON string representation of the object print(BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.to_json()) # convert the object into a dict batch_split_shipment_request_shipments_inner_order_lines_inner_dict = batch_split_shipment_request_shipments_inner_order_lines_inner_instance.to_dict() # create an instance of BatchSplitShipmentRequestShipmentsInnerOrderLinesInner from a dict batch_split_shipment_request_shipments_inner_order_lines_inner_from_dict = BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.from_dict(batch_split_shipment_request_shipments_inner_order_lines_inner_dict) ``` -------------------------------- ### ListShippingRules200ResponseDataInner usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/ListShippingRules200ResponseDataInner.md Shows how to create an instance from a JSON string, print its JSON representation, convert to a dict, and create an instance from a dict using the zippendo model. ```python from zippendo.models.list_shipping_rules200_response_data_inner import ListShippingRules200ResponseDataInner # TODO update the JSON string below json = "{}" # create an instance of ListShippingRules200ResponseDataInner from a JSON string list_shipping_rules200_response_data_inner_instance = ListShippingRules200ResponseDataInner.from_json(json) # print the JSON string representation of the object print(ListShippingRules200ResponseDataInner.to_json()) # convert the object into a dict list_shipping_rules200_response_data_inner_dict = list_shipping_rules200_response_data_inner_instance.to_dict() # create an instance of ListShippingRules200ResponseDataInner from a dict list_shipping_rules200_response_data_inner_from_dict = ListShippingRules200ResponseDataInner.from_dict(list_shipping_rules200_response_data_inner_dict) ``` -------------------------------- ### TestOrgWebhook200Response usage example Source: https://github.com/zippendo/zippendo-python/blob/main/docs/TestOrgWebhook200Response.md Shows how to create a TestOrgWebhook200Response instance from a JSON string, print its JSON representation, convert it to a dict, and create an instance from a dict. ```python from zippendo.models.test_org_webhook200_response import TestOrgWebhook200Response # TODO update the JSON string below json = "{}" # create an instance of TestOrgWebhook200Response from a JSON string test_org_webhook200_response_instance = TestOrgWebhook200Response.from_json(json) # print the JSON string representation of the object print(TestOrgWebhook200Response.to_json()) # convert the object into a dict test_org_webhook200_response_dict = test_org_webhook200_response_instance.to_dict() # create an instance of TestOrgWebhook200Response from a dict test_org_webhook200_response_from_dict = TestOrgWebhook200Response.from_dict(test_org_webhook200_response_dict) ```