Organizations

Organization Settings Model

The settings models are used for default values for many APIs. Typically, every setting here can be overridden on a per-request basis. Settings are nested on the organization model.

For example, to get settings for deliveries you would find it here: organization.settings.deliveries

Deliveries

settings.deliveries object

Show Details

lead_time_mins integer
Specifies the number of minutes required for the organization to initiate a pickup. This parameter is particularly relevant for organizations participating in the PackageX marketplace.

marketplace object
Details about the organization's status in the PackageX marketplace.

Show Details


application_status `string` Indicates the organization's current status in the PackageX marketplace. Defaults to `inactive`
rating `number` Represents the organization's rating on the PackageX marketplace. Defaults to `5`

notification_emails string[]
List of email addresses to receive delivery-related notifications

rates object[]
Collection of private rates associated with the organization's deliveries

Show Details


object `string` The description of the object. Defaults to `private_rate`
id `string` Unique identifier for the private rate.
name `string` Descriptive name for the private rate.
service_level `string` Defines the service level for the shipping rate.
packages `object[]` Collection of package specifications associated with this rate.

default_rate_id string
Identifier for the default shipping rate.

support_email string
Email address for delivery-related support.

support_phone string
Phone number for delivery support.

support_url string
Web URL for additional support resources.

chaining object

Show Details


default_status `string` Default tracking status for shipments. Defaults to `pickup_available`
reuse_tracking_number `boolean` Determines if tracking numbers can be reused.
label `string` Default label size. Defaults to `4x6`
default_parcel `object` Default parcel dimensions.

Default parcel object:


length `number` Parcel length.
width `number` Parcel width.
height `number` Parcel height.
weight `number` Parcel weight.

Fulfillments

settings.fulfillments object

Show Details

allow_partial boolean
Determines whether the organization permits partial order fulfillment when complete order processing is not immediately possible.

check_inventory boolean
Enables real-time inventory verification before order processing to ensure product availability.

require_pick_step boolean
Mandates a dedicated picking stage in the order fulfillment workflow, adding an additional verification layer.

check_parcel_weight boolean
Activates mandatory weight verification for parcels during the fulfillment process.

new_packing_slip_on_partial boolean
Generates a new packing slip when processing partial orders, ensuring accurate documentation.

next_order_number string
Tracks the next sequential order number for systematic order management.

predefined_packages object[]
A collection of pre-configured package specifications for standardized shipping preparation.

packing_slip object
Packing slip object.

Show Details


message `string` Custom message to be printed on packing slips.
size `string` Default packing slip size. Defaults to `4x6`

service_levels string[]
Supported service levels for order fulfillment

Predefined Packages

settings.predefined_packages object

Show Details

predefined_packages object[]
A collection of pre-configured package specifications for standardized shipping preparation.

Show Details

id string
Unique identifier for the predefined package.

name string
Human-readable name of the predefined package.

length number
Package length dimension in inches.

width number
Package width dimension in inches.

height number
Package height dimension in inches.

max_weight_domestic number
Maximum weight limit for domestic shipments.

max_weight_international number
Maximum weight limit for international shipments.

provider string
Identifier of the associated shipping provider.

type string
Package type identifier. Currently set to be the same as id

Locations

settings.locations object

Show Details

layouts object

Show Details


locked `boolean` Determines whether location layouts are locked, preventing unauthorized modifications to spatial configurations

Manifests

settings.manifests object

Show Details

next_manifest_number number
Defines the next sequential number for manifest identification.

shipments_verify_addresses boolean
Activates comprehensive address validation for shipments, reducing potential delivery errors and improving shipping accuracy.

active_special_handling_tags string[]
Maintains a list of active special handling instructions for unique shipping requirements.

create_trackers string[]
Automatically generates trackers for shipments.

Scans

settings.scans object

Show Details

shipping_label object
Shipping label object.

Show Details

postprocess object
Post-process object.

Show Details


postprocess.parse_addresses `string[]` Defines which contact types to parse from shipping labels.
postprocess.required_scan_properties `string[]` Specifies mandatory properties that must be present in the scan.
postprocess.require_unique_hash `boolean` Ensures each scanned document has a unique identification hash.
postprocess.substring_set_options `string[]` Defines specific substring options for advanced document parsing.
postprocess.require_substring_order `string` Determines whether substring matching requires strict order preservation. Defaults to `false`

match object
Match object.

Show Details


matchsearch `string` Specifies the search strategy for document matching.
matchsearch_score_threshold `number` Minimum matching score required for document validation. Defaults to `0.8`
matchuse_best_match `boolean` Enables selection of the most optimal document match. Defaults to `true`
matchlocation `boolean` Ensures comprehensive matching across all possible options.
matchexhaust_all `boolean` Ensures comprehensive matching across all possible options.
matchrequired_match_properties `string[]` Specifies properties that must be matched for document validation.

transform object
Transformation for processing shipping label scans

bill_of_lading object

Show Details

postprocess object
Post-process object.

Show Details


