shipengine-json-schema

{ "/v1/addresses/recognize": { "put": { "name": "parse_address", "requestSchema": "requests/parse_address_request_body.json", "responseSchemas": { "200": "responses/parse_address_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/addresses/validate": { "post": { "name": "validate_address", "requestSchema": "requests/validate_address_request_body.json", "responseSchemas": { "200": "responses/validate_address_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/batches": { "get": { "name": "list_batches", "requestSchema": null, "responseSchemas": { "200": "responses/list_batches_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "post": { "name": "create_batch", "requestSchema": "requests/create_batch_request_body.json", "responseSchemas": { "200": "responses/create_batch_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/batches/external_batch_id/{external_batch_id}": { "get": { "name": "get_batch_by_external_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_batch_by_external_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/batches/{batch_id}": { "get": { "name": "get_batch_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_batch_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "put": { "name": "update_batch", "requestSchema": null, "responseSchemas": { "204": "responses/update_batch_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "delete": { "name": "delete_batch", "requestSchema": null, "responseSchemas": { "204": "responses/delete_batch_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/batches/{batch_id}/add": { "post": { "name": "add_to_batch", "requestSchema": "requests/add_to_batch_request_body.json", "responseSchemas": { "204": "responses/add_to_batch_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/batches/{batch_id}/errors": { "get": { "name": "list_batch_errors", "requestSchema": null, "responseSchemas": { "200": "responses/list_batch_errors_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/batches/{batch_id}/process/labels": { "post": { "name": "process_batch", "requestSchema": "requests/process_batch_request_body.json", "responseSchemas": { "204": "responses/process_batch_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/batches/{batch_id}/remove": { "post": { "name": "remove_from_batch", "requestSchema": "requests/remove_from_batch_request_body.json", "responseSchemas": { "204": "responses/remove_from_batch_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/carriers": { "get": { "name": "list_carriers", "requestSchema": null, "responseSchemas": { "207": "responses/list_carriers_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/carriers/{carrier_id}": { "get": { "name": "get_carrier_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_carrier_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/carriers/{carrier_id}/add_funds": { "put": { "name": "add_funds_to_carrier", "requestSchema": "requests/add_funds_to_carrier_request_body.json", "responseSchemas": { "200": "responses/add_funds_to_carrier_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/carriers/{carrier_id}/options": { "get": { "name": "get_carrier_options", "requestSchema": null, "responseSchemas": { "200": "responses/get_carrier_options_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/carriers/{carrier_id}/packages": { "get": { "name": "list_carrier_package_types", "requestSchema": null, "responseSchemas": { "200": "responses/list_carrier_package_types_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/carriers/{carrier_id}/services": { "get": { "name": "list_carrier_services", "requestSchema": null, "responseSchemas": { "200": "responses/list_carrier_services_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/connections/carriers/{carrier_name}": { "post": { "name": "connect_carrier", "requestSchema": "requests/connect_carrier_request_body.json", "responseSchemas": { "200": "responses/connect_carrier_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/connections/carriers/{carrier_name}/{carrier_id}": { "delete": { "name": "disconnect_carrier", "requestSchema": null, "responseSchemas": { "204": "responses/disconnect_carrier_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/connections/carriers/{carrier_name}/{carrier_id}/settings": { "get": { "name": "get_carrier_settings", "requestSchema": null, "responseSchemas": { "200": "responses/get_carrier_settings_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "put": { "name": "update_carrier_settings", "requestSchema": "requests/update_carrier_settings_request_body.json", "responseSchemas": { "204": "responses/update_carrier_settings_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/connections/insurance/shipsurance": { "post": { "name": "connect_insurer", "requestSchema": "requests/connect_insurer_request_body.json", "responseSchemas": { "200": "responses/connect_insurer_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "delete": { "name": "disconnect_insurer", "requestSchema": null, "responseSchemas": { "200": "responses/disconnect_insurer_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/downloads/{dir}/{subdir}/{filename}": { "get": { "name": "download_file", "requestSchema": null, "responseSchemas": { "200": "responses/download_file_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/environment/webhooks": { "get": { "name": "list_webhooks", "requestSchema": null, "responseSchemas": { "200": "responses/list_webhooks_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "post": { "name": "create_webhook", "requestSchema": "requests/create_webhook_request_body.json", "responseSchemas": { "200": "responses/create_webhook_response_body.json", "400": "responses/400_error_response_body.json", "409": "responses/409_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/environment/webhooks/{webhook_id}": { "get": { "name": "get_webhook_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_webhook_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "put": { "name": "update_webhook", "requestSchema": "requests/update_webhook_request_body.json", "responseSchemas": { "204": "responses/update_webhook_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "delete": { "name": "delete_webhook", "requestSchema": null, "responseSchemas": { "204": "responses/delete_webhook_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/insurance/shipsurance/add_funds": { "patch": { "name": "add_funds_to_insurance", "requestSchema": "requests/add_funds_to_insurance_request_body.json", "responseSchemas": { "200": "responses/add_funds_to_insurance_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/insurance/shipsurance/balance": { "get": { "name": "get_insurance_balance", "requestSchema": null, "responseSchemas": { "200": "responses/get_insurance_balance_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels": { "get": { "name": "list_labels", "requestSchema": null, "responseSchemas": { "200": "responses/list_labels_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "post": { "name": "create_label", "requestSchema": "requests/create_label_request_body.json", "responseSchemas": { "200": "responses/create_label_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels/external_shipment_id/{external_shipment_id}": { "get": { "name": "get_label_by_external_shipment_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_label_by_external_shipment_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels/rates/{rate_id}": { "post": { "name": "create_label_from_rate", "requestSchema": "requests/create_label_from_rate_request_body.json", "responseSchemas": { "200": "responses/create_label_from_rate_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels/shipment/{shipment_id}": { "post": { "name": "create_label_from_shipment", "requestSchema": "requests/create_label_from_shipment_request_body.json", "responseSchemas": { "200": "responses/create_label_from_shipment_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels/{label_id}": { "get": { "name": "get_label_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_label_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels/{label_id}/return": { "post": { "name": "create_return_label", "requestSchema": "requests/create_return_label_request_body.json", "responseSchemas": { "200": "responses/create_return_label_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels/{label_id}/track": { "get": { "name": "get_tracking_log_from_label", "requestSchema": null, "responseSchemas": { "200": "responses/get_tracking_log_from_label_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/labels/{label_id}/void": { "put": { "name": "void_label", "requestSchema": null, "responseSchemas": { "200": "responses/void_label_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/manifests": { "get": { "name": "list_manifests", "requestSchema": null, "responseSchemas": { "200": "responses/list_manifests_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "post": { "name": "create_manifest", "requestSchema": "requests/create_manifest_request_body.json", "responseSchemas": { "200": "responses/create_manifest_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/manifests/{manifest_id}": { "get": { "name": "get_manifest_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_manifest_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/manifests/requests/{manifest_request_id}": { "get": { "name": "get_manifest_request_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_manifest_request_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/packages": { "get": { "name": "list_package_types", "requestSchema": null, "responseSchemas": { "200": "responses/list_package_types_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "post": { "name": "create_package_type", "requestSchema": "requests/create_package_type_request_body.json", "responseSchemas": { "200": "responses/create_package_type_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/packages/{package_id}": { "get": { "name": "get_package_type_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_package_type_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "put": { "name": "update_package_type", "requestSchema": "requests/update_package_type_request_body.json", "responseSchemas": { "204": "responses/update_package_type_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "delete": { "name": "delete_package_type", "requestSchema": null, "responseSchemas": { "204": "responses/delete_package_type_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/rates": { "post": { "name": "calculate_rates", "requestSchema": "requests/calculate_rates_request_body.json", "responseSchemas": { "200": "responses/calculate_rates_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/rates/bulk": { "post": { "name": "compare_bulk_rates", "requestSchema": "requests/compare_bulk_rates_request_body.json", "responseSchemas": { "200": "responses/compare_bulk_rates_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/rates/estimate": { "post": { "name": "estimate_rates", "requestSchema": "requests/estimate_rates_request_body.json", "responseSchemas": { "200": "responses/estimate_rates_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/rates/{rate_id}": { "get": { "name": "get_rate_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_rate_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/relay_points": { "get": { "name": "relay_points_list", "requestSchema": null, "responseSchemas": { "200": "responses/relay_points_list_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/shipments": { "get": { "name": "list_shipments", "requestSchema": null, "responseSchemas": { "200": "responses/list_shipments_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "post": { "name": "create_shipments", "requestSchema": "requests/create_shipments_request_body.json", "responseSchemas": { "200": "responses/create_shipments_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/shipments/external_shipment_id/{external_shipment_id}": { "get": { "name": "get_shipment_by_external_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_shipment_by_external_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/shipments/recognize": { "put": { "name": "parse_shipment", "requestSchema": "requests/parse_shipment_request_body.json", "responseSchemas": { "200": "responses/parse_shipment_response_body.json", "400": "responses/400_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/shipments/{shipment_id}": { "get": { "name": "get_shipment_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_shipment_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "put": { "name": "update_shipment", "requestSchema": "requests/update_shipment_request_body.json", "responseSchemas": { "200": "responses/update_shipment_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/shipments/{shipment_id}/cancel": { "put": { "name": "cancel_shipments", "requestSchema": null, "responseSchemas": { "204": "responses/cancel_shipments_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/shipments/{shipment_id}/rates": { "get": { "name": "list_shipment_rates", "requestSchema": null, "responseSchemas": { "200": "responses/list_shipment_rates_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/shipments/{shipment_id}/tags/{tag_name}": { "post": { "name": "tag_shipment", "requestSchema": null, "responseSchemas": { "200": "responses/tag_shipment_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "delete": { "name": "untag_shipment", "requestSchema": null, "responseSchemas": { "204": "responses/untag_shipment_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/tags": { "get": { "name": "list_tags", "requestSchema": null, "responseSchemas": { "200": "responses/list_tags_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/tags/{tag_name}": { "post": { "name": "create_tag", "requestSchema": null, "responseSchemas": { "200": "responses/create_tag_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "delete": { "name": "delete_tag", "requestSchema": null, "responseSchemas": { "204": "responses/delete_tag_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/tags/{tag_name}/{new_tag_name}": { "put": { "name": "rename_tag", "requestSchema": null, "responseSchemas": { "204": "responses/rename_tag_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/tokens/ephemeral": { "post": { "name": "tokens_get_ephemeral_token", "requestSchema": null, "responseSchemas": { "200": "responses/tokens_get_ephemeral_token_response_body.json" } } }, "/v1/tracking": { "get": { "name": "get_tracking_log", "requestSchema": null, "responseSchemas": { "200": "responses/get_tracking_log_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/tracking/start": { "post": { "name": "start_tracking", "requestSchema": null, "responseSchemas": { "204": "responses/start_tracking_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/tracking/stop": { "post": { "name": "stop_tracking", "requestSchema": null, "responseSchemas": { "204": "responses/stop_tracking_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/warehouses": { "get": { "name": "list_warehouses", "requestSchema": null, "responseSchemas": { "200": "responses/list_warehouses_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "post": { "name": "create_warehouse", "requestSchema": "requests/create_warehouse_request_body.json", "responseSchemas": { "200": "responses/create_warehouse_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } }, "/v1/warehouses/{warehouse_id}": { "get": { "name": "get_warehouse_by_id", "requestSchema": null, "responseSchemas": { "200": "responses/get_warehouse_by_id_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "put": { "name": "update_warehouse", "requestSchema": "requests/update_warehouse_request_body.json", "responseSchemas": { "204": "responses/update_warehouse_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } }, "delete": { "name": "delete_warehouse", "requestSchema": null, "responseSchemas": { "204": "responses/delete_warehouse_response_body.json", "400": "responses/400_error_response_body.json", "404": "responses/404_error_response_body.json", "500": "responses/500_error_response_body.json" } } } }