@zippendo/sdk 1.0.3 → 1.1.1
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.
- package/README.md +31 -7
- package/dist/apis/AddressesApi.d.ts +1 -1
- package/dist/apis/AddressesApi.js +1 -1
- package/dist/apis/BillingApi.d.ts +1 -1
- package/dist/apis/BillingApi.js +1 -1
- package/dist/apis/BrandsApi.d.ts +204 -0
- package/dist/apis/BrandsApi.js +584 -0
- package/dist/apis/CarrierCatalogApi.d.ts +1 -1
- package/dist/apis/CarrierCatalogApi.js +1 -1
- package/dist/apis/CarriersApi.d.ts +1 -1
- package/dist/apis/CarriersApi.js +1 -1
- package/dist/apis/OrdersApi.d.ts +1 -1
- package/dist/apis/OrdersApi.js +1 -1
- package/dist/apis/OrgsApi.d.ts +1 -1
- package/dist/apis/OrgsApi.js +1 -1
- package/dist/apis/QuotesApi.d.ts +1 -1
- package/dist/apis/QuotesApi.js +1 -1
- package/dist/apis/RulesApi.d.ts +1 -1
- package/dist/apis/RulesApi.js +1 -1
- package/dist/apis/ShipmentsApi.d.ts +1 -1
- package/dist/apis/ShipmentsApi.js +1 -1
- package/dist/apis/SystemApi.d.ts +1 -1
- package/dist/apis/SystemApi.js +1 -1
- package/dist/apis/TokensApi.d.ts +1 -1
- package/dist/apis/TokensApi.js +1 -1
- package/dist/apis/WebhooksApi.d.ts +1 -1
- package/dist/apis/WebhooksApi.js +1 -1
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AddressesApi.d.ts +1 -1
- package/dist/esm/apis/AddressesApi.js +1 -1
- package/dist/esm/apis/BillingApi.d.ts +1 -1
- package/dist/esm/apis/BillingApi.js +1 -1
- package/dist/esm/apis/BrandsApi.d.ts +204 -0
- package/dist/esm/apis/BrandsApi.js +580 -0
- package/dist/esm/apis/CarrierCatalogApi.d.ts +1 -1
- package/dist/esm/apis/CarrierCatalogApi.js +1 -1
- package/dist/esm/apis/CarriersApi.d.ts +1 -1
- package/dist/esm/apis/CarriersApi.js +1 -1
- package/dist/esm/apis/OrdersApi.d.ts +1 -1
- package/dist/esm/apis/OrdersApi.js +1 -1
- package/dist/esm/apis/OrgsApi.d.ts +1 -1
- package/dist/esm/apis/OrgsApi.js +1 -1
- package/dist/esm/apis/QuotesApi.d.ts +1 -1
- package/dist/esm/apis/QuotesApi.js +1 -1
- package/dist/esm/apis/RulesApi.d.ts +1 -1
- package/dist/esm/apis/RulesApi.js +1 -1
- package/dist/esm/apis/ShipmentsApi.d.ts +1 -1
- package/dist/esm/apis/ShipmentsApi.js +1 -1
- package/dist/esm/apis/SystemApi.d.ts +1 -1
- package/dist/esm/apis/SystemApi.js +1 -1
- package/dist/esm/apis/TokensApi.d.ts +1 -1
- package/dist/esm/apis/TokensApi.js +1 -1
- package/dist/esm/apis/WebhooksApi.d.ts +1 -1
- package/dist/esm/apis/WebhooksApi.js +1 -1
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/BatchSendShipments200Response.d.ts +1 -1
- package/dist/esm/models/BatchSendShipments200Response.js +1 -1
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -1
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +1 -1
- package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
- package/dist/esm/models/BatchSendShipments200ResponseSummary.js +1 -1
- package/dist/esm/models/BatchSendShipmentsRequest.d.ts +1 -1
- package/dist/esm/models/BatchSendShipmentsRequest.js +1 -1
- package/dist/esm/models/BatchSplitShipment201Response.d.ts +1 -1
- package/dist/esm/models/BatchSplitShipment201Response.js +1 -1
- package/dist/esm/models/BatchSplitShipmentRequest.d.ts +5 -4
- package/dist/esm/models/BatchSplitShipmentRequest.js +5 -3
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInner.d.ts +1 -1
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInner.js +1 -1
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.js +1 -1
- package/dist/{models/CreateShippingRuleRequestAdditionalParametersAnyOfInner.d.ts → esm/models/CheckBrandSlug200Response.d.ts} +16 -16
- package/dist/esm/models/{CreateShippingRuleRequestAdditionalParametersAnyOfInner.js → CheckBrandSlug200Response.js} +15 -15
- package/dist/esm/models/ConnectCarrierRequest.d.ts +1 -1
- package/dist/esm/models/ConnectCarrierRequest.js +1 -1
- package/dist/esm/models/CreateAddressRequest.d.ts +1 -1
- package/dist/esm/models/CreateAddressRequest.js +1 -1
- package/dist/esm/models/CreateApiToken201Response.d.ts +1 -1
- package/dist/esm/models/CreateApiToken201Response.js +1 -1
- package/dist/esm/models/CreateApiTokenRequest.d.ts +1 -1
- package/dist/esm/models/CreateApiTokenRequest.js +1 -1
- package/dist/esm/models/CreateOrder201Response.d.ts +1 -1
- package/dist/esm/models/CreateOrder201Response.js +1 -1
- package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateOrder201ResponseShippingAddress.d.ts +1 -1
- package/dist/esm/models/CreateOrder201ResponseShippingAddress.js +1 -1
- package/dist/esm/models/CreateOrderRequest.d.ts +1 -1
- package/dist/esm/models/CreateOrderRequest.js +1 -1
- package/dist/esm/models/CreateOrderRequestOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateOrderRequestOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateOrderRequestShippingAddress.d.ts +1 -1
- package/dist/esm/models/CreateOrderRequestShippingAddress.js +1 -1
- package/dist/esm/models/CreateOrgBrandRequest.d.ts +106 -0
- package/dist/esm/models/CreateOrgBrandRequest.js +67 -0
- package/dist/esm/models/CreateOrgWebhook201Response.d.ts +1 -1
- package/dist/esm/models/CreateOrgWebhook201Response.js +1 -1
- package/dist/esm/models/CreateOrgWebhookRequest.d.ts +1 -1
- package/dist/esm/models/CreateOrgWebhookRequest.js +1 -1
- package/dist/esm/models/CreateShipment201Response.d.ts +1 -1
- package/dist/esm/models/CreateShipment201Response.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseActivitiesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseActivitiesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseDocumentsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseDocumentsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseErrorsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseErrorsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseLogsInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseLogsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInner.d.ts +3 -3
- package/dist/esm/models/CreateShipment201ResponseParcelsInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerDimensions.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerDimensions.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInnerAttributesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponsePartiesInnerAttributesInner.js +1 -1
- package/dist/esm/models/CreateShipment201ResponsePickupDetails.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponsePickupDetails.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseShippingRule.d.ts +1 -1
- package/dist/esm/models/CreateShipment201ResponseShippingRule.js +1 -1
- package/dist/esm/models/CreateShipment201ResponseTracking.d.ts +3 -3
- package/dist/esm/models/CreateShipment201ResponseTracking.js +1 -1
- package/dist/esm/models/CreateShipmentRequest.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequest.js +1 -1
- package/dist/esm/models/CreateShipmentRequestCarrierSettings.d.ts +4 -4
- package/dist/esm/models/CreateShipmentRequestCarrierSettings.js +4 -4
- package/dist/esm/models/CreateShipmentRequestParcelsInner.d.ts +3 -3
- package/dist/esm/models/CreateShipmentRequestParcelsInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerDimensions.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerDimensions.js +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInnerAttributesInner.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestPartiesInnerAttributesInner.js +1 -1
- package/dist/esm/models/CreateShipmentRequestPickupDetails.d.ts +1 -1
- package/dist/esm/models/CreateShipmentRequestPickupDetails.js +1 -1
- package/dist/esm/models/CreateShippingQuote200Response.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote200Response.js +1 -1
- package/dist/esm/models/CreateShippingQuote200ResponseRatesInner.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote200ResponseRatesInner.js +1 -1
- package/dist/esm/models/CreateShippingQuote400Response.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote400Response.js +1 -1
- package/dist/esm/models/CreateShippingQuote404Response.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuote404Response.js +1 -1
- package/dist/esm/models/CreateShippingQuoteRequest.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuoteRequest.js +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestDestination.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestDestination.js +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestItemsInner.d.ts +1 -1
- package/dist/esm/models/CreateShippingQuoteRequestItemsInner.js +1 -1
- package/dist/esm/models/CreateShippingRule201Response.d.ts +7 -5
- package/dist/esm/models/CreateShippingRule201Response.js +5 -4
- package/dist/esm/models/CreateShippingRuleRequest.d.ts +7 -5
- package/dist/esm/models/CreateShippingRuleRequest.js +5 -4
- package/dist/{models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.d.ts → esm/models/CreateShippingRuleRequestAdditionalParametersValue.d.ts} +16 -16
- package/dist/esm/models/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.js → CreateShippingRuleRequestAdditionalParametersValue.js} +12 -12
- package/dist/{models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.d.ts → esm/models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.d.ts} +16 -16
- package/dist/esm/models/{CreateShippingRuleRequestAdditionalParametersAnyOfValue.js → CreateShippingRuleRequestAdditionalParametersValueAnyOf.js} +12 -12
- package/dist/esm/models/CreateShippingRuleRequestConditionsInner.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInner.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf1.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf1.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf2.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf2.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf3.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf3.js +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf4.d.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf4.js +1 -1
- package/dist/esm/models/DeleteOrgWebhook200Response.d.ts +1 -1
- package/dist/esm/models/DeleteOrgWebhook200Response.js +1 -1
- package/dist/esm/models/DeleteShippingRule200Response.d.ts +1 -1
- package/dist/esm/models/DeleteShippingRule200Response.js +1 -1
- package/dist/esm/models/GetBillingUsage200Response.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200Response.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseAddOnsInner.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseAddOnsInner.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseCurrentPeriod.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseCurrentPeriod.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimits.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimits.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimitsTeamMembers.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseLimitsTeamMembers.js +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseShipments.d.ts +1 -1
- package/dist/esm/models/GetBillingUsage200ResponseShipments.js +1 -1
- package/dist/esm/models/GetOrder200Response.d.ts +1 -1
- package/dist/esm/models/GetOrder200Response.js +1 -1
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts +1 -1
- package/dist/esm/models/GetOrder200ResponseShipmentsInner.js +1 -1
- package/dist/esm/models/GetOrder200ResponseShippingRule.d.ts +1 -1
- package/dist/esm/models/GetOrder200ResponseShippingRule.js +1 -1
- package/dist/esm/models/GetOrg200Response.d.ts +1 -1
- package/dist/esm/models/GetOrg200Response.js +1 -1
- package/dist/esm/models/GetOrg200ResponseCount.d.ts +1 -1
- package/dist/esm/models/GetOrg200ResponseCount.js +1 -1
- package/dist/esm/models/GetOrgBranding200Response.d.ts +1 -1
- package/dist/esm/models/GetOrgBranding200Response.js +1 -1
- package/dist/esm/models/HealthCheck200Response.d.ts +1 -1
- package/dist/esm/models/HealthCheck200Response.js +1 -1
- package/dist/esm/models/ListAddresses200Response.d.ts +1 -1
- package/dist/esm/models/ListAddresses200Response.js +1 -1
- package/dist/esm/models/ListAddresses200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListAddresses200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListApiTokens200Response.d.ts +1 -1
- package/dist/esm/models/ListApiTokens200Response.js +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInnerCreatedBy.d.ts +1 -1
- package/dist/esm/models/ListApiTokens200ResponseDataInnerCreatedBy.js +1 -1
- package/dist/esm/models/ListApiTokens401Response.d.ts +1 -1
- package/dist/esm/models/ListApiTokens401Response.js +1 -1
- package/dist/esm/models/ListAvailableCarriers200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListAvailableCarriers200ResponseInner.js +1 -1
- package/dist/esm/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.d.ts +1 -1
- package/dist/esm/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.js +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInner.js +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInnerAddress.d.ts +1 -1
- package/dist/esm/models/ListCarrierProductServicePoints200ResponseInnerAddress.js +1 -1
- package/dist/esm/models/ListCarrierProductServicePointsRequest.d.ts +1 -1
- package/dist/esm/models/ListCarrierProductServicePointsRequest.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerServicesInner.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerServicesInner.js +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerWeightLimits.d.ts +1 -1
- package/dist/esm/models/ListCarrierProducts200ResponseInnerWeightLimits.js +1 -1
- package/dist/esm/models/ListCarriers200Response.d.ts +1 -1
- package/dist/esm/models/ListCarriers200Response.js +1 -1
- package/dist/esm/models/ListCarriers200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListCarriers200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListCarriers200ResponseDataInnerConfigValue.d.ts +1 -1
- package/dist/esm/models/ListCarriers200ResponseDataInnerConfigValue.js +1 -1
- package/dist/esm/models/ListOrders200Response.d.ts +1 -1
- package/dist/esm/models/ListOrders200Response.js +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -1
- package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.js +1 -1
- package/dist/esm/models/{CreateShippingRuleRequestAdditionalParameters.d.ts → ListOrgBrands200Response.d.ts} +17 -10
- package/dist/esm/models/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.js → ListOrgBrands200Response.js} +24 -11
- package/dist/esm/models/ListOrgBrands200ResponseDataInner.d.ts +142 -0
- package/dist/esm/models/ListOrgBrands200ResponseDataInner.js +95 -0
- package/dist/esm/models/ListOrgWebhookDeliveries200Response.d.ts +1 -1
- package/dist/esm/models/ListOrgWebhookDeliveries200Response.js +1 -1
- package/dist/esm/models/ListOrgWebhookDeliveries200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListOrgWebhookDeliveries200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListOrgWebhooks200Response.d.ts +1 -1
- package/dist/esm/models/ListOrgWebhooks200Response.js +1 -1
- package/dist/esm/models/ListOrgWebhooks200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListOrgWebhooks200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListShipments200Response.d.ts +1 -1
- package/dist/esm/models/ListShipments200Response.js +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInner.js +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInnerAddress.d.ts +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInnerAddress.js +1 -1
- package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettings.d.ts +4 -4
- package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettings.js +4 -4
- package/dist/esm/models/ListShippingRules200Response.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200Response.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInner.d.ts +7 -5
- package/dist/esm/models/ListShippingRules200ResponseDataInner.js +5 -4
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.d.ts +51 -0
- package/dist/esm/models/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.js → ListShippingRules200ResponseDataInnerAdditionalParametersValue.js} +12 -12
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.d.ts +51 -0
- package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.js +54 -0
- package/dist/{models/ListShippingRules200ResponseDataInnerAdditionalParametersInner.d.ts → esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.d.ts} +9 -21
- package/dist/esm/models/{ListShippingRules200ResponseDataInnerAdditionalParametersInner.js → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.js} +11 -27
- package/dist/esm/models/ListShippingRules200ResponseDataInnerCarrier.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerCarrier.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInner.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInner.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerLabelPrinter.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerLabelPrinter.js +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerReturnShippingRule.d.ts +1 -1
- package/dist/esm/models/ListShippingRules200ResponseDataInnerReturnShippingRule.js +1 -1
- package/dist/esm/models/RevokeApiToken200Response.d.ts +1 -1
- package/dist/esm/models/RevokeApiToken200Response.js +1 -1
- package/dist/esm/models/SendShipment422Response.d.ts +1 -1
- package/dist/esm/models/SendShipment422Response.js +1 -1
- package/dist/esm/models/SendShipment422ResponseErrorsInner.d.ts +1 -1
- package/dist/esm/models/SendShipment422ResponseErrorsInner.js +1 -1
- package/dist/esm/models/SplitShipment201Response.d.ts +1 -1
- package/dist/esm/models/SplitShipment201Response.js +1 -1
- package/dist/esm/models/SplitShipmentParcel200Response.d.ts +1 -1
- package/dist/esm/models/SplitShipmentParcel200Response.js +1 -1
- package/dist/esm/models/SplitShipmentParcelRequest.d.ts +1 -1
- package/dist/esm/models/SplitShipmentParcelRequest.js +1 -1
- package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.d.ts +1 -1
- package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.js +1 -1
- package/dist/esm/models/SplitShipmentRequest.d.ts +5 -4
- package/dist/esm/models/SplitShipmentRequest.js +5 -3
- package/dist/esm/models/TestOrgWebhook200Response.d.ts +1 -1
- package/dist/esm/models/TestOrgWebhook200Response.js +1 -1
- package/dist/esm/models/TrackShipment200Response.d.ts +1 -1
- package/dist/esm/models/TrackShipment200Response.js +1 -1
- package/dist/esm/models/TrackShipment200ResponseEventsInner.d.ts +1 -1
- package/dist/esm/models/TrackShipment200ResponseEventsInner.js +1 -1
- package/dist/esm/models/UpdateAddressRequest.d.ts +1 -1
- package/dist/esm/models/UpdateAddressRequest.js +1 -1
- package/dist/esm/models/UpdateApiTokenRequest.d.ts +1 -1
- package/dist/esm/models/UpdateApiTokenRequest.js +1 -1
- package/dist/esm/models/UpdateCarrierRequest.d.ts +1 -1
- package/dist/esm/models/UpdateCarrierRequest.js +1 -1
- package/dist/esm/models/UpdateOrderRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrderRequest.js +1 -1
- package/dist/esm/models/UpdateOrg200Response.d.ts +1 -1
- package/dist/esm/models/UpdateOrg200Response.js +1 -1
- package/dist/esm/models/UpdateOrgBrandRequest.d.ts +106 -0
- package/dist/esm/models/UpdateOrgBrandRequest.js +65 -0
- package/dist/esm/models/UpdateOrgBrandingRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrgBrandingRequest.js +1 -1
- package/dist/esm/models/UpdateOrgRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrgRequest.js +1 -1
- package/dist/esm/models/UpdateOrgWebhookRequest.d.ts +1 -1
- package/dist/esm/models/UpdateOrgWebhookRequest.js +1 -1
- package/dist/esm/models/UpdateShipmentRequest.d.ts +1 -1
- package/dist/esm/models/UpdateShipmentRequest.js +1 -1
- package/dist/esm/models/UpdateShippingRuleRequest.d.ts +7 -5
- package/dist/esm/models/UpdateShippingRuleRequest.js +5 -4
- package/dist/esm/models/VerifyApiToken200Response.d.ts +1 -1
- package/dist/esm/models/VerifyApiToken200Response.js +1 -1
- package/dist/esm/models/VerifyApiTokenRequest.d.ts +1 -1
- package/dist/esm/models/VerifyApiTokenRequest.js +1 -1
- package/dist/esm/models/index.d.ts +10 -8
- package/dist/esm/models/index.js +10 -8
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +1 -1
- package/dist/models/BatchSendShipments200Response.d.ts +1 -1
- package/dist/models/BatchSendShipments200Response.js +1 -1
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -1
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +1 -1
- package/dist/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
- package/dist/models/BatchSendShipments200ResponseSummary.js +1 -1
- package/dist/models/BatchSendShipmentsRequest.d.ts +1 -1
- package/dist/models/BatchSendShipmentsRequest.js +1 -1
- package/dist/models/BatchSplitShipment201Response.d.ts +1 -1
- package/dist/models/BatchSplitShipment201Response.js +1 -1
- package/dist/models/BatchSplitShipmentRequest.d.ts +5 -4
- package/dist/models/BatchSplitShipmentRequest.js +5 -3
- package/dist/models/BatchSplitShipmentRequestShipmentsInner.d.ts +1 -1
- package/dist/models/BatchSplitShipmentRequestShipmentsInner.js +1 -1
- package/dist/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.d.ts +1 -1
- package/dist/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.js +1 -1
- package/dist/{esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfInner.d.ts → models/CheckBrandSlug200Response.d.ts} +16 -16
- package/dist/models/{CreateShippingRuleRequestAdditionalParametersAnyOfInner.js → CheckBrandSlug200Response.js} +20 -20
- package/dist/models/ConnectCarrierRequest.d.ts +1 -1
- package/dist/models/ConnectCarrierRequest.js +1 -1
- package/dist/models/CreateAddressRequest.d.ts +1 -1
- package/dist/models/CreateAddressRequest.js +1 -1
- package/dist/models/CreateApiToken201Response.d.ts +1 -1
- package/dist/models/CreateApiToken201Response.js +1 -1
- package/dist/models/CreateApiTokenRequest.d.ts +1 -1
- package/dist/models/CreateApiTokenRequest.js +1 -1
- package/dist/models/CreateOrder201Response.d.ts +1 -1
- package/dist/models/CreateOrder201Response.js +1 -1
- package/dist/models/CreateOrder201ResponseOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateOrder201ResponseOrderLinesInner.js +1 -1
- package/dist/models/CreateOrder201ResponseShippingAddress.d.ts +1 -1
- package/dist/models/CreateOrder201ResponseShippingAddress.js +1 -1
- package/dist/models/CreateOrderRequest.d.ts +1 -1
- package/dist/models/CreateOrderRequest.js +1 -1
- package/dist/models/CreateOrderRequestOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateOrderRequestOrderLinesInner.js +1 -1
- package/dist/models/CreateOrderRequestShippingAddress.d.ts +1 -1
- package/dist/models/CreateOrderRequestShippingAddress.js +1 -1
- package/dist/models/CreateOrgBrandRequest.d.ts +106 -0
- package/dist/models/CreateOrgBrandRequest.js +74 -0
- package/dist/models/CreateOrgWebhook201Response.d.ts +1 -1
- package/dist/models/CreateOrgWebhook201Response.js +1 -1
- package/dist/models/CreateOrgWebhookRequest.d.ts +1 -1
- package/dist/models/CreateOrgWebhookRequest.js +1 -1
- package/dist/models/CreateShipment201Response.d.ts +1 -1
- package/dist/models/CreateShipment201Response.js +1 -1
- package/dist/models/CreateShipment201ResponseActivitiesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseActivitiesInner.js +1 -1
- package/dist/models/CreateShipment201ResponseDocumentsInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseDocumentsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseErrorsInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseErrorsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseLogsInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseLogsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInner.d.ts +3 -3
- package/dist/models/CreateShipment201ResponseParcelsInner.js +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerDimensions.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerDimensions.js +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInner.js +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInnerAttributesInner.d.ts +1 -1
- package/dist/models/CreateShipment201ResponsePartiesInnerAttributesInner.js +1 -1
- package/dist/models/CreateShipment201ResponsePickupDetails.d.ts +1 -1
- package/dist/models/CreateShipment201ResponsePickupDetails.js +1 -1
- package/dist/models/CreateShipment201ResponseShippingRule.d.ts +1 -1
- package/dist/models/CreateShipment201ResponseShippingRule.js +1 -1
- package/dist/models/CreateShipment201ResponseTracking.d.ts +3 -3
- package/dist/models/CreateShipment201ResponseTracking.js +1 -1
- package/dist/models/CreateShipmentRequest.d.ts +1 -1
- package/dist/models/CreateShipmentRequest.js +1 -1
- package/dist/models/CreateShipmentRequestCarrierSettings.d.ts +4 -4
- package/dist/models/CreateShipmentRequestCarrierSettings.js +4 -4
- package/dist/models/CreateShipmentRequestParcelsInner.d.ts +3 -3
- package/dist/models/CreateShipmentRequestParcelsInner.js +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerDimensions.d.ts +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerDimensions.js +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +1 -1
- package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -1
- package/dist/models/CreateShipmentRequestPartiesInner.d.ts +1 -1
- package/dist/models/CreateShipmentRequestPartiesInner.js +1 -1
- package/dist/models/CreateShipmentRequestPartiesInnerAttributesInner.d.ts +1 -1
- package/dist/models/CreateShipmentRequestPartiesInnerAttributesInner.js +1 -1
- package/dist/models/CreateShipmentRequestPickupDetails.d.ts +1 -1
- package/dist/models/CreateShipmentRequestPickupDetails.js +1 -1
- package/dist/models/CreateShippingQuote200Response.d.ts +1 -1
- package/dist/models/CreateShippingQuote200Response.js +1 -1
- package/dist/models/CreateShippingQuote200ResponseRatesInner.d.ts +1 -1
- package/dist/models/CreateShippingQuote200ResponseRatesInner.js +1 -1
- package/dist/models/CreateShippingQuote400Response.d.ts +1 -1
- package/dist/models/CreateShippingQuote400Response.js +1 -1
- package/dist/models/CreateShippingQuote404Response.d.ts +1 -1
- package/dist/models/CreateShippingQuote404Response.js +1 -1
- package/dist/models/CreateShippingQuoteRequest.d.ts +1 -1
- package/dist/models/CreateShippingQuoteRequest.js +1 -1
- package/dist/models/CreateShippingQuoteRequestDestination.d.ts +1 -1
- package/dist/models/CreateShippingQuoteRequestDestination.js +1 -1
- package/dist/models/CreateShippingQuoteRequestItemsInner.d.ts +1 -1
- package/dist/models/CreateShippingQuoteRequestItemsInner.js +1 -1
- package/dist/models/CreateShippingRule201Response.d.ts +7 -5
- package/dist/models/CreateShippingRule201Response.js +5 -4
- package/dist/models/CreateShippingRuleRequest.d.ts +7 -5
- package/dist/models/CreateShippingRuleRequest.js +5 -4
- package/dist/{esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.d.ts → models/CreateShippingRuleRequestAdditionalParametersValue.d.ts} +16 -16
- package/dist/models/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.js → CreateShippingRuleRequestAdditionalParametersValue.js} +17 -17
- package/dist/{esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.d.ts → models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.d.ts} +16 -16
- package/dist/models/{CreateShippingRuleRequestAdditionalParametersAnyOfValue.js → CreateShippingRuleRequestAdditionalParametersValueAnyOf.js} +17 -17
- package/dist/models/CreateShippingRuleRequestConditionsInner.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInner.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf1.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf1.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf2.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf2.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf3.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf3.js +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf4.d.ts +1 -1
- package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf4.js +1 -1
- package/dist/models/DeleteOrgWebhook200Response.d.ts +1 -1
- package/dist/models/DeleteOrgWebhook200Response.js +1 -1
- package/dist/models/DeleteShippingRule200Response.d.ts +1 -1
- package/dist/models/DeleteShippingRule200Response.js +1 -1
- package/dist/models/GetBillingUsage200Response.d.ts +1 -1
- package/dist/models/GetBillingUsage200Response.js +1 -1
- package/dist/models/GetBillingUsage200ResponseAddOnsInner.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseAddOnsInner.js +1 -1
- package/dist/models/GetBillingUsage200ResponseCurrentPeriod.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseCurrentPeriod.js +1 -1
- package/dist/models/GetBillingUsage200ResponseLimits.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseLimits.js +1 -1
- package/dist/models/GetBillingUsage200ResponseLimitsTeamMembers.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseLimitsTeamMembers.js +1 -1
- package/dist/models/GetBillingUsage200ResponseShipments.d.ts +1 -1
- package/dist/models/GetBillingUsage200ResponseShipments.js +1 -1
- package/dist/models/GetOrder200Response.d.ts +1 -1
- package/dist/models/GetOrder200Response.js +1 -1
- package/dist/models/GetOrder200ResponseShipmentsInner.d.ts +1 -1
- package/dist/models/GetOrder200ResponseShipmentsInner.js +1 -1
- package/dist/models/GetOrder200ResponseShippingRule.d.ts +1 -1
- package/dist/models/GetOrder200ResponseShippingRule.js +1 -1
- package/dist/models/GetOrg200Response.d.ts +1 -1
- package/dist/models/GetOrg200Response.js +1 -1
- package/dist/models/GetOrg200ResponseCount.d.ts +1 -1
- package/dist/models/GetOrg200ResponseCount.js +1 -1
- package/dist/models/GetOrgBranding200Response.d.ts +1 -1
- package/dist/models/GetOrgBranding200Response.js +1 -1
- package/dist/models/HealthCheck200Response.d.ts +1 -1
- package/dist/models/HealthCheck200Response.js +1 -1
- package/dist/models/ListAddresses200Response.d.ts +1 -1
- package/dist/models/ListAddresses200Response.js +1 -1
- package/dist/models/ListAddresses200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListAddresses200ResponseDataInner.js +1 -1
- package/dist/models/ListApiTokens200Response.d.ts +1 -1
- package/dist/models/ListApiTokens200Response.js +1 -1
- package/dist/models/ListApiTokens200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListApiTokens200ResponseDataInner.js +1 -1
- package/dist/models/ListApiTokens200ResponseDataInnerCreatedBy.d.ts +1 -1
- package/dist/models/ListApiTokens200ResponseDataInnerCreatedBy.js +1 -1
- package/dist/models/ListApiTokens401Response.d.ts +1 -1
- package/dist/models/ListApiTokens401Response.js +1 -1
- package/dist/models/ListAvailableCarriers200ResponseInner.d.ts +1 -1
- package/dist/models/ListAvailableCarriers200ResponseInner.js +1 -1
- package/dist/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.d.ts +1 -1
- package/dist/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.js +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInner.d.ts +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInner.js +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInnerAddress.d.ts +1 -1
- package/dist/models/ListCarrierProductServicePoints200ResponseInnerAddress.js +1 -1
- package/dist/models/ListCarrierProductServicePointsRequest.d.ts +1 -1
- package/dist/models/ListCarrierProductServicePointsRequest.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerServicesInner.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerServicesInner.js +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerWeightLimits.d.ts +1 -1
- package/dist/models/ListCarrierProducts200ResponseInnerWeightLimits.js +1 -1
- package/dist/models/ListCarriers200Response.d.ts +1 -1
- package/dist/models/ListCarriers200Response.js +1 -1
- package/dist/models/ListCarriers200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListCarriers200ResponseDataInner.js +1 -1
- package/dist/models/ListCarriers200ResponseDataInnerConfigValue.d.ts +1 -1
- package/dist/models/ListCarriers200ResponseDataInnerConfigValue.js +1 -1
- package/dist/models/ListOrders200Response.d.ts +1 -1
- package/dist/models/ListOrders200Response.js +1 -1
- package/dist/models/ListOrders200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListOrders200ResponseDataInner.js +1 -1
- package/dist/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -1
- package/dist/models/ListOrders200ResponseDataInnerOrderChannel.js +1 -1
- package/dist/models/{CreateShippingRuleRequestAdditionalParameters.d.ts → ListOrgBrands200Response.d.ts} +17 -10
- package/dist/models/ListOrgBrands200Response.js +51 -0
- package/dist/models/ListOrgBrands200ResponseDataInner.d.ts +142 -0
- package/dist/models/ListOrgBrands200ResponseDataInner.js +102 -0
- package/dist/models/ListOrgWebhookDeliveries200Response.d.ts +1 -1
- package/dist/models/ListOrgWebhookDeliveries200Response.js +1 -1
- package/dist/models/ListOrgWebhookDeliveries200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListOrgWebhookDeliveries200ResponseDataInner.js +1 -1
- package/dist/models/ListOrgWebhooks200Response.d.ts +1 -1
- package/dist/models/ListOrgWebhooks200Response.js +1 -1
- package/dist/models/ListOrgWebhooks200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListOrgWebhooks200ResponseDataInner.js +1 -1
- package/dist/models/ListShipments200Response.d.ts +1 -1
- package/dist/models/ListShipments200Response.js +1 -1
- package/dist/models/ListShipments200ResponseDataInner.d.ts +1 -1
- package/dist/models/ListShipments200ResponseDataInner.js +1 -1
- package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts +1 -1
- package/dist/models/ListShipments200ResponseDataInnerAddress.js +1 -1
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettings.d.ts +4 -4
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettings.js +4 -4
- package/dist/models/ListShippingRules200Response.d.ts +1 -1
- package/dist/models/ListShippingRules200Response.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInner.d.ts +7 -5
- package/dist/models/ListShippingRules200ResponseDataInner.js +5 -4
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.d.ts +51 -0
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.js +61 -0
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.d.ts +51 -0
- package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.js +61 -0
- package/dist/{esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersInner.d.ts → models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.d.ts} +9 -21
- package/dist/models/{ListShippingRules200ResponseDataInnerAdditionalParametersInner.js → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.js} +16 -32
- package/dist/models/ListShippingRules200ResponseDataInnerCarrier.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerCarrier.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInner.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInner.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerLabelPrinter.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerLabelPrinter.js +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerReturnShippingRule.d.ts +1 -1
- package/dist/models/ListShippingRules200ResponseDataInnerReturnShippingRule.js +1 -1
- package/dist/models/RevokeApiToken200Response.d.ts +1 -1
- package/dist/models/RevokeApiToken200Response.js +1 -1
- package/dist/models/SendShipment422Response.d.ts +1 -1
- package/dist/models/SendShipment422Response.js +1 -1
- package/dist/models/SendShipment422ResponseErrorsInner.d.ts +1 -1
- package/dist/models/SendShipment422ResponseErrorsInner.js +1 -1
- package/dist/models/SplitShipment201Response.d.ts +1 -1
- package/dist/models/SplitShipment201Response.js +1 -1
- package/dist/models/SplitShipmentParcel200Response.d.ts +1 -1
- package/dist/models/SplitShipmentParcel200Response.js +1 -1
- package/dist/models/SplitShipmentParcelRequest.d.ts +1 -1
- package/dist/models/SplitShipmentParcelRequest.js +1 -1
- package/dist/models/SplitShipmentParcelRequestParcelsInner.d.ts +1 -1
- package/dist/models/SplitShipmentParcelRequestParcelsInner.js +1 -1
- package/dist/models/SplitShipmentRequest.d.ts +5 -4
- package/dist/models/SplitShipmentRequest.js +5 -3
- package/dist/models/TestOrgWebhook200Response.d.ts +1 -1
- package/dist/models/TestOrgWebhook200Response.js +1 -1
- package/dist/models/TrackShipment200Response.d.ts +1 -1
- package/dist/models/TrackShipment200Response.js +1 -1
- package/dist/models/TrackShipment200ResponseEventsInner.d.ts +1 -1
- package/dist/models/TrackShipment200ResponseEventsInner.js +1 -1
- package/dist/models/UpdateAddressRequest.d.ts +1 -1
- package/dist/models/UpdateAddressRequest.js +1 -1
- package/dist/models/UpdateApiTokenRequest.d.ts +1 -1
- package/dist/models/UpdateApiTokenRequest.js +1 -1
- package/dist/models/UpdateCarrierRequest.d.ts +1 -1
- package/dist/models/UpdateCarrierRequest.js +1 -1
- package/dist/models/UpdateOrderRequest.d.ts +1 -1
- package/dist/models/UpdateOrderRequest.js +1 -1
- package/dist/models/UpdateOrg200Response.d.ts +1 -1
- package/dist/models/UpdateOrg200Response.js +1 -1
- package/dist/models/UpdateOrgBrandRequest.d.ts +106 -0
- package/dist/models/UpdateOrgBrandRequest.js +72 -0
- package/dist/models/UpdateOrgBrandingRequest.d.ts +1 -1
- package/dist/models/UpdateOrgBrandingRequest.js +1 -1
- package/dist/models/UpdateOrgRequest.d.ts +1 -1
- package/dist/models/UpdateOrgRequest.js +1 -1
- package/dist/models/UpdateOrgWebhookRequest.d.ts +1 -1
- package/dist/models/UpdateOrgWebhookRequest.js +1 -1
- package/dist/models/UpdateShipmentRequest.d.ts +1 -1
- package/dist/models/UpdateShipmentRequest.js +1 -1
- package/dist/models/UpdateShippingRuleRequest.d.ts +7 -5
- package/dist/models/UpdateShippingRuleRequest.js +5 -4
- package/dist/models/VerifyApiToken200Response.d.ts +1 -1
- package/dist/models/VerifyApiToken200Response.js +1 -1
- package/dist/models/VerifyApiTokenRequest.d.ts +1 -1
- package/dist/models/VerifyApiTokenRequest.js +1 -1
- package/dist/models/index.d.ts +10 -8
- package/dist/models/index.js +10 -8
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/docs/BatchSplitShipmentRequest.md +1 -1
- package/docs/BrandsApi.md +795 -0
- package/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfInner.md → CheckBrandSlug200Response.md} +8 -8
- package/docs/CreateOrgBrandRequest.md +58 -0
- package/docs/CreateShipmentRequestCarrierSettings.md +1 -1
- package/docs/CreateShippingRule201Response.md +2 -2
- package/docs/CreateShippingRuleRequest.md +2 -2
- package/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValue.md → CreateShippingRuleRequestAdditionalParametersValue.md} +5 -5
- package/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md → CreateShippingRuleRequestAdditionalParametersValueAnyOf.md} +5 -5
- package/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md → ListOrgBrands200Response.md} +6 -4
- package/docs/ListOrgBrands200ResponseDataInner.md +70 -0
- package/docs/ListShipments200ResponseDataInnerCarrierSettings.md +1 -1
- package/docs/ListShippingRules200ResponseDataInner.md +2 -2
- package/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md → ListShippingRules200ResponseDataInnerAdditionalParametersValue.md} +5 -5
- package/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.md} +5 -5
- package/docs/{ListShippingRules200ResponseDataInnerAdditionalParametersInner.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md} +4 -8
- package/docs/SplitShipmentRequest.md +1 -1
- package/docs/UpdateOrgBrandRequest.md +58 -0
- package/docs/UpdateShippingRuleRequest.md +2 -2
- package/package.json +1 -1
- package/src/apis/AddressesApi.ts +1 -1
- package/src/apis/BillingApi.ts +1 -1
- package/src/apis/BrandsApi.ts +770 -0
- package/src/apis/CarrierCatalogApi.ts +1 -1
- package/src/apis/CarriersApi.ts +1 -1
- package/src/apis/OrdersApi.ts +1 -1
- package/src/apis/OrgsApi.ts +1 -1
- package/src/apis/QuotesApi.ts +1 -1
- package/src/apis/RulesApi.ts +1 -1
- package/src/apis/ShipmentsApi.ts +1 -1
- package/src/apis/SystemApi.ts +1 -1
- package/src/apis/TokensApi.ts +1 -1
- package/src/apis/WebhooksApi.ts +1 -1
- package/src/apis/index.ts +1 -0
- package/src/models/BatchSendShipments200Response.ts +1 -1
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +1 -1
- package/src/models/BatchSendShipments200ResponseSummary.ts +1 -1
- package/src/models/BatchSendShipmentsRequest.ts +1 -1
- package/src/models/BatchSplitShipment201Response.ts +1 -1
- package/src/models/BatchSplitShipmentRequest.ts +13 -6
- package/src/models/BatchSplitShipmentRequestShipmentsInner.ts +1 -1
- package/src/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.ts +1 -1
- package/src/models/{CreateShippingRuleRequestAdditionalParametersAnyOfInner.ts → CheckBrandSlug200Response.ts} +24 -24
- package/src/models/ConnectCarrierRequest.ts +1 -1
- package/src/models/CreateAddressRequest.ts +1 -1
- package/src/models/CreateApiToken201Response.ts +1 -1
- package/src/models/CreateApiTokenRequest.ts +1 -1
- package/src/models/CreateOrder201Response.ts +1 -1
- package/src/models/CreateOrder201ResponseOrderLinesInner.ts +1 -1
- package/src/models/CreateOrder201ResponseShippingAddress.ts +1 -1
- package/src/models/CreateOrderRequest.ts +1 -1
- package/src/models/CreateOrderRequestOrderLinesInner.ts +1 -1
- package/src/models/CreateOrderRequestShippingAddress.ts +1 -1
- package/src/models/CreateOrgBrandRequest.ts +162 -0
- package/src/models/CreateOrgWebhook201Response.ts +1 -1
- package/src/models/CreateOrgWebhookRequest.ts +1 -1
- package/src/models/CreateShipment201Response.ts +1 -1
- package/src/models/CreateShipment201ResponseActivitiesInner.ts +1 -1
- package/src/models/CreateShipment201ResponseDocumentsInner.ts +1 -1
- package/src/models/CreateShipment201ResponseErrorsInner.ts +1 -1
- package/src/models/CreateShipment201ResponseLogsInner.ts +1 -1
- package/src/models/CreateShipment201ResponseParcelsInner.ts +3 -3
- package/src/models/CreateShipment201ResponseParcelsInnerDimensions.ts +1 -1
- package/src/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.ts +1 -1
- package/src/models/CreateShipment201ResponsePartiesInner.ts +1 -1
- package/src/models/CreateShipment201ResponsePartiesInnerAttributesInner.ts +1 -1
- package/src/models/CreateShipment201ResponsePickupDetails.ts +1 -1
- package/src/models/CreateShipment201ResponseShippingRule.ts +1 -1
- package/src/models/CreateShipment201ResponseTracking.ts +3 -3
- package/src/models/CreateShipmentRequest.ts +1 -1
- package/src/models/CreateShipmentRequestCarrierSettings.ts +11 -11
- package/src/models/CreateShipmentRequestParcelsInner.ts +3 -3
- package/src/models/CreateShipmentRequestParcelsInnerDimensions.ts +1 -1
- package/src/models/CreateShipmentRequestParcelsInnerOrderLinesInner.ts +1 -1
- package/src/models/CreateShipmentRequestPartiesInner.ts +1 -1
- package/src/models/CreateShipmentRequestPartiesInnerAttributesInner.ts +1 -1
- package/src/models/CreateShipmentRequestPickupDetails.ts +1 -1
- package/src/models/CreateShippingQuote200Response.ts +1 -1
- package/src/models/CreateShippingQuote200ResponseRatesInner.ts +1 -1
- package/src/models/CreateShippingQuote400Response.ts +1 -1
- package/src/models/CreateShippingQuote404Response.ts +1 -1
- package/src/models/CreateShippingQuoteRequest.ts +1 -1
- package/src/models/CreateShippingQuoteRequestDestination.ts +1 -1
- package/src/models/CreateShippingQuoteRequestItemsInner.ts +1 -1
- package/src/models/CreateShippingRule201Response.ts +12 -12
- package/src/models/CreateShippingRuleRequest.ts +13 -13
- package/src/models/CreateShippingRuleRequestAdditionalParametersValue.ts +107 -0
- package/src/models/CreateShippingRuleRequestAdditionalParametersValueAnyOf.ts +100 -0
- package/src/models/CreateShippingRuleRequestConditionsInner.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf1.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf2.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf3.ts +1 -1
- package/src/models/CreateShippingRuleRequestConditionsInnerOneOf4.ts +1 -1
- package/src/models/DeleteOrgWebhook200Response.ts +1 -1
- package/src/models/DeleteShippingRule200Response.ts +1 -1
- package/src/models/GetBillingUsage200Response.ts +1 -1
- package/src/models/GetBillingUsage200ResponseAddOnsInner.ts +1 -1
- package/src/models/GetBillingUsage200ResponseCurrentPeriod.ts +1 -1
- package/src/models/GetBillingUsage200ResponseLimits.ts +1 -1
- package/src/models/GetBillingUsage200ResponseLimitsTeamMembers.ts +1 -1
- package/src/models/GetBillingUsage200ResponseShipments.ts +1 -1
- package/src/models/GetOrder200Response.ts +1 -1
- package/src/models/GetOrder200ResponseShipmentsInner.ts +1 -1
- package/src/models/GetOrder200ResponseShippingRule.ts +1 -1
- package/src/models/GetOrg200Response.ts +1 -1
- package/src/models/GetOrg200ResponseCount.ts +1 -1
- package/src/models/GetOrgBranding200Response.ts +1 -1
- package/src/models/HealthCheck200Response.ts +1 -1
- package/src/models/ListAddresses200Response.ts +1 -1
- package/src/models/ListAddresses200ResponseDataInner.ts +1 -1
- package/src/models/ListApiTokens200Response.ts +1 -1
- package/src/models/ListApiTokens200ResponseDataInner.ts +1 -1
- package/src/models/ListApiTokens200ResponseDataInnerCreatedBy.ts +1 -1
- package/src/models/ListApiTokens401Response.ts +1 -1
- package/src/models/ListAvailableCarriers200ResponseInner.ts +1 -1
- package/src/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.ts +1 -1
- package/src/models/ListCarrierProductServicePoints200ResponseInner.ts +1 -1
- package/src/models/ListCarrierProductServicePoints200ResponseInnerAddress.ts +1 -1
- package/src/models/ListCarrierProductServicePointsRequest.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerServicesInner.ts +1 -1
- package/src/models/ListCarrierProducts200ResponseInnerWeightLimits.ts +1 -1
- package/src/models/ListCarriers200Response.ts +1 -1
- package/src/models/ListCarriers200ResponseDataInner.ts +1 -1
- package/src/models/ListCarriers200ResponseDataInnerConfigValue.ts +1 -1
- package/src/models/ListOrders200Response.ts +1 -1
- package/src/models/ListOrders200ResponseDataInner.ts +1 -1
- package/src/models/ListOrders200ResponseDataInnerOrderChannel.ts +1 -1
- package/src/models/ListOrgBrands200Response.ts +74 -0
- package/src/models/ListOrgBrands200ResponseDataInner.ts +218 -0
- package/src/models/ListOrgWebhookDeliveries200Response.ts +1 -1
- package/src/models/ListOrgWebhookDeliveries200ResponseDataInner.ts +1 -1
- package/src/models/ListOrgWebhooks200Response.ts +1 -1
- package/src/models/ListOrgWebhooks200ResponseDataInner.ts +1 -1
- package/src/models/ListShipments200Response.ts +1 -1
- package/src/models/ListShipments200ResponseDataInner.ts +1 -1
- package/src/models/ListShipments200ResponseDataInnerAddress.ts +1 -1
- package/src/models/ListShipments200ResponseDataInnerCarrierSettings.ts +11 -11
- package/src/models/ListShippingRules200Response.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInner.ts +12 -12
- package/src/models/ListShippingRules200ResponseDataInnerAdditionalParametersValue.ts +107 -0
- package/src/models/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.ts +100 -0
- package/src/models/{ListShippingRules200ResponseDataInnerAdditionalParametersInner.ts → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.ts} +13 -42
- package/src/models/ListShippingRules200ResponseDataInnerCarrier.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInner.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerLabelPrinter.ts +1 -1
- package/src/models/ListShippingRules200ResponseDataInnerReturnShippingRule.ts +1 -1
- package/src/models/RevokeApiToken200Response.ts +1 -1
- package/src/models/SendShipment422Response.ts +1 -1
- package/src/models/SendShipment422ResponseErrorsInner.ts +1 -1
- package/src/models/SplitShipment201Response.ts +1 -1
- package/src/models/SplitShipmentParcel200Response.ts +1 -1
- package/src/models/SplitShipmentParcelRequest.ts +1 -1
- package/src/models/SplitShipmentParcelRequestParcelsInner.ts +1 -1
- package/src/models/SplitShipmentRequest.ts +14 -6
- package/src/models/TestOrgWebhook200Response.ts +1 -1
- package/src/models/TrackShipment200Response.ts +1 -1
- package/src/models/TrackShipment200ResponseEventsInner.ts +1 -1
- package/src/models/UpdateAddressRequest.ts +1 -1
- package/src/models/UpdateApiTokenRequest.ts +1 -1
- package/src/models/UpdateCarrierRequest.ts +1 -1
- package/src/models/UpdateOrderRequest.ts +1 -1
- package/src/models/UpdateOrg200Response.ts +1 -1
- package/src/models/UpdateOrgBrandRequest.ts +161 -0
- package/src/models/UpdateOrgBrandingRequest.ts +1 -1
- package/src/models/UpdateOrgRequest.ts +1 -1
- package/src/models/UpdateOrgWebhookRequest.ts +1 -1
- package/src/models/UpdateShipmentRequest.ts +1 -1
- package/src/models/UpdateShippingRuleRequest.ts +13 -13
- package/src/models/VerifyApiToken200Response.ts +1 -1
- package/src/models/VerifyApiTokenRequest.ts +1 -1
- package/src/models/index.ts +10 -8
- package/src/runtime.ts +1 -1
- package/dist/esm/models/CreateShippingRuleRequestAdditionalParameters.js +0 -31
- package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.d.ts +0 -26
- package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.d.ts +0 -51
- package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.js +0 -54
- package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.d.ts +0 -51
- package/dist/models/CreateShippingRuleRequestAdditionalParameters.js +0 -38
- package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.d.ts +0 -26
- package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.js +0 -38
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.d.ts +0 -51
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.js +0 -61
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.d.ts +0 -51
- package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.js +0 -61
- package/docs/CreateShippingRuleRequestAdditionalParameters.md +0 -33
- package/src/models/CreateShippingRuleRequestAdditionalParameters.ts +0 -61
- package/src/models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.ts +0 -107
- package/src/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.ts +0 -100
- package/src/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.ts +0 -46
- package/src/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.ts +0 -107
- package/src/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.ts +0 -100
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Zippendo Public API
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@zippendo.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface CreateOrgBrandRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface CreateOrgBrandRequest {
|
|
22
|
+
/**
|
|
23
|
+
* Legal entity name printed on this brand's documents
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof CreateOrgBrandRequest
|
|
26
|
+
*/
|
|
27
|
+
companyName?: string | null;
|
|
28
|
+
/**
|
|
29
|
+
* VAT/tax ID for this brand's shipments and documents
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof CreateOrgBrandRequest
|
|
32
|
+
*/
|
|
33
|
+
vatNumber?: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* Customs identifiers keyed by type
|
|
36
|
+
* @type {{ [key: string]: string; }}
|
|
37
|
+
* @memberof CreateOrgBrandRequest
|
|
38
|
+
*/
|
|
39
|
+
customs?: { [key: string]: string; } | null;
|
|
40
|
+
/**
|
|
41
|
+
* Street address line 1
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof CreateOrgBrandRequest
|
|
44
|
+
*/
|
|
45
|
+
addressLine1?: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* Street address line 2
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof CreateOrgBrandRequest
|
|
50
|
+
*/
|
|
51
|
+
addressLine2?: string | null;
|
|
52
|
+
/**
|
|
53
|
+
* City
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof CreateOrgBrandRequest
|
|
56
|
+
*/
|
|
57
|
+
city?: string | null;
|
|
58
|
+
/**
|
|
59
|
+
* Postal code
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof CreateOrgBrandRequest
|
|
62
|
+
*/
|
|
63
|
+
postalCode?: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* Country (ISO 3166-1 alpha-2)
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof CreateOrgBrandRequest
|
|
68
|
+
*/
|
|
69
|
+
country?: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* Primary brand colour — document title and table headers
|
|
72
|
+
* @type {string}
|
|
73
|
+
* @memberof CreateOrgBrandRequest
|
|
74
|
+
*/
|
|
75
|
+
primaryColor?: string | null;
|
|
76
|
+
/**
|
|
77
|
+
* Secondary brand colour — subtitle, section headings, totals accent
|
|
78
|
+
* @type {string}
|
|
79
|
+
* @memberof CreateOrgBrandRequest
|
|
80
|
+
*/
|
|
81
|
+
secondaryColor?: string | null;
|
|
82
|
+
/**
|
|
83
|
+
* Brand display name
|
|
84
|
+
* @type {string}
|
|
85
|
+
* @memberof CreateOrgBrandRequest
|
|
86
|
+
*/
|
|
87
|
+
name: string;
|
|
88
|
+
/**
|
|
89
|
+
* URL-safe identifier, unique within the org. Derived from the name when omitted.
|
|
90
|
+
* @type {string}
|
|
91
|
+
* @memberof CreateOrgBrandRequest
|
|
92
|
+
*/
|
|
93
|
+
slug?: string;
|
|
94
|
+
/**
|
|
95
|
+
* Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all.
|
|
96
|
+
* @type {boolean}
|
|
97
|
+
* @memberof CreateOrgBrandRequest
|
|
98
|
+
*/
|
|
99
|
+
useOrgCustoms?: boolean;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Check if a given object implements the CreateOrgBrandRequest interface.
|
|
104
|
+
*/
|
|
105
|
+
export function instanceOfCreateOrgBrandRequest(value: object): value is CreateOrgBrandRequest {
|
|
106
|
+
if (!('name' in value) || value['name'] === undefined) return false;
|
|
107
|
+
return true;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
export function CreateOrgBrandRequestFromJSON(json: any): CreateOrgBrandRequest {
|
|
111
|
+
return CreateOrgBrandRequestFromJSONTyped(json, false);
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export function CreateOrgBrandRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrgBrandRequest {
|
|
115
|
+
if (json == null) {
|
|
116
|
+
return json;
|
|
117
|
+
}
|
|
118
|
+
return {
|
|
119
|
+
|
|
120
|
+
'companyName': json['companyName'] === undefined ? undefined : json['companyName'] === null ? null : json['companyName'],
|
|
121
|
+
'vatNumber': json['vatNumber'] === undefined ? undefined : json['vatNumber'] === null ? null : json['vatNumber'],
|
|
122
|
+
'customs': json['customs'] === undefined ? undefined : json['customs'] === null ? null : json['customs'],
|
|
123
|
+
'addressLine1': json['addressLine1'] === undefined ? undefined : json['addressLine1'] === null ? null : json['addressLine1'],
|
|
124
|
+
'addressLine2': json['addressLine2'] === undefined ? undefined : json['addressLine2'] === null ? null : json['addressLine2'],
|
|
125
|
+
'city': json['city'] === undefined ? undefined : json['city'] === null ? null : json['city'],
|
|
126
|
+
'postalCode': json['postalCode'] === undefined ? undefined : json['postalCode'] === null ? null : json['postalCode'],
|
|
127
|
+
'country': json['country'] === undefined ? undefined : json['country'] === null ? null : json['country'],
|
|
128
|
+
'primaryColor': json['primaryColor'] === undefined ? undefined : json['primaryColor'] === null ? null : json['primaryColor'],
|
|
129
|
+
'secondaryColor': json['secondaryColor'] === undefined ? undefined : json['secondaryColor'] === null ? null : json['secondaryColor'],
|
|
130
|
+
'name': json['name'],
|
|
131
|
+
'slug': json['slug'] == null ? undefined : json['slug'],
|
|
132
|
+
'useOrgCustoms': json['useOrgCustoms'] == null ? undefined : json['useOrgCustoms'],
|
|
133
|
+
};
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
export function CreateOrgBrandRequestToJSON(json: any): CreateOrgBrandRequest {
|
|
137
|
+
return CreateOrgBrandRequestToJSONTyped(json, false);
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
export function CreateOrgBrandRequestToJSONTyped(value?: CreateOrgBrandRequest | null, ignoreDiscriminator: boolean = false): any {
|
|
141
|
+
if (value == null) {
|
|
142
|
+
return value;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
return {
|
|
146
|
+
|
|
147
|
+
'companyName': value['companyName'],
|
|
148
|
+
'vatNumber': value['vatNumber'],
|
|
149
|
+
'customs': value['customs'],
|
|
150
|
+
'addressLine1': value['addressLine1'],
|
|
151
|
+
'addressLine2': value['addressLine2'],
|
|
152
|
+
'city': value['city'],
|
|
153
|
+
'postalCode': value['postalCode'],
|
|
154
|
+
'country': value['country'],
|
|
155
|
+
'primaryColor': value['primaryColor'],
|
|
156
|
+
'secondaryColor': value['secondaryColor'],
|
|
157
|
+
'name': value['name'],
|
|
158
|
+
'slug': value['slug'],
|
|
159
|
+
'useOrgCustoms': value['useOrgCustoms'],
|
|
160
|
+
};
|
|
161
|
+
}
|
|
162
|
+
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -89,13 +89,13 @@ export interface CreateShipment201ResponseParcelsInner {
|
|
|
89
89
|
*/
|
|
90
90
|
qrCodeLink?: string | null;
|
|
91
91
|
/**
|
|
92
|
-
* Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email.
|
|
92
|
+
* Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved.
|
|
93
93
|
* @type {string}
|
|
94
94
|
* @memberof CreateShipment201ResponseParcelsInner
|
|
95
95
|
*/
|
|
96
96
|
qrCodeDataUri?: string | null;
|
|
97
97
|
/**
|
|
98
|
-
* Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it.
|
|
98
|
+
* Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes.
|
|
99
99
|
* @type {string}
|
|
100
100
|
* @memberof CreateShipment201ResponseParcelsInner
|
|
101
101
|
*/
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -44,13 +44,13 @@ export interface CreateShipment201ResponseTracking {
|
|
|
44
44
|
*/
|
|
45
45
|
qrCodeLink?: string | null;
|
|
46
46
|
/**
|
|
47
|
-
* Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email.
|
|
47
|
+
* Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved.
|
|
48
48
|
* @type {string}
|
|
49
49
|
* @memberof CreateShipment201ResponseTracking
|
|
50
50
|
*/
|
|
51
51
|
qrCodeDataUri?: string | null;
|
|
52
52
|
/**
|
|
53
|
-
* Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it.
|
|
53
|
+
* Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes.
|
|
54
54
|
* @type {string}
|
|
55
55
|
* @memberof CreateShipment201ResponseTracking
|
|
56
56
|
*/
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -13,13 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
-
import type {
|
|
16
|
+
import type { CreateShippingRuleRequestAdditionalParametersValue } from './CreateShippingRuleRequestAdditionalParametersValue';
|
|
17
17
|
import {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
} from './
|
|
18
|
+
CreateShippingRuleRequestAdditionalParametersValueFromJSON,
|
|
19
|
+
CreateShippingRuleRequestAdditionalParametersValueFromJSONTyped,
|
|
20
|
+
CreateShippingRuleRequestAdditionalParametersValueToJSON,
|
|
21
|
+
CreateShippingRuleRequestAdditionalParametersValueToJSONTyped,
|
|
22
|
+
} from './CreateShippingRuleRequestAdditionalParametersValue';
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
25
|
*
|
|
@@ -47,10 +47,10 @@ export interface CreateShipmentRequestCarrierSettings {
|
|
|
47
47
|
services: Array<string>;
|
|
48
48
|
/**
|
|
49
49
|
* Carrier-specific extra parameters as key/value pairs.
|
|
50
|
-
* @type {{ [key: string]:
|
|
50
|
+
* @type {{ [key: string]: CreateShippingRuleRequestAdditionalParametersValue; }}
|
|
51
51
|
* @memberof CreateShipmentRequestCarrierSettings
|
|
52
52
|
*/
|
|
53
|
-
additionalParameters: { [key: string]:
|
|
53
|
+
additionalParameters: { [key: string]: CreateShippingRuleRequestAdditionalParametersValue; };
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
/**
|
|
@@ -77,7 +77,7 @@ export function CreateShipmentRequestCarrierSettingsFromJSONTyped(json: any, ign
|
|
|
77
77
|
'carrierId': json['carrierId'],
|
|
78
78
|
'productId': json['productId'],
|
|
79
79
|
'services': json['services'],
|
|
80
|
-
'additionalParameters': (mapValues(json['additionalParameters'],
|
|
80
|
+
'additionalParameters': (mapValues(json['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValueFromJSON)),
|
|
81
81
|
};
|
|
82
82
|
}
|
|
83
83
|
|
|
@@ -95,7 +95,7 @@ export function CreateShipmentRequestCarrierSettingsToJSONTyped(value?: CreateSh
|
|
|
95
95
|
'carrierId': value['carrierId'],
|
|
96
96
|
'productId': value['productId'],
|
|
97
97
|
'services': value['services'],
|
|
98
|
-
'additionalParameters': (mapValues(value['additionalParameters'],
|
|
98
|
+
'additionalParameters': (mapValues(value['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValueToJSON)),
|
|
99
99
|
};
|
|
100
100
|
}
|
|
101
101
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -89,13 +89,13 @@ export interface CreateShipmentRequestParcelsInner {
|
|
|
89
89
|
*/
|
|
90
90
|
qrCodeLink?: string | null;
|
|
91
91
|
/**
|
|
92
|
-
* Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email.
|
|
92
|
+
* Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Populated whenever the image bytes are available, including for carriers that host the image (it is fetched and inlined); null if the carrier published no QR code or its image could not be retrieved.
|
|
93
93
|
* @type {string}
|
|
94
94
|
* @memberof CreateShipmentRequestParcelsInner
|
|
95
95
|
*/
|
|
96
96
|
qrCodeDataUri?: string | null;
|
|
97
97
|
/**
|
|
98
|
-
* Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it.
|
|
98
|
+
* Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Independent of `qrCodeDataUri` — both are set when the hosted image was inlined successfully; null for carriers that only return embedded bytes.
|
|
99
99
|
* @type {string}
|
|
100
100
|
* @memberof CreateShipmentRequestParcelsInner
|
|
101
101
|
*/
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Zippendo Public API
|
|
5
|
-
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.
|
|
5
|
+
* Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0.0
|
|
8
8
|
* Contact: support@zippendo.com
|