postprocess.parse_addresses `string[]` Defines which contact types to parse from shipping labels.
postprocess.required_scan_properties `string[]` Specifies mandatory properties that must be present in the scan.
postprocess.require_unique_hash `boolean` Ensures each scanned document has a unique identification hash.
postprocess.substring_set_options `string[]` Defines specific substring options for advanced document parsing.
postprocess.require_substring_order `string` Determines whether substring matching requires strict order preservation. Defaults to `false`

match object
Match object.

Show Details


match.search `string` Specifies the search strategy for document matching.
match.search_score_threshold `number` Minimum matching score required for document validation. Defaults to `0.8`
match.use_best_match `boolean` Enables selection of the most optimal document match. Defaults to `true`
match.location `boolean` Ensures comprehensive matching across all possible options.
match.exhaust_all `boolean` Ensures comprehensive matching across all possible options.
match.required_match_properties `string[]` Specifies properties that must be matched for document validation.

transform object
Transformation for processing shipping label scans

Shipping Label Inferences

settings.inferences object

Show Details

shipping_label object
Shipping label object.

Show Details

postprocess object
Post-process object.

Show Details


postprocess.parse_addresses `string[]` Defines which contact types to parse from shipping labels.
postprocess.required_properties `string[]` Defines mandatory properties that must be present in the scanned document.
postprocess.require_unique_hash `boolean` Ensures each scanned document has a unique identification hash.
postprocess.extraction_status `string` Indicates the current status of document information extraction.

match object
Match object.

Show Details


matchsearch `string` Specifies the search strategy for document matching.
matchsearch_score_threshold `number` Minimum matching score required for document validation. Defaults to `0.8`
matchuse_best_match `boolean` Enables selection of the most optimal document match. Defaults to `true`
matchthrow_recipient_match_error `boolean` Determines error handling for recipient matching.
matchthrow_sender_match_error `boolean` Determines error handling for sender matching.
matchlocation `boolean` Ensures comprehensive matching across all possible options.
matchrequired_properties `string[]` Specifies properties that must be matched for document validation.

tracker object
Tracker object.

Show Details


match.status `string` Initial tracking status for the shipment.
match.create_automatically `boolean` Determines whether tracking is automatically generated.
match.type `string` Tracking type.
match.use_existing_tracking_number `boolean` Option to utilize existing tracking numbers.
match.chained_status `string` Default status for chained tracking. Defaults to `package_at_waypoint`
match.auto_close_shipments_option `string` Criteria for automatic shipment closure. Defaults to `on_provider_updates`
match.auto_close_shipments_status `string` Status triggering shipment closure. Defaults to `delivered`

transform object
Defines custom transformation rules for tracking information

Show Details


match.tracker `string` Tracking type.
match.use_existing_tracking_number `boolean` Option to utilize existing tracking numbers.

exceptions_enabled boolean
Activates advanced exception handling for inference processes.

Recipient Notifications

settings.recipient_notifications object

Show Details

tracking_statuses string[]
Specifies the precise shipment statuses that trigger recipient notifications.

methods string[]
Defines the communication channels used for sending shipment updates. Defaults to email

email_template object
The email template settings provide granular control over notification aesthetics and personalization.

Show Details


email_template.use_logo `boolean` Determines whether organizational logo is included in email notifications.
email_template.use_social_media `boolean` Enables or disables social media link integration in email templates.
email_template.use_name `boolean` Activates personalized recipient naming in notifications.

delay_mins number
Specifies the minimum time delay between notification dispatches.

use_batches boolean
Enables grouped notification dispatches to optimize communication efficiency.

pickup_reminders object
The pickup reminder configuration provides sophisticated options for proactive communication.

Show Details


pickup_reminders.interval_mins `number` Time interval between successive pickup reminders.
pickup_reminders.max_reminder_count `number` Maximum number of reminder notifications sent. Defaults to `3`
pickup_reminders.check_contact_availability `boolean` Ensures reminders are sent only when contact is available.
pickup_reminders.check_location_availability `boolean` Validates location readiness before sending pickup reminders.

curbside_pickup object

Show Details


curbside_pickup.message_template `string` Customizable message template for curbside pickup notifications.
curbside_pickup.reply_trigger `string` Specifies the response mechanism for initiating curbside pickup

Trackers

settings.trackers object

Show Details

defaults object
Tracker default settings.

Show Details


match.chained_status `string` Default status for chained tracking. Defaults to `package_at_waypoint`
match.auto_close_shipments_option `string` Criteria for automatic shipment closure. Defaults to `on_provider_updates`
match.auto_close_shipments_status `string` Status triggering shipment closure. Defaults to `delivered`

Shipments

settings.shipments object

Show Details

service_levels string[]
Defines the available shipping service levels for the organization.

labels object

Show Details


labels.format `string` Specifies the file format for shipping labels. Defaults to `pdf`
labels.size `string` Determines the standard size for printed shipping labels. Defaults to `letter`
labels.autoprint `boolean` Enables automatic label printing during shipment processing

same_day_tip_amount number
Additional fee for expedited same-day shipping services

easy_post_api_key string
Your easy post API key. Add test key for test environment and Production key for production.

ups_carrier_account_id string
UPS Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

