shipengine-json-schema
Version:
The official JSON Schemas for ShipEngine™
252 lines • 7.86 kB
JSON
{
"$id": "get_carrier_settings_response_body",
"title": "get_carrier_settings_response_body",
"oneOf": [
{
"title": "dhl_express_settings_response_body",
"type": "object",
"additionalProperties": false,
"allOf": [
{
"title": "dhl_express_account_settings",
"type": "object",
"additionalProperties": false,
"properties": {
"nickname": {
"type": "string",
"minLength": 1
},
"should_hide_account_number_on_archive_doc": {
"type": "boolean"
},
"is_primary_account": {
"type": "boolean"
}
}
}
]
},
{
"title": "fedex_settings_response_body",
"type": "object",
"additionalProperties": false,
"allOf": [
{
"title": "fedex_account_settings_request_body",
"type": "object",
"additionalProperties": false,
"allOf": [
{
"title": "fedex_account_settings",
"type": "object",
"additionalProperties": false,
"properties": {
"nickname": {
"type": "string",
"minLength": 1
},
"pickup_type": {
"allOf": [
{
"title": "fedex_pickup_type",
"type": "string",
"enum": [
"none",
"regular_pickup",
"request_courier",
"drop_box",
"business_service_center",
"station"
]
}
]
},
"smart_post_hub": {
"allOf": [
{
"title": "smart_post_hub",
"type": "string",
"enum": [
"none",
"allentown_pa",
"atlanta_ga",
"baltimore_md",
"charlotte_nc",
"chino_ca",
"dallas_tx",
"denver_co",
"detroit_mi",
"edison_nj",
"grove_city_oh",
"groveport_oh",
"houston_tx",
"indianapolis_in",
"kansas_city_ks",
"los_angeles_ca",
"martinsburg_wv",
"memphis_tn",
"minneapolis_mn",
"new_berlin_wi",
"northborough_ma",
"orlando_fl",
"phoneix_az",
"pittsburgh_pa",
"reno_nv",
"sacramento_ca",
"salt_lake_city_ut",
"seattle_wa",
"st_louis_mo",
"windsor_ct",
"newark_ny",
"south_brunswick_nj",
"scranton_pa",
"wheeling_il"
]
}
]
},
"smart_post_endorsement": {
"allOf": [
{
"title": "ancillary_service_endorsement",
"type": "string",
"enum": [
"none",
"return_service_requested",
"forwarding_service_requested",
"address_service_requested",
"change_service_requested",
"leave_if_no_response"
]
}
]
},
"is_primary_account": {
"type": "boolean"
},
"signature_image": {
"type": "string"
},
"letterhead_image": {
"type": "string"
}
}
}
]
}
]
},
{
"title": "ups_settings_response_body",
"type": "object",
"additionalProperties": false,
"allOf": [
{
"title": "ups_account_settings",
"type": "object",
"additionalProperties": false,
"properties": {
"nickname": {
"type": "string",
"minLength": 1
},
"is_primary_account": {
"type": "boolean"
},
"pickup_type": {
"allOf": [
{
"title": "ups_pickup_type",
"type": "string",
"enum": [
"daily_pickup",
"occasional_pickup",
"customer_counter"
]
}
]
},
"use_carbon_neutral_shipping_program": {
"type": "boolean"
},
"use_ground_freight_pricing": {
"type": "boolean"
},
"use_consolidation_services": {
"type": "boolean"
},
"use_order_number_on_mail_innovations_labels": {
"type": "boolean"
},
"mail_innovations_endorsement": {
"allOf": [
{
"title": "ancillary_service_endorsement",
"type": "string",
"enum": [
"none",
"return_service_requested",
"forwarding_service_requested",
"address_service_requested",
"change_service_requested",
"leave_if_no_response"
]
}
]
},
"mail_innovations_cost_center": {
"type": "string",
"minLength": 0
},
"use_negotiated_rates": {
"type": "boolean"
},
"account_postal_code": {
"type": "string",
"minLength": 5
},
"invoice": {
"allOf": [
{
"title": "ups_invoice",
"type": "object",
"additionalProperties": false,
"properties": {
"invoice_date": {
"type": "string",
"format": "date-time",
"minLength": 1
},
"invoice_number": {
"type": "string",
"minLength": 1
},
"control_id": {
"allOf": [
{
"title": "se_id",
"type": "string",
"minLength": 1,
"maxLength": 25,
"pattern": "^se(-[a-z0-9]+)+$"
}
]
},
"invoice_amount": {
"type": "number",
"format": "double",
"minimum": 0
},
"invoice_currency_code": {
"type": "string"
}
}
}
]
}
}
}
]
}
]
}