### Java example for ListShippingRules200ResponseDataInnerAdditionalParametersValue anyOf Source: https://github.com/zippendo/zippendo-java/blob/main/docs/ListShippingRules200ResponseDataInnerAdditionalParametersValue.md Shows how to create and use the anyOf model by setting and getting each possible actual instance type (BigDecimal, Boolean, ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf, String) via setActualInstance and getActualInstance. Requires importing the listed model classes from com.zippendo.sdk.model. ```java // Import classes: import com.zippendo.sdk.model.ListShippingRules200ResponseDataInnerAdditionalParametersValue; import com.zippendo.sdk.model.BigDecimal; import com.zippendo.sdk.model.Boolean; import com.zippendo.sdk.model.ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf; import com.zippendo.sdk.model.String; public class Example { public static void main(String[] args) { ListShippingRules200ResponseDataInnerAdditionalParametersValue exampleListShippingRules200ResponseDataInnerAdditionalParametersValue = new ListShippingRules200ResponseDataInnerAdditionalParametersValue(); // create a new BigDecimal BigDecimal exampleBigDecimal = new BigDecimal(); // set ListShippingRules200ResponseDataInnerAdditionalParametersValue to BigDecimal exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.setActualInstance(exampleBigDecimal); // to get back the BigDecimal set earlier BigDecimal testBigDecimal = (BigDecimal) exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.getActualInstance(); // create a new Boolean Boolean exampleBoolean = new Boolean(); // set ListShippingRules200ResponseDataInnerAdditionalParametersValue to Boolean exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.setActualInstance(exampleBoolean); // to get back the Boolean set earlier Boolean testBoolean = (Boolean) exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.getActualInstance(); // create a new ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf exampleListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf = new ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf(); // set ListShippingRules200ResponseDataInnerAdditionalParametersValue to ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.setActualInstance(exampleListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf); // to get back the ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf set earlier ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf testListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf = (ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf) exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.getActualInstance(); // create a new String String exampleString = new String(); // set ListShippingRules200ResponseDataInnerAdditionalParametersValue to String exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.setActualInstance(exampleString); // to get back the String set earlier String testString = (String) exampleListShippingRules200ResponseDataInnerAdditionalParametersValue.getActualInstance(); } } ``` -------------------------------- ### listAddressesWithHttpInfo Example Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Example showing how to call listAddressesWithHttpInfo with an APIlistAddressesRequest. It configures the API client with a bearer token, builds a request with optional filters, and prints the status code, headers, and response body. The example catches ApiException and prints error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.AddressesApi; import com.zippendo.sdk.api.AddressesApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); AddressesApi apiInstance = new AddressesApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID Integer page = 1; // Integer | Page number (1-based) Integer limit = 20; // Integer | Items per page (max 100) String type = "sender"; // String | Filter by address type (sender, pickup, return) String countryCode = "DK"; // String | Filter by ISO 3166-1 alpha-2 country code. String search = "Copenhagen"; // String | Search by company name, description, contact or city. String brandId = "brnd_8f3kd92ld0"; // String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. String brandScope = "own"; // String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. try { APIlistAddressesRequest request = APIlistAddressesRequest.newBuilder() .orgId(orgId) .page(page) .limit(limit) .type(type) .countryCode(countryCode) .search(search) .brandId(brandId) .brandScope(brandScope) .build(); ApiResponse response = apiInstance.listAddressesWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling AddressesApi#listAddresses"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### Java example for updateAddressWithHttpInfo Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Updates an existing address belonging to the organization. The example configures the API client with base path and bearer token, then calls updateAddressWithHttpInfo with an APIupdateAddressRequest. It prints the status code, headers, and response body, and handles ApiException by printing error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.AddressesApi; import com.zippendo.sdk.api.AddressesApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); AddressesApi apiInstance = new AddressesApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID String addressId = "addr_01HZX9K2QF"; // String | Address ID UpdateAddressRequest updateAddressRequest = new UpdateAddressRequest(); // UpdateAddressRequest | try { APIupdateAddressRequest request = APIupdateAddressRequest.newBuilder() .orgId(orgId) .addressId(addressId) .updateAddressRequest(updateAddressRequest) .build(); ApiResponse response = apiInstance.updateAddressWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling AddressesApi#updateAddress"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### getAddress Java example with bearerAuth Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Shows how to call AddressesApi#getAddress using the Java SDK. It configures the API client with base path https://api.zippendo.com and HTTP bearer authentication (bearerAuth), then builds an APIgetAddressRequest with orgId and addressId and prints the returned ListAddresses200ResponseDataInner. The example catches ApiException and prints status code, response body, and headers on failure. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.AddressesApi; import com.zippendo.sdk.api.AddressesApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); AddressesApi apiInstance = new AddressesApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID String addressId = "addr_01HZX9K2QF"; // String | Address ID try { APIgetAddressRequest request = APIgetAddressRequest.newBuilder() .orgId(orgId) .addressId(addressId) .build(); ListAddresses200ResponseDataInner result = apiInstance.getAddress(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AddressesApi#getAddress"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### GET /orgs/{orgId}/addresses Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Lists all addresses for an organization. This endpoint requires bearer authentication. ```APIDOC ## GET /orgs/{orgId}/addresses ### Description Lists all addresses for an organization. ### Method GET ### Endpoint /orgs/{orgId}/addresses ### Parameters #### Path Parameters - **orgId** (string) - Required - Organization ID ### Response #### Success Response (200) - **data** (array of ListAddresses200ResponseDataInner) - List of addresses. #### Response Example ```json { "data": [] } ``` ### Error Responses - **400** - Default Response - **403** - Default Response - **404** - Default Response ### Authorization bearerAuth ### HTTP Request Headers - **Accept**: application/json ``` -------------------------------- ### getOrgBranding Example Source: https://github.com/zippendo/zippendo-java/blob/main/docs/OrgsApi.md Example of calling the getOrgBranding operation to retrieve org branding. Requires a bearer token for authentication. The example sets the base path to https://api.zippendo.com and uses the OrgsApi client. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.OrgsApi; import com.zippendo.sdk.api.OrgsApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); OrgsApi apiInstance = new OrgsApi(defaultClient); String orgId = "org_8f3kd92ld0"; // String | Organization ID try { APIgetOrgBrandingRequest request = APIgetOrgBrandingRequest.newBuilder() .orgId(orgId) .build(); GetOrgBranding200Response result = apiInstance.getOrgBranding(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OrgsApi#getOrgBranding"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### getOrgWithHttpInfo example Source: https://github.com/zippendo/zippendo-java/blob/main/docs/OrgsApi.md Example of calling getOrgWithHttpInfo with a bearer token. It sets the base path to https://api.zippendo.com, configures bearerAuth, builds an APIgetOrgRequest with an id, and prints the status code, headers, and body. Catches ApiException and prints error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.OrgsApi; import com.zippendo.sdk.api.OrgsApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); OrgsApi apiInstance = new OrgsApi(defaultClient); String id = "clz9x8a7b0001"; // String | Resource ID try { APIgetOrgRequest request = APIgetOrgRequest.newBuilder() .id(id) .build(); ApiResponse response = apiInstance.getOrgWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling OrgsApi#getOrg"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### Java example for getOrderWithHttpInfo Source: https://github.com/zippendo/zippendo-java/blob/main/docs/OrdersApi.md Shows how to call getOrderWithHttpInfo with the bearerAuth token. The example sets the base path to https://api.zippendo.com, configures the bearer token, builds an APIgetOrderRequest with orgId and orderId, and prints the status code, headers, and response body. It also handles ApiException by printing the error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.OrdersApi; import com.zippendo.sdk.api.OrdersApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); OrdersApi apiInstance = new OrdersApi(defaultClient); String orgId = "clz9k2f0a0000abcd0000zzzz"; // String | Organization ID. String orderId = "clz9k2f0a0003abcd9012mnop"; // String | Order ID. try { APIgetOrderRequest request = APIgetOrderRequest.newBuilder() .orgId(orgId) .orderId(orderId) .build(); ApiResponse response = apiInstance.getOrderWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling OrdersApi#getOrder"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### GET /orgs/{orgId}/addresses/{addressId} Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Retrieves a specific address by its ID. This endpoint requires bearer authentication. ```APIDOC ## GET /orgs/{orgId}/addresses/{addressId} ### Description Retrieves a specific address by its ID. ### Method GET ### Endpoint /orgs/{orgId}/addresses/{addressId} ### Parameters #### Path Parameters - **orgId** (string) - Required - Organization ID - **addressId** (string) - Required - Address ID ### Response #### Success Response (200) - **data** (ListAddresses200ResponseDataInner) - The address object. #### Response Example ```json { "data": {} } ``` ### Error Responses - **400** - Default Response - **403** - Default Response - **404** - Default Response ### Authorization bearerAuth ### HTTP Request Headers - **Accept**: application/json ``` -------------------------------- ### listOrderChannels Java Example Source: https://github.com/zippendo/zippendo-java/blob/main/docs/OrderChannelsApi.md Calls the listOrderChannels endpoint to retrieve a paginated list of order channels for an organization. Requires a bearer token for authentication and sets the base path to https://api.zippendo.com. The example builds an APIlistOrderChannelsRequest with optional filters (brandId, brandScope, type, enabled, search) and prints the response or error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.OrderChannelsApi; import com.zippendo.sdk.api.OrderChannelsApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); OrderChannelsApi apiInstance = new OrderChannelsApi(defaultClient); String orgId = "org_8f3kd92ld0"; // String | Organization ID Integer page = 1; // Integer | Page number (1-based) Integer limit = 20; // Integer | Items per page (max 100) String brandId = "brnd_8f3kd92ld0"; // String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. String brandScope = "own"; // String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. String type = "shopify"; // String | Filter by channel type. String enabled = "true"; // String | Filter by enabled state. String search = "Anna's Shopify Store"; // String | Search by channel name. try { APIlistOrderChannelsRequest request = APIlistOrderChannelsRequest.newBuilder() .orgId(orgId) .page(page) .limit(limit) .brandId(brandId) .brandScope(brandScope) .type(type) .enabled(enabled) .search(search) .build(); ListOrderChannels200Response result = apiInstance.listOrderChannels(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OrderChannelsApi#listOrderChannels"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### Java example for getBillingUsage with bearerAuth Source: https://github.com/zippendo/zippendo-java/blob/main/docs/BillingApi.md Shows how to call BillingApi#getBillingUsage using the Java SDK. Requires a bearer token for bearerAuth and an organization ID. Prints the GetBillingUsage200Response result or catches ApiException with status code, reason, and response headers. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.BillingApi; import com.zippendo.sdk.api.BillingApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); BillingApi apiInstance = new BillingApi(defaultClient); String orgId = "org_8f3kd92ld0"; // String | Organization ID try { APIgetBillingUsageRequest request = APIgetBillingUsageRequest.newBuilder() .orgId(orgId) .build(); GetBillingUsage200Response result = apiInstance.getBillingUsage(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling BillingApi#getBillingUsage"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### listShippingRules Java example Source: https://github.com/zippendo/zippendo-java/blob/main/docs/RulesApi.md Example of calling the listShippingRules endpoint using the Zippendo Java SDK. Requires a bearer token for authentication and sets the base path to https://api.zippendo.com. The example builds an APIlistShippingRulesRequest with optional filters (page, limit, brandId, brandScope, carrierId, search) and prints the response or error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.RulesApi; import com.zippendo.sdk.api.RulesApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); RulesApi apiInstance = new RulesApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID Integer page = 1; // Integer | Page number (1-based) Integer limit = 20; // Integer | Items per page (max 100) String brandId = "brnd_8f3kd92ld0"; // String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. String brandScope = "own"; // String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. String carrierId = "carr_01HZX9K2QF"; // String | Filter by carrier. String search = "Home delivery"; // String | Search by rule name. try { APIlistShippingRulesRequest request = APIlistShippingRulesRequest.newBuilder() .orgId(orgId) .page(page) .limit(limit) .brandId(brandId) .brandScope(brandScope) .carrierId(carrierId) .search(search) .build(); ListShippingRules200Response result = apiInstance.listShippingRules(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RulesApi#listShippingRules"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### getBrandLogoWithHttpInfo Example Source: https://github.com/zippendo/zippendo-java/blob/main/docs/BrandsApi.md Example of calling getBrandLogoWithHttpInfo to stream a brand's logo bytes. Requires HTTP bearer authorization (bearerAuth) and a base path of https://api.zippendo.com. The request is built with APIgetBrandLogoRequest and the response contains the logo file. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.BrandsApi; import com.zippendo.sdk.api.BrandsApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); BrandsApi apiInstance = new BrandsApi(defaultClient); String orgId = "org_8f3kd92ld0"; // String | Organization ID String brandId = "brnd_8f3kd92ld0"; // String | Brand ID try { APIgetBrandLogoRequest request = APIgetBrandLogoRequest.newBuilder() .orgId(orgId) .brandId(brandId) .build(); ApiResponse response = apiInstance.getBrandLogoWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling BrandsApi#getBrandLogo"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### Java example for updateAddress Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Updates an existing address belonging to the organization. The example configures the API client with base path and bearer token, then calls updateAddress with orgId, addressId, and an UpdateAddressRequest. It prints the result or catches ApiException with status code, reason, and response headers. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.AddressesApi; import com.zippendo.sdk.api.AddressesApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); AddressesApi apiInstance = new AddressesApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID String addressId = "addr_01HZX9K2QF"; // String | Address ID UpdateAddressRequest updateAddressRequest = new UpdateAddressRequest(); // UpdateAddressRequest | try { APIupdateAddressRequest request = APIupdateAddressRequest.newBuilder() .orgId(orgId) .addressId(addressId) .updateAddressRequest(updateAddressRequest) .build(); ListAddresses200ResponseDataInner result = apiInstance.updateAddress(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AddressesApi#updateAddress"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### Java example for unarchiveOrgBrandWithHttpInfo Source: https://github.com/zippendo/zippendo-java/blob/main/docs/BrandsApi.md Restores an archived brand so it appears in the brand switcher again. The example configures the API client with a bearer token and calls unarchiveOrgBrandWithHttpInfo with an APIunarchiveOrgBrandRequest. It prints the status code, headers, and response body, and handles ApiException. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.BrandsApi; import com.zippendo.sdk.api.BrandsApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); BrandsApi apiInstance = new BrandsApi(defaultClient); String orgId = "org_8f3kd92ld0"; // String | Organization ID String brandId = "brnd_8f3kd92ld0"; // String | Brand ID try { APIunarchiveOrgBrandRequest request = APIunarchiveOrgBrandRequest.newBuilder() .orgId(orgId) .brandId(brandId) .build(); ApiResponse response = apiInstance.unarchiveOrgBrandWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling BrandsApi#unarchiveOrgBrand"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### getOrder Java example with bearerAuth Source: https://github.com/zippendo/zippendo-java/blob/main/docs/OrdersApi.md Shows how to call getOrder using the Zippendo Java SDK. Requires a bearer token for authorization and sets the base path to https://api.zippendo.com. The example builds an APIgetOrderRequest with orgId and orderId, then prints the GetOrder200Response or catches ApiException. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.OrdersApi; import com.zippendo.sdk.api.OrdersApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); OrdersApi apiInstance = new OrdersApi(defaultClient); String orgId = "clz9k2f0a0000abcd0000zzzz"; // String | Organization ID. String orderId = "clz9k2f0a0003abcd9012mnop"; // String | Order ID. try { APIgetOrderRequest request = APIgetOrderRequest.newBuilder() .orgId(orgId) .orderId(orderId) .build(); GetOrder200Response result = apiInstance.getOrder(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OrdersApi#getOrder"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### Create address with HTTP info using AddressesApi Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Creates a new sender, pickup, or return address for the organization. Requires a bearer token for authentication and sets the base path to https://api.zippendo.com. The example builds an APIcreateAddressRequest with orgId and CreateAddressRequest, then calls createAddressWithHttpInfo and prints the status code, headers, and response body. Catches ApiException to display error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.AddressesApi; import com.zippendo.sdk.api.AddressesApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); AddressesApi apiInstance = new AddressesApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID CreateAddressRequest createAddressRequest = new CreateAddressRequest(); // CreateAddressRequest | try { APIcreateAddressRequest request = APIcreateAddressRequest.newBuilder() .orgId(orgId) .createAddressRequest(createAddressRequest) .build(); ApiResponse response = apiInstance.createAddressWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling AddressesApi#createAddress"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### Java example: getOrderChannelWebhookStatusWithHttpInfo Source: https://github.com/zippendo/zippendo-java/blob/main/docs/OrderChannelsApi.md Calls the OrderChannelsApi.getOrderChannelWebhookStatusWithHttpInfo method to check whether webhooks are enabled and list registered webhooks. Requires a bearer token and sets the base path to https://api.zippendo.com. The example builds an APIgetOrderChannelWebhookStatusRequest with orgId and channelId, then prints the status code, headers, and response body. On ApiException, it prints the error details. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.ApiResponse; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.OrderChannelsApi; import com.zippendo.sdk.api.OrderChannelsApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); OrderChannelsApi apiInstance = new OrderChannelsApi(defaultClient); String orgId = "clz9k2f0a0000abcd0000zzzz"; // String | Organization ID. String channelId = "clz9k2f0a0001abcd1234efgh"; // String | Order channel ID. try { APIgetOrderChannelWebhookStatusRequest request = APIgetOrderChannelWebhookStatusRequest.newBuilder() .orgId(orgId) .channelId(channelId) .build(); ApiResponse response = apiInstance.getOrderChannelWebhookStatusWithHttpInfo(request); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { System.err.println("Exception when calling OrderChannelsApi#getOrderChannelWebhookStatus"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); e.printStackTrace(); } } } ``` -------------------------------- ### listAddresses Java example with bearerAuth Source: https://github.com/zippendo/zippendo-java/blob/main/docs/AddressesApi.md Calls AddressesApi#listAddresses with an APIlistAddressesRequest. Requires a bearer token and sets the base path to https://api.zippendo.com. The response is a ListAddresses200Response; on failure, the ApiException prints status code, reason, and response headers. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.AddressesApi; import com.zippendo.sdk.api.AddressesApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); AddressesApi apiInstance = new AddressesApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID Integer page = 1; // Integer | Page number (1-based) Integer limit = 20; // Integer | Items per page (max 100) String type = "sender"; // String | Filter by address type (sender, pickup, return) String countryCode = "DK"; // String | Filter by ISO 3166-1 alpha-2 country code. String search = "Copenhagen"; // String | Search by company name, description, contact or city. String brandId = "brnd_8f3kd92ld0"; // String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. String brandScope = "own"; // String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. try { APIlistAddressesRequest request = APIlistAddressesRequest.newBuilder() .orgId(orgId) .page(page) .limit(limit) .type(type) .countryCode(countryCode) .search(search) .brandId(brandId) .brandScope(brandScope) .build(); ListAddresses200Response result = apiInstance.listAddresses(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AddressesApi#listAddresses"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### Java example for listCarrierProductServicePoints Source: https://github.com/zippendo/zippendo-java/blob/main/docs/CarriersApi.md Shows how to call the listCarrierProductServicePoints endpoint using the Zippendo Java SDK. It configures the API client with base path https://api.zippendo.com and bearer token authentication, then builds a request with orgId, carrierId, productId, and a ListCarrierProductServicePointsRequest object. The response is a list of ListCarrierProductServicePoints200ResponseInner objects. The example catches ApiException and prints status code, reason, and response headers. ```java // Import classes: import com.zippendo.sdk.ApiClient; import com.zippendo.sdk.ApiException; import com.zippendo.sdk.Configuration; import com.zippendo.sdk.auth.*; import com.zippendo.sdk.models.*; import com.zippendo.sdk.api.CarriersApi; import com.zippendo.sdk.api.CarriersApi.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.zippendo.com"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); bearerAuth.setBearerToken("BEARER TOKEN"); CarriersApi apiInstance = new CarriersApi(defaultClient); String orgId = "org_01HZX9K2QF"; // String | Organization ID String carrierId = "carr_01HZX9K2QF"; // String | Carrier ID String productId = "PNL13"; // String | Carrier product ID ListCarrierProductServicePointsRequest listCarrierProductServicePointsRequest = new ListCarrierProductServicePointsRequest(); // ListCarrierProductServicePointsRequest | try { APIlistCarrierProductServicePointsRequest request = APIlistCarrierProductServicePointsRequest.newBuilder() .orgId(orgId) .carrierId(carrierId) .productId(productId) .listCarrierProductServicePointsRequest(listCarrierProductServicePointsRequest) .build(); List result = apiInstance.listCarrierProductServicePoints(request); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CarriersApi#listCarrierProductServicePoints"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` -------------------------------- ### Construct resource clients (ShipmentsApi, OrdersApi) Source: https://github.com/zippendo/zippendo-java/blob/main/README.md Shows how to instantiate resource clients like ShipmentsApi and OrdersApi with a shared ApiClient. Use this pattern to access the API's operations. ```java import com.zippendo.sdk.api.OrdersApi; import com.zippendo.sdk.api.ShipmentsApi; ShipmentsApi shipments = new ShipmentsApi(client); OrdersApi orders = new OrdersApi(client); ``` -------------------------------- ### new BrandsApi(client) Source: https://github.com/zippendo/zippendo-java/blob/main/README.md Constructs a BrandsApi resource client using the provided ApiClient. Use this client to manage brands within an organization. ```APIDOC ## BrandsApi ### Description Constructs a BrandsApi resource client using the provided ApiClient. Use this client to manage brands within an organization. ### Constructor `BrandsApi(ApiClient client)` ### Parameters - **client** (ApiClient) - Required - The API client used for making requests. ```