ups_surepost_carrier_account_id string
UPS surepost carrier account ID.

fedex_carrier_account_id string
FedEx Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

usps_carrier_account_id string
USPS Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

dhl_carrier_account_id string
DHL Carrier account ID, which belongs to the same account as your easypost API key. "ca_.."

marketplace object
Marketplace object.

Show Details


marketplace.min_rating `number` Minimum carrier rating. Defaults to `4`
marketplace.rate_count `number` Number of rates to compare. Defaults to `5`
marketplace.sort_by `string` Primary sorting criterion for shipping rates.

upcharging object
Upcharging Object

Show Details


upcharging.active `boolean` Enables or disables upcharging.
upcharging.min `number` Minimum upcharge amount.
upcharging.max `number` Maximum upcharge amount.
upcharging.max `string` Upcharging calculation method (`"curve"` or `percent`). Defaults to `curve`
upcharging.percent `float` Percentage-based upcharge. Defaults to `5`
upcharging.multiplier `float` Calculation multiplier for pricing. Defaults to `3.5`

sort_by string
Sort by fastest_shipping

defaults object
Defaults object.

Show Details

parcel object
The parcel defaults establish standard dimensional and weight characteristics.

Show Details


parcel.type `string` Defines the standard packaging type.
parcel.length `number` Specifies the default parcel length.
parcel.width `number` Specifies the default parcel width.
parcel.height `number` Specifies the default parcel height.
parcel.weight `number` Specifies the default parcel weight.

recipient object
The recipient defaults include comprehensive contact information

Show Details


recipient.name `string` Default recipient name.
recipient.email `string` Default recipient email.
recipient.phone `string` Default recipient phone.
recipient.address `string` Default recipient address.

sender object
The sender defaults include comprehensive contact information

Show Details


sender.name `string` Default sender name.
sender.email `string` Default sender email.
sender.phone `string` Default sender phone.
sender.address `string` Default sender address.

status object

Show Details


status.outstanding_for_60_days `string` Status of the shipment which remained unresolved after 60 days.

return_other_rates boolean
Allows system to provide alternative shipping rate options.

Contacts

settings.contacts object

Show Details

contacts object
Contacts Object

Show Details

create_via_recipient boolean
Determines whether new contacts can be automatically created through recipient.

settings.login object

Show Details

login_sso_required_preference string
Defines the default SSO login policy.

logout_after_hours number
Maximum duration (in hours) a user session can remain active.

logout_after_inactivity_hours number
Session timeout duration after user inactivity.

sp_saml_entity_id string
Unique identifier in SAML authentication

sp_auth_callback string
Endpoint for handling Single Sign-On (SSO) authentication responses.

domains object[]
Collection of authorized domains.

Show Details

id string
Unique identifier for the domain.

object "domain"
The description of the model.

name string
Human-readable name of the domain.

organization_id string
Identifier of the associated organization.

status string
Current status of the domain.

profile_require_approval boolean
Determines if profile creation requires additional approval. Undefined if domain status is either allowed or blocked

profile_role_default string
Default role assigned to profiles in this domain. Undefined if domain status is either allowed or blocked

ownership_verification_key string
Unique key for domain ownership verification. Undefined if domain status is either allowed or blocked or leased

ownership_verified boolean
Indicates whether domain ownership has been verified. Undefined if domain status is either allowed or blocked or leased

ownership_verified_at date
Timestamp of domain ownership verification. Undefined if domain status is either allowed or blocked or leased

sso_id string
SSO configuration identifier. Undefined if domain status is either allowed or blocked or leased

sso_name string
Name of the SSO configuration. Undefined if domain status is either allowed or blocked or leased

sso_type string
Type of SSO configuration. Undefined if domain status is either allowed or blocked or leased

sso_identity_provider string
Identity provider details. Undefined if domain status is either allowed or blocked or leased

created_at integer
Time in epoch seconds when this resource was created.

updated_at integer
Time in epoch seconds when this resource was updated.

updated_by string
The ID of the user or key who last updated this resource.

checksum string
A hash value computed from the current organization setting configuration. This value gets updated whenever the organization setting updates.

sso_configurations object[]
Detailed Single Sign-On configuration.

Show Details

id string
Unique identifier for the SSO configuration.

object "sso"
The description of the model.

name string
Human-readable name for the SSO configuration.

organization_id string
Identifier of the associated organization.

type string
Specifies the Single Sign-On type.

identity_provider string
Name or identifier of the identity provider.

idp_oidc_client_id string
Client identifier for OIDC authentication. Undefined if sso type is saml

idp_oidc_issuer_url string
Issuer URL for the OIDC identity provider. Undefined if sso type is saml

idp_oidc_client_secret string
Client secret for OIDC authentication. Undefined if sso type is saml

idp_saml_entity_id string
Unique identifier for the SAML identity provider. Undefined if sso type is oidc

idp_saml_sso_url string
Single Sign-On URL for SAML authentication. Undefined if sso type is oidc

idp_saml_certificate string
Certificate for SAML authentication. Undefined if sso type is oidc

domains object[]
Collection of domains associated with this SSO configuration.