zippendo 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE.md +21 -0
- data/README.md +99 -0
- data/Rakefile +10 -0
- data/docs/AddressesApi.md +375 -0
- data/docs/BatchSendShipments200Response.md +20 -0
- data/docs/BatchSendShipments200ResponseResultsInner.md +26 -0
- data/docs/BatchSendShipments200ResponseSummary.md +22 -0
- data/docs/BatchSendShipmentsRequest.md +18 -0
- data/docs/BatchSplitShipment201Response.md +20 -0
- data/docs/BatchSplitShipmentRequest.md +28 -0
- data/docs/BatchSplitShipmentRequestShipmentsInner.md +20 -0
- data/docs/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.md +20 -0
- data/docs/BillingApi.md +77 -0
- data/docs/CarrierCatalogApi.md +77 -0
- data/docs/CarriersApi.md +521 -0
- data/docs/ConnectCarrierRequest.md +22 -0
- data/docs/CreateAddressRequest.md +40 -0
- data/docs/CreateApiToken201Response.md +32 -0
- data/docs/CreateApiTokenRequest.md +22 -0
- data/docs/CreateOrder201Response.md +52 -0
- data/docs/CreateOrder201ResponseOrderLinesInner.md +54 -0
- data/docs/CreateOrder201ResponseShippingAddress.md +42 -0
- data/docs/CreateOrderRequest.md +40 -0
- data/docs/CreateOrderRequestOrderLinesInner.md +54 -0
- data/docs/CreateOrderRequestShippingAddress.md +42 -0
- data/docs/CreateOrgWebhook201Response.md +32 -0
- data/docs/CreateOrgWebhookRequest.md +24 -0
- data/docs/CreateShipment201Response.md +64 -0
- data/docs/CreateShipment201ResponseActivitiesInner.md +26 -0
- data/docs/CreateShipment201ResponseDocumentsInner.md +32 -0
- data/docs/CreateShipment201ResponseErrorsInner.md +26 -0
- data/docs/CreateShipment201ResponseLogsInner.md +32 -0
- data/docs/CreateShipment201ResponseParcelsInner.md +38 -0
- data/docs/CreateShipment201ResponseParcelsInnerDimensions.md +22 -0
- data/docs/CreateShipment201ResponseParcelsInnerOrderLinesInner.md +36 -0
- data/docs/CreateShipment201ResponsePartiesInner.md +38 -0
- data/docs/CreateShipment201ResponsePartiesInnerAttributesInner.md +20 -0
- data/docs/CreateShipment201ResponsePickupDetails.md +24 -0
- data/docs/CreateShipment201ResponseShippingRule.md +40 -0
- data/docs/CreateShipment201ResponseTracking.md +28 -0
- data/docs/CreateShipmentRequest.md +42 -0
- data/docs/CreateShipmentRequestCarrierSettings.md +24 -0
- data/docs/CreateShipmentRequestParcelsInner.md +38 -0
- data/docs/CreateShipmentRequestParcelsInnerDimensions.md +22 -0
- data/docs/CreateShipmentRequestParcelsInnerOrderLinesInner.md +36 -0
- data/docs/CreateShipmentRequestPartiesInner.md +38 -0
- data/docs/CreateShipmentRequestPartiesInnerAttributesInner.md +20 -0
- data/docs/CreateShipmentRequestPickupDetails.md +24 -0
- data/docs/CreateShippingQuote200Response.md +18 -0
- data/docs/CreateShippingQuote200ResponseRatesInner.md +38 -0
- data/docs/CreateShippingQuote400Response.md +20 -0
- data/docs/CreateShippingQuote404Response.md +20 -0
- data/docs/CreateShippingQuoteRequest.md +24 -0
- data/docs/CreateShippingQuoteRequestDestination.md +28 -0
- data/docs/CreateShippingQuoteRequestItemsInner.md +30 -0
- data/docs/CreateShippingRule201Response.md +74 -0
- data/docs/CreateShippingRuleRequest.md +66 -0
- data/docs/CreateShippingRuleRequestAdditionalParameters.md +15 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfInner.md +20 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValue.md +24 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md +24 -0
- data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md +15 -0
- data/docs/CreateShippingRuleRequestConditionsInner.md +55 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf.md +26 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf1.md +28 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf2.md +28 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf3.md +26 -0
- data/docs/CreateShippingRuleRequestConditionsInnerOneOf4.md +22 -0
- data/docs/DeleteOrgWebhook200Response.md +18 -0
- data/docs/DeleteShippingRule200Response.md +18 -0
- data/docs/GetBillingUsage200Response.md +24 -0
- data/docs/GetBillingUsage200ResponseAddOnsInner.md +24 -0
- data/docs/GetBillingUsage200ResponseCurrentPeriod.md +20 -0
- data/docs/GetBillingUsage200ResponseLimits.md +30 -0
- data/docs/GetBillingUsage200ResponseLimitsTeamMembers.md +20 -0
- data/docs/GetBillingUsage200ResponseShipments.md +24 -0
- data/docs/GetOrder200Response.md +58 -0
- data/docs/GetOrder200ResponseShipmentsInner.md +36 -0
- data/docs/GetOrder200ResponseShippingRule.md +40 -0
- data/docs/GetOrg200Response.md +50 -0
- data/docs/GetOrg200ResponseCount.md +18 -0
- data/docs/GetOrgBranding200Response.md +22 -0
- data/docs/HealthCheck200Response.md +22 -0
- data/docs/ListAddresses200Response.md +26 -0
- data/docs/ListAddresses200ResponseDataInner.md +48 -0
- data/docs/ListApiTokens200Response.md +26 -0
- data/docs/ListApiTokens200ResponseDataInner.md +32 -0
- data/docs/ListApiTokens200ResponseDataInnerCreatedBy.md +22 -0
- data/docs/ListApiTokens401Response.md +22 -0
- data/docs/ListAvailableCarriers200ResponseInner.md +38 -0
- data/docs/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md +28 -0
- data/docs/ListCarrierProductServicePoints200ResponseInner.md +32 -0
- data/docs/ListCarrierProductServicePoints200ResponseInnerAddress.md +28 -0
- data/docs/ListCarrierProductServicePointsRequest.md +28 -0
- data/docs/ListCarrierProducts200ResponseInner.md +38 -0
- data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md +30 -0
- data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md +22 -0
- data/docs/ListCarrierProducts200ResponseInnerServicesInner.md +20 -0
- data/docs/ListCarrierProducts200ResponseInnerWeightLimits.md +22 -0
- data/docs/ListCarriers200Response.md +26 -0
- data/docs/ListCarriers200ResponseDataInner.md +38 -0
- data/docs/ListCarriers200ResponseDataInnerConfigValue.md +15 -0
- data/docs/ListOrders200Response.md +26 -0
- data/docs/ListOrders200ResponseDataInner.md +40 -0
- data/docs/ListOrders200ResponseDataInnerOrderChannel.md +22 -0
- data/docs/ListOrgWebhookDeliveries200Response.md +26 -0
- data/docs/ListOrgWebhookDeliveries200ResponseDataInner.md +38 -0
- data/docs/ListOrgWebhooks200Response.md +26 -0
- data/docs/ListOrgWebhooks200ResponseDataInner.md +30 -0
- data/docs/ListShipments200Response.md +26 -0
- data/docs/ListShipments200ResponseDataInner.md +32 -0
- data/docs/ListShipments200ResponseDataInnerAddress.md +48 -0
- data/docs/ListShipments200ResponseDataInnerCarrierSettings.md +24 -0
- data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md +24 -0
- data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md +24 -0
- data/docs/ListShippingRules200Response.md +26 -0
- data/docs/ListShippingRules200ResponseDataInner.md +84 -0
- data/docs/ListShippingRules200ResponseDataInnerAdditionalParametersInner.md +20 -0
- data/docs/ListShippingRules200ResponseDataInnerCarrier.md +30 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInner.md +55 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.md +26 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.md +28 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.md +28 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.md +26 -0
- data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.md +22 -0
- data/docs/ListShippingRules200ResponseDataInnerLabelPrinter.md +20 -0
- data/docs/ListShippingRules200ResponseDataInnerReturnShippingRule.md +20 -0
- data/docs/OrdersApi.md +379 -0
- data/docs/OrgsApi.md +503 -0
- data/docs/QuotesApi.md +79 -0
- data/docs/RevokeApiToken200Response.md +18 -0
- data/docs/RulesApi.md +373 -0
- data/docs/SendShipment422Response.md +24 -0
- data/docs/SendShipment422ResponseErrorsInner.md +20 -0
- data/docs/ShipmentsApi.md +962 -0
- data/docs/SplitShipment201Response.md +20 -0
- data/docs/SplitShipmentParcel200Response.md +18 -0
- data/docs/SplitShipmentParcelRequest.md +18 -0
- data/docs/SplitShipmentParcelRequestParcelsInner.md +20 -0
- data/docs/SplitShipmentRequest.md +30 -0
- data/docs/SystemApi.md +74 -0
- data/docs/TestOrgWebhook200Response.md +18 -0
- data/docs/TokensApi.md +443 -0
- data/docs/TrackShipment200Response.md +26 -0
- data/docs/TrackShipment200ResponseEventsInner.md +28 -0
- data/docs/UpdateAddressRequest.md +40 -0
- data/docs/UpdateApiTokenRequest.md +18 -0
- data/docs/UpdateCarrierRequest.md +22 -0
- data/docs/UpdateOrderRequest.md +38 -0
- data/docs/UpdateOrg200Response.md +48 -0
- data/docs/UpdateOrgBrandingRequest.md +20 -0
- data/docs/UpdateOrgRequest.md +44 -0
- data/docs/UpdateOrgWebhookRequest.md +24 -0
- data/docs/UpdateShipmentRequest.md +44 -0
- data/docs/UpdateShippingRuleRequest.md +66 -0
- data/docs/VerifyApiToken200Response.md +28 -0
- data/docs/VerifyApiTokenRequest.md +18 -0
- data/docs/WebhooksApi.md +523 -0
- data/git_push.sh +57 -0
- data/lib/zippendo/api/addresses_api.rb +406 -0
- data/lib/zippendo/api/billing_api.rb +85 -0
- data/lib/zippendo/api/carrier_catalog_api.rb +85 -0
- data/lib/zippendo/api/carriers_api.rb +554 -0
- data/lib/zippendo/api/orders_api.rb +412 -0
- data/lib/zippendo/api/orgs_api.rb +497 -0
- data/lib/zippendo/api/quotes_api.rb +96 -0
- data/lib/zippendo/api/rules_api.rb +399 -0
- data/lib/zippendo/api/shipments_api.rb +1003 -0
- data/lib/zippendo/api/system_api.rb +79 -0
- data/lib/zippendo/api/tokens_api.rb +467 -0
- data/lib/zippendo/api/webhooks_api.rb +559 -0
- data/lib/zippendo/api_client.rb +397 -0
- data/lib/zippendo/api_error.rb +58 -0
- data/lib/zippendo/api_model_base.rb +88 -0
- data/lib/zippendo/configuration.rb +309 -0
- data/lib/zippendo/models/batch_send_shipments200_response.rb +193 -0
- data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +260 -0
- data/lib/zippendo/models/batch_send_shipments200_response_summary.rb +274 -0
- data/lib/zippendo/models/batch_send_shipments_request.rb +185 -0
- data/lib/zippendo/models/batch_split_shipment201_response.rb +193 -0
- data/lib/zippendo/models/batch_split_shipment_request.rb +247 -0
- data/lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb +186 -0
- data/lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb +210 -0
- data/lib/zippendo/models/connect_carrier_request.rb +239 -0
- data/lib/zippendo/models/create_address_request.rb +508 -0
- data/lib/zippendo/models/create_api_token201_response.rb +328 -0
- data/lib/zippendo/models/create_api_token_request.rb +267 -0
- data/lib/zippendo/models/create_order201_response.rb +491 -0
- data/lib/zippendo/models/create_order201_response_order_lines_inner.rb +533 -0
- data/lib/zippendo/models/create_order201_response_shipping_address.rb +433 -0
- data/lib/zippendo/models/create_order_request.rb +410 -0
- data/lib/zippendo/models/create_order_request_order_lines_inner.rb +533 -0
- data/lib/zippendo/models/create_order_request_shipping_address.rb +433 -0
- data/lib/zippendo/models/create_org_webhook201_response.rb +356 -0
- data/lib/zippendo/models/create_org_webhook_request.rb +268 -0
- data/lib/zippendo/models/create_shipment201_response.rb +659 -0
- data/lib/zippendo/models/create_shipment201_response_activities_inner.rb +281 -0
- data/lib/zippendo/models/create_shipment201_response_documents_inner.rb +382 -0
- data/lib/zippendo/models/create_shipment201_response_errors_inner.rb +257 -0
- data/lib/zippendo/models/create_shipment201_response_logs_inner.rb +300 -0
- data/lib/zippendo/models/create_shipment201_response_parcels_inner.rb +356 -0
- data/lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb +246 -0
- data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb +402 -0
- data/lib/zippendo/models/create_shipment201_response_parties_inner.rb +468 -0
- data/lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb +210 -0
- data/lib/zippendo/models/create_shipment201_response_pickup_details.rb +229 -0
- data/lib/zippendo/models/create_shipment201_response_shipping_rule.rb +365 -0
- data/lib/zippendo/models/create_shipment201_response_tracking.rb +204 -0
- data/lib/zippendo/models/create_shipment_request.rb +407 -0
- data/lib/zippendo/models/create_shipment_request_carrier_settings.rb +250 -0
- data/lib/zippendo/models/create_shipment_request_parcels_inner.rb +356 -0
- data/lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb +246 -0
- data/lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb +402 -0
- data/lib/zippendo/models/create_shipment_request_parties_inner.rb +451 -0
- data/lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb +210 -0
- data/lib/zippendo/models/create_shipment_request_pickup_details.rb +229 -0
- data/lib/zippendo/models/create_shipping_quote200_response.rb +167 -0
- data/lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb +333 -0
- data/lib/zippendo/models/create_shipping_quote400_response.rb +192 -0
- data/lib/zippendo/models/create_shipping_quote404_response.rb +192 -0
- data/lib/zippendo/models/create_shipping_quote_request.rb +276 -0
- data/lib/zippendo/models/create_shipping_quote_request_destination.rb +233 -0
- data/lib/zippendo/models/create_shipping_quote_request_items_inner.rb +315 -0
- data/lib/zippendo/models/create_shipping_rule201_response.rb +910 -0
- data/lib/zippendo/models/create_shipping_rule_request.rb +640 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb +104 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_inner.rb +201 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value.rb +105 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb +259 -0
- data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb +102 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb +107 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb +342 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb +359 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb +366 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb +344 -0
- data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb +270 -0
- data/lib/zippendo/models/delete_org_webhook200_response.rb +165 -0
- data/lib/zippendo/models/delete_shipping_rule200_response.rb +165 -0
- data/lib/zippendo/models/get_billing_usage200_response.rb +245 -0
- data/lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb +270 -0
- data/lib/zippendo/models/get_billing_usage200_response_current_period.rb +192 -0
- data/lib/zippendo/models/get_billing_usage200_response_limits.rb +320 -0
- data/lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb +192 -0
- data/lib/zippendo/models/get_billing_usage200_response_shipments.rb +246 -0
- data/lib/zippendo/models/get_order200_response.rb +555 -0
- data/lib/zippendo/models/get_order200_response_shipments_inner.rb +385 -0
- data/lib/zippendo/models/get_order200_response_shipping_rule.rb +365 -0
- data/lib/zippendo/models/get_org200_response.rb +440 -0
- data/lib/zippendo/models/get_org200_response_count.rb +165 -0
- data/lib/zippendo/models/get_org_branding200_response.rb +177 -0
- data/lib/zippendo/models/health_check200_response.rb +219 -0
- data/lib/zippendo/models/list_addresses200_response.rb +275 -0
- data/lib/zippendo/models/list_addresses200_response_data_inner.rb +553 -0
- data/lib/zippendo/models/list_api_tokens200_response.rb +275 -0
- data/lib/zippendo/models/list_api_tokens200_response_data_inner.rb +327 -0
- data/lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb +205 -0
- data/lib/zippendo/models/list_api_tokens401_response.rb +236 -0
- data/lib/zippendo/models/list_available_carriers200_response_inner.rb +286 -0
- data/lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb +292 -0
- data/lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb +287 -0
- data/lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb +314 -0
- data/lib/zippendo/models/list_carrier_product_service_points_request.rb +313 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner.rb +398 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb +321 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb +219 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb +192 -0
- data/lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb +244 -0
- data/lib/zippendo/models/list_carriers200_response.rb +275 -0
- data/lib/zippendo/models/list_carriers200_response_data_inner.rb +369 -0
- data/lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb +104 -0
- data/lib/zippendo/models/list_orders200_response.rb +275 -0
- data/lib/zippendo/models/list_orders200_response_data_inner.rb +423 -0
- data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +244 -0
- data/lib/zippendo/models/list_org_webhook_deliveries200_response.rb +275 -0
- data/lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb +365 -0
- data/lib/zippendo/models/list_org_webhooks200_response.rb +275 -0
- data/lib/zippendo/models/list_org_webhooks200_response_data_inner.rb +329 -0
- data/lib/zippendo/models/list_shipments200_response.rb +275 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner.rb +362 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_address.rb +553 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb +250 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb +105 -0
- data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb +259 -0
- data/lib/zippendo/models/list_shipping_rules200_response.rb +275 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner.rb +992 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_additional_parameters_inner.rb +201 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb +329 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb +107 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb +342 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb +364 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb +371 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb +344 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb +270 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb +192 -0
- data/lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb +192 -0
- data/lib/zippendo/models/revoke_api_token200_response.rb +165 -0
- data/lib/zippendo/models/send_shipment422_response.rb +265 -0
- data/lib/zippendo/models/send_shipment422_response_errors_inner.rb +175 -0
- data/lib/zippendo/models/split_shipment201_response.rb +190 -0
- data/lib/zippendo/models/split_shipment_parcel200_response.rb +164 -0
- data/lib/zippendo/models/split_shipment_parcel_request.rb +176 -0
- data/lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb +186 -0
- data/lib/zippendo/models/split_shipment_request.rb +231 -0
- data/lib/zippendo/models/test_org_webhook200_response.rb +165 -0
- data/lib/zippendo/models/track_shipment200_response.rb +251 -0
- data/lib/zippendo/models/track_shipment200_response_events_inner.rb +296 -0
- data/lib/zippendo/models/update_address_request.rb +471 -0
- data/lib/zippendo/models/update_api_token_request.rb +183 -0
- data/lib/zippendo/models/update_carrier_request.rb +208 -0
- data/lib/zippendo/models/update_order_request.rb +400 -0
- data/lib/zippendo/models/update_org200_response.rb +414 -0
- data/lib/zippendo/models/update_org_branding_request.rb +194 -0
- data/lib/zippendo/models/update_org_request.rb +389 -0
- data/lib/zippendo/models/update_org_webhook_request.rb +235 -0
- data/lib/zippendo/models/update_shipment_request.rb +394 -0
- data/lib/zippendo/models/update_shipping_rule_request.rb +531 -0
- data/lib/zippendo/models/verify_api_token200_response.rb +218 -0
- data/lib/zippendo/models/verify_api_token_request.rb +165 -0
- data/lib/zippendo/version.rb +15 -0
- data/lib/zippendo.rb +195 -0
- data/spec/api/addresses_api_spec.rb +103 -0
- data/spec/api/billing_api_spec.rb +47 -0
- data/spec/api/carrier_catalog_api_spec.rb +47 -0
- data/spec/api/carriers_api_spec.rb +130 -0
- data/spec/api/orders_api_spec.rb +105 -0
- data/spec/api/orgs_api_spec.rb +122 -0
- data/spec/api/quotes_api_spec.rb +48 -0
- data/spec/api/rules_api_spec.rb +102 -0
- data/spec/api/shipments_api_spec.rb +212 -0
- data/spec/api/system_api_spec.rb +46 -0
- data/spec/api/tokens_api_spec.rb +114 -0
- data/spec/api/webhooks_api_spec.rb +130 -0
- data/spec/models/batch_send_shipments200_response_results_inner_spec.rb +68 -0
- data/spec/models/batch_send_shipments200_response_spec.rb +42 -0
- data/spec/models/batch_send_shipments200_response_summary_spec.rb +48 -0
- data/spec/models/batch_send_shipments_request_spec.rb +36 -0
- data/spec/models/batch_split_shipment201_response_spec.rb +42 -0
- data/spec/models/batch_split_shipment_request_shipments_inner_order_lines_inner_spec.rb +42 -0
- data/spec/models/batch_split_shipment_request_shipments_inner_spec.rb +42 -0
- data/spec/models/batch_split_shipment_request_spec.rb +66 -0
- data/spec/models/connect_carrier_request_spec.rb +48 -0
- data/spec/models/create_address_request_spec.rb +106 -0
- data/spec/models/create_api_token201_response_spec.rb +78 -0
- data/spec/models/create_api_token_request_spec.rb +52 -0
- data/spec/models/create_order201_response_order_lines_inner_spec.rb +148 -0
- data/spec/models/create_order201_response_shipping_address_spec.rb +108 -0
- data/spec/models/create_order201_response_spec.rb +142 -0
- data/spec/models/create_order_request_order_lines_inner_spec.rb +148 -0
- data/spec/models/create_order_request_shipping_address_spec.rb +108 -0
- data/spec/models/create_order_request_spec.rb +102 -0
- data/spec/models/create_org_webhook201_response_spec.rb +78 -0
- data/spec/models/create_org_webhook_request_spec.rb +58 -0
- data/spec/models/create_shipment201_response_activities_inner_spec.rb +64 -0
- data/spec/models/create_shipment201_response_documents_inner_spec.rb +90 -0
- data/spec/models/create_shipment201_response_errors_inner_spec.rb +60 -0
- data/spec/models/create_shipment201_response_logs_inner_spec.rb +82 -0
- data/spec/models/create_shipment201_response_parcels_inner_dimensions_spec.rb +48 -0
- data/spec/models/create_shipment201_response_parcels_inner_order_lines_inner_spec.rb +90 -0
- data/spec/models/create_shipment201_response_parcels_inner_spec.rb +100 -0
- data/spec/models/create_shipment201_response_parties_inner_attributes_inner_spec.rb +42 -0
- data/spec/models/create_shipment201_response_parties_inner_spec.rb +100 -0
- data/spec/models/create_shipment201_response_pickup_details_spec.rb +54 -0
- data/spec/models/create_shipment201_response_shipping_rule_spec.rb +102 -0
- data/spec/models/create_shipment201_response_spec.rb +182 -0
- data/spec/models/create_shipment201_response_tracking_spec.rb +66 -0
- data/spec/models/create_shipment_request_carrier_settings_spec.rb +54 -0
- data/spec/models/create_shipment_request_parcels_inner_dimensions_spec.rb +48 -0
- data/spec/models/create_shipment_request_parcels_inner_order_lines_inner_spec.rb +90 -0
- data/spec/models/create_shipment_request_parcels_inner_spec.rb +100 -0
- data/spec/models/create_shipment_request_parties_inner_attributes_inner_spec.rb +42 -0
- data/spec/models/create_shipment_request_parties_inner_spec.rb +100 -0
- data/spec/models/create_shipment_request_pickup_details_spec.rb +54 -0
- data/spec/models/create_shipment_request_spec.rb +116 -0
- data/spec/models/create_shipping_quote200_response_rates_inner_spec.rb +96 -0
- data/spec/models/create_shipping_quote200_response_spec.rb +36 -0
- data/spec/models/create_shipping_quote400_response_spec.rb +42 -0
- data/spec/models/create_shipping_quote404_response_spec.rb +42 -0
- data/spec/models/create_shipping_quote_request_destination_spec.rb +66 -0
- data/spec/models/create_shipping_quote_request_items_inner_spec.rb +72 -0
- data/spec/models/create_shipping_quote_request_spec.rb +54 -0
- data/spec/models/create_shipping_rule201_response_spec.rb +208 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_inner_spec.rb +42 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner_spec.rb +21 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_spec.rb +54 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_spec.rb +21 -0
- data/spec/models/create_shipping_rule_request_additional_parameters_spec.rb +21 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of1_spec.rb +78 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of2_spec.rb +74 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of3_spec.rb +68 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of4_spec.rb +52 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_one_of_spec.rb +64 -0
- data/spec/models/create_shipping_rule_request_conditions_inner_spec.rb +32 -0
- data/spec/models/create_shipping_rule_request_spec.rb +184 -0
- data/spec/models/delete_org_webhook200_response_spec.rb +36 -0
- data/spec/models/delete_shipping_rule200_response_spec.rb +36 -0
- data/spec/models/get_billing_usage200_response_add_ons_inner_spec.rb +58 -0
- data/spec/models/get_billing_usage200_response_current_period_spec.rb +42 -0
- data/spec/models/get_billing_usage200_response_limits_spec.rb +72 -0
- data/spec/models/get_billing_usage200_response_limits_team_members_spec.rb +42 -0
- data/spec/models/get_billing_usage200_response_shipments_spec.rb +54 -0
- data/spec/models/get_billing_usage200_response_spec.rb +54 -0
- data/spec/models/get_order200_response_shipments_inner_spec.rb +98 -0
- data/spec/models/get_order200_response_shipping_rule_spec.rb +102 -0
- data/spec/models/get_order200_response_spec.rb +160 -0
- data/spec/models/get_org200_response_count_spec.rb +36 -0
- data/spec/models/get_org200_response_spec.rb +132 -0
- data/spec/models/get_org_branding200_response_spec.rb +48 -0
- data/spec/models/health_check200_response_spec.rb +48 -0
- data/spec/models/list_addresses200_response_data_inner_spec.rb +130 -0
- data/spec/models/list_addresses200_response_spec.rb +60 -0
- data/spec/models/list_api_tokens200_response_data_inner_created_by_spec.rb +48 -0
- data/spec/models/list_api_tokens200_response_data_inner_spec.rb +78 -0
- data/spec/models/list_api_tokens200_response_spec.rb +60 -0
- data/spec/models/list_api_tokens401_response_spec.rb +52 -0
- data/spec/models/list_available_carriers200_response_inner_required_fields_inner_spec.rb +70 -0
- data/spec/models/list_available_carriers200_response_inner_spec.rb +96 -0
- data/spec/models/list_carrier_product_service_points200_response_inner_address_spec.rb +66 -0
- data/spec/models/list_carrier_product_service_points200_response_inner_spec.rb +78 -0
- data/spec/models/list_carrier_product_service_points_request_spec.rb +66 -0
- data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner_spec.rb +48 -0
- data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_spec.rb +76 -0
- data/spec/models/list_carrier_products200_response_inner_services_inner_spec.rb +42 -0
- data/spec/models/list_carrier_products200_response_inner_spec.rb +100 -0
- data/spec/models/list_carrier_products200_response_inner_weight_limits_spec.rb +52 -0
- data/spec/models/list_carriers200_response_data_inner_config_value_spec.rb +21 -0
- data/spec/models/list_carriers200_response_data_inner_spec.rb +96 -0
- data/spec/models/list_carriers200_response_spec.rb +60 -0
- data/spec/models/list_orders200_response_data_inner_order_channel_spec.rb +52 -0
- data/spec/models/list_orders200_response_data_inner_spec.rb +106 -0
- data/spec/models/list_orders200_response_spec.rb +60 -0
- data/spec/models/list_org_webhook_deliveries200_response_data_inner_spec.rb +96 -0
- data/spec/models/list_org_webhook_deliveries200_response_spec.rb +60 -0
- data/spec/models/list_org_webhooks200_response_data_inner_spec.rb +72 -0
- data/spec/models/list_org_webhooks200_response_spec.rb +60 -0
- data/spec/models/list_shipments200_response_data_inner_address_spec.rb +130 -0
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of_spec.rb +54 -0
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_spec.rb +21 -0
- data/spec/models/list_shipments200_response_data_inner_carrier_settings_spec.rb +54 -0
- data/spec/models/list_shipments200_response_data_inner_spec.rb +86 -0
- data/spec/models/list_shipments200_response_spec.rb +60 -0
- data/spec/models/list_shipping_rules200_response_data_inner_additional_parameters_inner_spec.rb +42 -0
- data/spec/models/list_shipping_rules200_response_data_inner_carrier_spec.rb +72 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1_spec.rb +78 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2_spec.rb +74 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3_spec.rb +68 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4_spec.rb +52 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of_spec.rb +64 -0
- data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_spec.rb +32 -0
- data/spec/models/list_shipping_rules200_response_data_inner_label_printer_spec.rb +42 -0
- data/spec/models/list_shipping_rules200_response_data_inner_return_shipping_rule_spec.rb +42 -0
- data/spec/models/list_shipping_rules200_response_data_inner_spec.rb +238 -0
- data/spec/models/list_shipping_rules200_response_spec.rb +60 -0
- data/spec/models/revoke_api_token200_response_spec.rb +36 -0
- data/spec/models/send_shipment422_response_errors_inner_spec.rb +42 -0
- data/spec/models/send_shipment422_response_spec.rb +58 -0
- data/spec/models/split_shipment201_response_spec.rb +42 -0
- data/spec/models/split_shipment_parcel200_response_spec.rb +36 -0
- data/spec/models/split_shipment_parcel_request_parcels_inner_spec.rb +42 -0
- data/spec/models/split_shipment_parcel_request_spec.rb +36 -0
- data/spec/models/split_shipment_request_spec.rb +72 -0
- data/spec/models/test_org_webhook200_response_spec.rb +36 -0
- data/spec/models/track_shipment200_response_events_inner_spec.rb +70 -0
- data/spec/models/track_shipment200_response_spec.rb +64 -0
- data/spec/models/update_address_request_spec.rb +106 -0
- data/spec/models/update_api_token_request_spec.rb +36 -0
- data/spec/models/update_carrier_request_spec.rb +48 -0
- data/spec/models/update_order_request_spec.rb +100 -0
- data/spec/models/update_org200_response_spec.rb +126 -0
- data/spec/models/update_org_branding_request_spec.rb +42 -0
- data/spec/models/update_org_request_spec.rb +118 -0
- data/spec/models/update_org_webhook_request_spec.rb +58 -0
- data/spec/models/update_shipment_request_spec.rb +122 -0
- data/spec/models/update_shipping_rule_request_spec.rb +184 -0
- data/spec/models/verify_api_token200_response_spec.rb +66 -0
- data/spec/models/verify_api_token_request_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- data/zippendo.gemspec +39 -0
- metadata +715 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Display label for the option | |
|
|
8
|
+
| **key** | **String** | Machine key for the option | |
|
|
9
|
+
| **value** | **String** | Value submitted when the option is selected | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.new(
|
|
17
|
+
name: Standard,
|
|
18
|
+
key: standard,
|
|
19
|
+
value: STD
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProducts200ResponseInnerServicesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Display name of the additional service | |
|
|
8
|
+
| **service_id** | **String** | Unique service identifier | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zippendo'
|
|
14
|
+
|
|
15
|
+
instance = Zippendo::ListCarrierProducts200ResponseInnerServicesInner.new(
|
|
16
|
+
name: Flex delivery,
|
|
17
|
+
service_id: A6
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::ListCarrierProducts200ResponseInnerWeightLimits
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **min** | **Float** | Minimum allowed parcel weight | |
|
|
8
|
+
| **max** | **Float** | Maximum allowed parcel weight | |
|
|
9
|
+
| **unit** | **String** | Unit of the weight limits | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::ListCarrierProducts200ResponseInnerWeightLimits.new(
|
|
17
|
+
min: 0.1,
|
|
18
|
+
max: 35,
|
|
19
|
+
unit: kg
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListCarriers200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListCarriers200ResponseDataInner>**](ListCarriers200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListCarriers200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Zippendo::ListCarriers200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique carrier identifier | |
|
|
8
|
+
| **name** | **String** | Carrier display name | |
|
|
9
|
+
| **carrier_slug** | **String** | Carrier slug identifier | |
|
|
10
|
+
| **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) | |
|
|
11
|
+
| **org_id** | **String** | Owning organization ID | |
|
|
12
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
13
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
14
|
+
| **logo** | **String** | Carrier logo URL | [optional] |
|
|
15
|
+
| **brand_color** | **String** | Carrier brand color (hex) | [optional] |
|
|
16
|
+
| **deprecated** | **Boolean** | Whether this carrier integration is deprecated (still works, but discouraged) | [optional] |
|
|
17
|
+
| **deprecation_message** | **String** | Guidance shown alongside the deprecated tag (e.g. what to migrate to) | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'zippendo'
|
|
23
|
+
|
|
24
|
+
instance = Zippendo::ListCarriers200ResponseDataInner.new(
|
|
25
|
+
id: carr_01HZX9K2QF,
|
|
26
|
+
name: PostNord,
|
|
27
|
+
carrier_slug: postnord,
|
|
28
|
+
config: {"customerNumber":"123456"},
|
|
29
|
+
org_id: org_01HZX9K2QF,
|
|
30
|
+
created_at: 2026-06-22T09:00:00.000Z,
|
|
31
|
+
updated_at: 2026-06-22T09:00:00.000Z,
|
|
32
|
+
logo: https://cdn.zippendo.com/logos/postnord.svg,
|
|
33
|
+
brand_color: #005BAA,
|
|
34
|
+
deprecated: true,
|
|
35
|
+
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Zippendo::ListCarriers200ResponseDataInnerConfigValue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'zippendo'
|
|
12
|
+
|
|
13
|
+
instance = Zippendo::ListCarriers200ResponseDataInnerConfigValue.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListOrders200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListOrders200ResponseDataInner>**](ListOrders200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListOrders200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Zippendo::ListOrders200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique order ID. | |
|
|
8
|
+
| **order_number** | **String** | Human-readable order number. | |
|
|
9
|
+
| **customer_name** | **String** | Customer full name. | [optional] |
|
|
10
|
+
| **customer_email** | **String** | Customer email address. | [optional] |
|
|
11
|
+
| **status** | **String** | Order fulfilment status derived from its shipments. | |
|
|
12
|
+
| **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
|
|
13
|
+
| **total_amount** | **Float** | Order grand total. | [optional] |
|
|
14
|
+
| **currency** | **String** | ISO 4217 currency code. | [optional] |
|
|
15
|
+
| **shipment_count** | **Integer** | Number of shipments created for the order. | |
|
|
16
|
+
| **order_channel** | [**ListOrders200ResponseDataInnerOrderChannel**](ListOrders200ResponseDataInnerOrderChannel.md) | | |
|
|
17
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601). | |
|
|
18
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601). | |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'zippendo'
|
|
24
|
+
|
|
25
|
+
instance = Zippendo::ListOrders200ResponseDataInner.new(
|
|
26
|
+
id: clz9k2f0a0003abcd9012mnop,
|
|
27
|
+
order_number: #1042,
|
|
28
|
+
customer_name: Anna Jensen,
|
|
29
|
+
customer_email: anna@example.dk,
|
|
30
|
+
status: processing,
|
|
31
|
+
subtotal_amount: 998,
|
|
32
|
+
total_amount: 1047,
|
|
33
|
+
currency: DKK,
|
|
34
|
+
shipment_count: 1,
|
|
35
|
+
order_channel: null,
|
|
36
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
37
|
+
updated_at: 2026-06-22T14:30:00.000Z
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::ListOrders200ResponseDataInnerOrderChannel
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Order channel ID. | |
|
|
8
|
+
| **name** | **String** | Order channel name. | |
|
|
9
|
+
| **type** | **String** | Type of the order channel (sales platform). | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::ListOrders200ResponseDataInnerOrderChannel.new(
|
|
17
|
+
id: clz9k2f0a0001abcd1234efgh,
|
|
18
|
+
name: Anna's Shopify Store,
|
|
19
|
+
type: shopify
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListOrgWebhookDeliveries200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListOrgWebhookDeliveries200ResponseDataInner>**](ListOrgWebhookDeliveries200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListOrgWebhookDeliveries200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Zippendo::ListOrgWebhookDeliveries200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Delivery log ID | |
|
|
8
|
+
| **webhook_id** | **String** | ID of the webhook this delivery belongs to | |
|
|
9
|
+
| **event** | **String** | Event type that was delivered | |
|
|
10
|
+
| **payload** | **Object** | JSON payload that was sent | |
|
|
11
|
+
| **status_code** | **Float** | HTTP status code returned by the endpoint | |
|
|
12
|
+
| **response** | **String** | Response body returned by the endpoint | |
|
|
13
|
+
| **duration** | **Float** | Request duration in milliseconds | |
|
|
14
|
+
| **success** | **Boolean** | Whether the delivery succeeded | |
|
|
15
|
+
| **attempt** | **Float** | Delivery attempt number | |
|
|
16
|
+
| **error** | **String** | Error message if the delivery failed | |
|
|
17
|
+
| **created_at** | **String** | Delivery timestamp (ISO 8601) | |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'zippendo'
|
|
23
|
+
|
|
24
|
+
instance = Zippendo::ListOrgWebhookDeliveries200ResponseDataInner.new(
|
|
25
|
+
id: whd_clx9z8y7x6,
|
|
26
|
+
webhook_id: wh_clx1a2b3c4,
|
|
27
|
+
event: shipment.created,
|
|
28
|
+
payload: {"id":"shp_123"},
|
|
29
|
+
status_code: 200,
|
|
30
|
+
response: OK,
|
|
31
|
+
duration: 142,
|
|
32
|
+
success: true,
|
|
33
|
+
attempt: 1,
|
|
34
|
+
error: null,
|
|
35
|
+
created_at: 2026-06-10T11:16:00.000Z
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListOrgWebhooks200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListOrgWebhooks200ResponseDataInner>**](ListOrgWebhooks200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListOrgWebhooks200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Zippendo::ListOrgWebhooks200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Webhook ID | |
|
|
8
|
+
| **name** | **String** | Human-readable webhook name | |
|
|
9
|
+
| **url** | **String** | Webhook endpoint URL | |
|
|
10
|
+
| **events** | **Array<String>** | Events the webhook is subscribed to | |
|
|
11
|
+
| **is_active** | **Boolean** | Whether the webhook is active | |
|
|
12
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
13
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'zippendo'
|
|
19
|
+
|
|
20
|
+
instance = Zippendo::ListOrgWebhooks200ResponseDataInner.new(
|
|
21
|
+
id: wh_clx1a2b3c4,
|
|
22
|
+
name: Order fulfilment notifier,
|
|
23
|
+
url: https://hooks.example.dk/zippendo,
|
|
24
|
+
events: ["shipment.created"],
|
|
25
|
+
is_active: true,
|
|
26
|
+
created_at: 2026-06-01T09:30:00.000Z,
|
|
27
|
+
updated_at: 2026-06-10T11:15:00.000Z
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListShipments200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListShipments200ResponseDataInner>**](ListShipments200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListShipments200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Zippendo::ListShipments200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique shipment identifier. | |
|
|
8
|
+
| **reference** | **String** | Customer-facing shipment reference. | |
|
|
9
|
+
| **type** | **String** | Direction of the shipment relative to the organization. | |
|
|
10
|
+
| **carrier_settings** | [**ListShipments200ResponseDataInnerCarrierSettings**](ListShipments200ResponseDataInnerCarrierSettings.md) | | |
|
|
11
|
+
| **status** | **String** | Lifecycle status of the shipment. | |
|
|
12
|
+
| **address** | [**ListShipments200ResponseDataInnerAddress**](ListShipments200ResponseDataInnerAddress.md) | | [optional] |
|
|
13
|
+
| **created_at** | **String** | Timestamp when the shipment was created. | |
|
|
14
|
+
| **updated_at** | **String** | Timestamp when the shipment was last updated. | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'zippendo'
|
|
20
|
+
|
|
21
|
+
instance = Zippendo::ListShipments200ResponseDataInner.new(
|
|
22
|
+
id: shp_4d9e7a2f,
|
|
23
|
+
reference: ORDER-1042,
|
|
24
|
+
type: outbound,
|
|
25
|
+
carrier_settings: null,
|
|
26
|
+
status: pending,
|
|
27
|
+
address: null,
|
|
28
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
29
|
+
updated_at: 2026-06-22T14:30:00.000Z
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Zippendo::ListShipments200ResponseDataInnerAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique address identifier | |
|
|
8
|
+
| **name** | **String** | Name of the address | |
|
|
9
|
+
| **att_contact** | **String** | Attention contact person | |
|
|
10
|
+
| **address1** | **String** | Address line 1 | |
|
|
11
|
+
| **address2** | **String** | Address line 2 | |
|
|
12
|
+
| **zipcode** | **String** | Postal/ZIP code | |
|
|
13
|
+
| **city** | **String** | City | |
|
|
14
|
+
| **phone** | **String** | Phone number | |
|
|
15
|
+
| **country_code** | **String** | ISO country code | |
|
|
16
|
+
| **state** | **String** | State/Province | |
|
|
17
|
+
| **email** | **String** | Email address | |
|
|
18
|
+
| **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
|
|
19
|
+
| **address_types** | **Array<String>** | Address types (sender, pickup, return) | |
|
|
20
|
+
| **org_id** | **String** | Owning organization ID | |
|
|
21
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
22
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'zippendo'
|
|
28
|
+
|
|
29
|
+
instance = Zippendo::ListShipments200ResponseDataInnerAddress.new(
|
|
30
|
+
id: addr_01HZX9K2QF,
|
|
31
|
+
name: Hovedlager,
|
|
32
|
+
att_contact: Mette Hansen,
|
|
33
|
+
address1: Vesterbrogade 1,
|
|
34
|
+
address2: 2. sal,
|
|
35
|
+
zipcode: 1620,
|
|
36
|
+
city: København,
|
|
37
|
+
phone: +4533123456,
|
|
38
|
+
country_code: DK,
|
|
39
|
+
state: null,
|
|
40
|
+
email: lager@example.dk,
|
|
41
|
+
customs: {"eori":"DK12345678"},
|
|
42
|
+
address_types: ["sender"],
|
|
43
|
+
org_id: org_01HZX9K2QF,
|
|
44
|
+
created_at: 2026-06-22T09:00:00.000Z,
|
|
45
|
+
updated_at: 2026-06-22T09:00:00.000Z
|
|
46
|
+
)
|
|
47
|
+
```
|
|
48
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zippendo::ListShipments200ResponseDataInnerCarrierSettings
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **carrier_id** | **String** | Identifier of the carrier to use. | |
|
|
8
|
+
| **product_id** | **String** | Identifier of the carrier product/service. | |
|
|
9
|
+
| **services** | **Array<String>** | Additional service codes requested from the carrier. | |
|
|
10
|
+
| **additional_parameters** | [**Hash<String, ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue>**](ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md) | Carrier-specific extra parameters as key/value pairs. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zippendo'
|
|
16
|
+
|
|
17
|
+
instance = Zippendo::ListShipments200ResponseDataInnerCarrierSettings.new(
|
|
18
|
+
carrier_id: car_pn_001,
|
|
19
|
+
product_id: prod_mypack_home,
|
|
20
|
+
services: ["A7"],
|
|
21
|
+
additional_parameters: {"notificationEmail":"anna@example.dk"}
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Identifier of the selected service point. | |
|
|
8
|
+
| **name** | **String** | Display name of the service point. | |
|
|
9
|
+
| **address** | **String** | Formatted address of the service point. | |
|
|
10
|
+
| **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zippendo'
|
|
16
|
+
|
|
17
|
+
instance = Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.new(
|
|
18
|
+
id: sp_pn_4521,
|
|
19
|
+
name: Føtex Nørrebro,
|
|
20
|
+
address: Nørrebrogade 20, 2200 København N,
|
|
21
|
+
coordinates: [55.6987, 12.5501]
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Identifier of the selected service point. | |
|
|
8
|
+
| **name** | **String** | Display name of the service point. | |
|
|
9
|
+
| **address** | **String** | Formatted address of the service point. | |
|
|
10
|
+
| **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zippendo'
|
|
16
|
+
|
|
17
|
+
instance = Zippendo::ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.new(
|
|
18
|
+
id: sp_pn_4521,
|
|
19
|
+
name: Føtex Nørrebro,
|
|
20
|
+
address: Nørrebrogade 20, 2200 København N,
|
|
21
|
+
coordinates: [55.6987,12.5501]
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListShippingRules200ResponseDataInner>**](ListShippingRules200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListShippingRules200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Zippendo::ListShippingRules200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique shipping rule identifier | |
|
|
8
|
+
| **name** | **String** | Shipping rule name | |
|
|
9
|
+
| **description** | **String** | Optional description | |
|
|
10
|
+
| **direction** | **String** | Whether this rule is for outbound or inbound (return) shipments | [default to 'outbound'] |
|
|
11
|
+
| **carrier_id** | **String** | Carrier ID | |
|
|
12
|
+
| **product_id** | **String** | Product ID from carrier | |
|
|
13
|
+
| **services** | **Array<String>** | List of selected services | |
|
|
14
|
+
| **additional_parameters** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersInner.md) | Carrier-specific extra parameters. DEPRECATED array form `[{ name, val }]` where `name` is the carrier parameter `key` (from the product's `additionalParameters[].key`, e.g. `returnFunctionality`) and `val` is the stringified value. This will change to a `{ key: value }` object in a future version — writes already accept either shape. | |
|
|
15
|
+
| **address_id** | **String** | Sender address ID | |
|
|
16
|
+
| **receiving_countries** | **Array<String>** | List of supported country codes | |
|
|
17
|
+
| **email_notification** | **Boolean** | Send email notification to recipient | [default to false] |
|
|
18
|
+
| **phone_notification** | **Boolean** | Send SMS notification to recipient | [default to false] |
|
|
19
|
+
| **min_weight** | **Float** | Minimum required weight in kg. Orders below this are excluded from the rule. | |
|
|
20
|
+
| **max_weight** | **Float** | Maximum allowed weight in kg. Orders exceeding this are excluded from the rule. | |
|
|
21
|
+
| **min_order_value** | **Float** | Minimum required order value in currency units. Orders below this are excluded from the rule. | |
|
|
22
|
+
| **max_order_value** | **Float** | Maximum allowed order value in currency units. Orders exceeding this are excluded from the rule. | |
|
|
23
|
+
| **conditions** | [**Array<ListShippingRules200ResponseDataInnerConditionsInner>**](ListShippingRules200ResponseDataInnerConditionsInner.md) | Rule conditions (weight/price/quantity) | |
|
|
24
|
+
| **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [default to false] |
|
|
25
|
+
| **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [default to false] |
|
|
26
|
+
| **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [default to false] |
|
|
27
|
+
| **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [default to false] |
|
|
28
|
+
| **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [default to false] |
|
|
29
|
+
| **label_printer_id** | **String** | ID of the label printer | |
|
|
30
|
+
| **document_printer_id** | **String** | ID of the document printer | |
|
|
31
|
+
| **return_shipping_rule_id** | **String** | ID of the return shipping rule | |
|
|
32
|
+
| **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [default to false] |
|
|
33
|
+
| **org_id** | **String** | Owning organization ID | |
|
|
34
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601) | |
|
|
35
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601) | |
|
|
36
|
+
| **carrier** | [**ListShippingRules200ResponseDataInnerCarrier**](ListShippingRules200ResponseDataInnerCarrier.md) | | |
|
|
37
|
+
| **address** | [**ListAddresses200ResponseDataInner**](ListAddresses200ResponseDataInner.md) | | |
|
|
38
|
+
| **label_printer** | [**ListShippingRules200ResponseDataInnerLabelPrinter**](ListShippingRules200ResponseDataInnerLabelPrinter.md) | | [optional] |
|
|
39
|
+
| **document_printer** | [**ListShippingRules200ResponseDataInnerLabelPrinter**](ListShippingRules200ResponseDataInnerLabelPrinter.md) | | [optional] |
|
|
40
|
+
| **return_shipping_rule** | [**ListShippingRules200ResponseDataInnerReturnShippingRule**](ListShippingRules200ResponseDataInnerReturnShippingRule.md) | | [optional] |
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
```ruby
|
|
45
|
+
require 'zippendo'
|
|
46
|
+
|
|
47
|
+
instance = Zippendo::ListShippingRules200ResponseDataInner.new(
|
|
48
|
+
id: rule_01HZX9K2QF,
|
|
49
|
+
name: Standard DK,
|
|
50
|
+
description: Standard levering i Danmark,
|
|
51
|
+
direction: outbound,
|
|
52
|
+
carrier_id: carr_01HZX9K2QF,
|
|
53
|
+
product_id: PNL13,
|
|
54
|
+
services: ["EMAIL_NOTIFICATION"],
|
|
55
|
+
additional_parameters: [{"name":"returnFunctionality","val":"LABELLESS"}],
|
|
56
|
+
address_id: addr_01HZX9K2QF,
|
|
57
|
+
receiving_countries: ["DK","SE"],
|
|
58
|
+
email_notification: true,
|
|
59
|
+
phone_notification: false,
|
|
60
|
+
min_weight: 0,
|
|
61
|
+
max_weight: 20,
|
|
62
|
+
min_order_value: 0,
|
|
63
|
+
max_order_value: 5000,
|
|
64
|
+
conditions: [{"type":"flatRate","shippingPrice":39,"currency":"DKK"}],
|
|
65
|
+
generate_proforma_invoice: false,
|
|
66
|
+
generate_commercial_invoice: false,
|
|
67
|
+
generate_packing_list: false,
|
|
68
|
+
auto_print_labels: false,
|
|
69
|
+
auto_print_documents: false,
|
|
70
|
+
label_printer_id: null,
|
|
71
|
+
document_printer_id: null,
|
|
72
|
+
return_shipping_rule_id: null,
|
|
73
|
+
auto_create_return_shipment: false,
|
|
74
|
+
org_id: org_01HZX9K2QF,
|
|
75
|
+
created_at: 2026-06-22T09:00:00.000Z,
|
|
76
|
+
updated_at: 2026-06-22T09:00:00.000Z,
|
|
77
|
+
carrier: null,
|
|
78
|
+
address: null,
|
|
79
|
+
label_printer: null,
|
|
80
|
+
document_printer: null,
|
|
81
|
+
return_shipping_rule: null
|
|
82
|
+
)
|
|
83
|
+
```
|
|
84
|
+
|