{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "name": { "type": "string", "description": "key for referencing the carrier within shipcloud" }, "display_name": { "type": "string", "description": "name of the carrier you can use to display it in your application" }, "services": { "type": "array", "items": [ { "type": "string", "description": "key for referencing the service within shipcloud", "enum": ["standard", "one_day", "one_day_early", "returns", "cargo_international_express", "dhl_europaket", "dhl_prio", "dhl_warenpost", "dpag_warenpost", "dpag_warenpost_signature", "dpag_warenpost_untracked", "gls_express_0800", "gls_express_0900", "gls_express_1000", "gls_express_1200", "ups_express_1200"], "default": "standard" } ] }, "package_types": { "type": "array", "items": [ { "type": "string", "description": "key for referencing the package type within shipcloud", "enum": ["parcel", "bulk", "letter", "books", "parcel_letter"], "default": "parcel" } ] }, "additional_services": { "type": "array", "items": [ { "type": "string", "enum": ["angel_de_delivery_date_time", "asendia_bonus_tracking", "advance_notice", "cash_on_delivery", "dhl_endorsement", "dhl_gogreen", "dhl_ident_check", "dhl_named_person_only", "dhl_no_neighbor_delivery", "dhl_parcel_outlet_routing", "delivery_date", "drop_authorization", "dhl_preferred_neighbor", "premium_international", "visual_age_check", "saturday_delivery", "dpd_food", "hazardous_goods", "gls_guaranteed24service", "delivery_note", "delivery_time", "hermes_eilservice", "hermes_identservice", "ups_carbon_neutral", "ups_adult_signature", "ups_direct_delivery_only", "ups_signature_required"], "description": "key to identify the additional service" } ] }, "label_formats": { "type": "object", "properties": { "standard": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "one_day": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "one_day_early": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "returns": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "cargo_international_express": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "dhl_europaket": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "dhl_prio": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "dhl_warenpost": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "dpag_warenpost": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "dpag_warenpost_signature": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "dpag_warenpost_untracked": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "gls_express_0800": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "gls_express_0900": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "gls_express_1000": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "gls_express_1200": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } "ups_express_1200": { "type": "array", "items": [ { "type": "string", "enum": ["pdf_a5", "pdf_a6", "pdf_a7", "pdf_100x70mm", "pdf_103x199mm", "zpl2_4x6in_203dpi", "zpl2_4x6in_300dpi", "zpl2_100x70mm_203dpi", "zpl2_103x199mm_203dpi", "zpl2_4x8in_203dpi"], "description": "key to identify the label format" } ] } } } }, "required": [ "name", "display_name", "services", "package_types", "additional_services", "label_formats" ], "additionalProperties": false }