openapi-directory/api/shipengine.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.shipengine.com"}],"info":{"contact":{"email":"sales@shipengine.com","name":"ShipEngine Sales & Support","url":"https://www.shipengine.com/contact/","x-phone":"1-512-856-5379"},"description":"ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.\n\nEach of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.\n\n## Getting Started\nIf you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics.  Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips.\n\nHere are some step-by-step **tutorials** to get you started:\n\n  - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n  - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/)\n  - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/)\n  - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/)\n\n\n## Shipping Labels for Every Major Carrier\nShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/).\n\n\n## Real-Time Package Tracking\nWith ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is.\n\n\n## Compare Shipping Costs Across Carriers\nMake sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info.\n\n\n## Worldwide Address Validation\nShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.\n","termsOfService":"https://www.shipengine.com/terms-of-service/","title":"ShipEngine API","version":"1.1.202304191404","x-apisguru-categories":["transport"],"x-logo":{"altText":"ShipEngine logo","backgroundColor":"#FFFFFF","url":"https://www.shipengine.com/wp-content/themes/shipengine/assets/img/logo.svg"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.yaml","version":"3.0"}],"x-providerName":"shipengine.com"},"externalDocs":{"description":"ShipEngine's documentation is designed to help you start shipping as quickly as possible. With easy-to-follow tutorials, detailed reference docs, and ready-made recipes for common use cases, you'll see real results in no time at all.\n","url":"https://www.shipengine.com/docs/"},"security":[{"api_key":[]}],"tags":[{"description":"For additional information about the ShipEngine account. \n","name":"account","x-displayName":"Account"},{"description":"No matter your shipping volume, failed deliveries and address change surcharges cut into your bottom line and damage perception with customers. Our address validation services ensure your packages make it to the right place the first time. [Learn how to leverage our address validation services here.](https://www.shipengine.com/docs/addresses/validation/)\n\nShipEngine supports address validation for virtually every country on Earth, including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.\n","externalDocs":{"description":"Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.\n","url":"https://www.shipengine.com/docs/addresses/validation/"},"name":"addresses","x-displayName":"Addresses"},{"description":"batches\n","name":"batches","x-displayName":"Batches"},{"description":"carrier accounts\n","name":"carrier_accounts","x-displayName":"Carrier Accounts"},{"description":"carriers\n","name":"carriers","x-displayName":"Carriers"},{"description":"downloads\n","name":"downloads","x-displayName":"Downloads"},{"description":"insurance\n","name":"insurance","x-displayName":"Insurance"},{"description":"Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/) in the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n","externalDocs":{"description":"Follow this quick start guide to create your first shipping label with ShipEngine","url":"https://www.shipengine.com/docs/labels/create-a-label/"},"name":"labels","x-displayName":"Labels"},{"description":"manifests\n","name":"manifests","x-displayName":"Manifests"},{"description":"Scheduled package pickups","name":"package_pickups","x-displayName":"Package Pickups"},{"description":"custom package types\n","name":"package_types","x-displayName":"Package Types"},{"description":"Make sure you ship as cost-effectively as possible by [quickly comparing rates](https://www.shipengine.com/docs/rates/) using the ShipEngine Rates API. As long as you have the carrier connected to your account, you'll be able to see and compare different rates and services.\n","externalDocs":{"description":"This quick start guide shows you how to get shipping rates for multiple carriers so you can choose the fastest, cheapest, or most reliable option.\n","url":"https://www.shipengine.com/docs/rates/"},"name":"rates","x-displayName":"Rates"},{"name":"service_points","x-displayName":"Service Points"},{"description":"Shipments are at the center of the ShipEngine API.  A shipment is the first step in [creating a shipping label](https://www.shipengine.com/docs/labels/create-a-label/), or [creating a manifest](https://www.shipengine.com/docs/shipping/manifests/).  It's also essential for [getting shipping rates](https://www.shipengine.com/docs/rates/).\n","externalDocs":{"description":"Learn about the shipment object model concept, and how to persist and re-use shipment data inside ShipEngine.\n","url":"https://www.shipengine.com/docs/shipping/create-a-shipment/"},"name":"shipments","x-displayName":"Shipments"},{"description":"tags\n","name":"tags","x-displayName":"Tags"},{"name":"tokens","x-displayName":"Tokens"},{"description":"[Track packages](https://www.shipengine.com/docs/tracking/) across any of our 20+ supported carrier accounts and create tracking events to keep your customers up-to-date. Easily integrate real-time tracking information for shipments into your app, email, or SMS.\n","externalDocs":{"description":"Learn how to use ShipEngine to track any package with a carrier and a tracking number","url":"https://www.shipengine.com/docs/tracking/"},"name":"tracking","x-displayName":"Tracking"},{"description":"warehouses\n","name":"warehouses","x-displayName":"Warehouses"},{"description":"[Webhooks](https://www.shipengine.com/docs/tracking/webhooks/) are a powerful feature of ShipEngine that can save you from sending repeated polling requests to check on the state of something.  With webhooks, ShipEngine will automatically contact your servers when the stage changes.  This can include [parcel tracking](https://www.shipengine.com/docs/tracking/) events, notification of the completion of a [batch operation](https://www.shipengine.com/docs/labels/bulk/),  or new [salses orders](https://www.shipengine.com/docs/orders/).\n","externalDocs":{"description":"Learn how to setup webhooks and start listening to ShipEngine events.","url":"https://www.shipengine.com/docs/tracking/webhooks/"},"name":"webhooks","x-displayName":"Webhooks"}],"paths":{"/v1/account/settings":{"description":"ShipEngine Account settings","get":{"description":"List all account settings for the ShipEngine account","operationId":"list_account_settings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_account_settings_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"List Account Settings","tags":["account"]},"summary":"Account settings"},"/v1/account/settings/images":{"description":"ShipEngine Account images","get":{"description":"List all account images for the ShipEngine account","operationId":"list_account_images","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_account_settings_images_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"List Account Images","tags":["account"]},"post":{"description":"Create an Account Image","operationId":"create_account_image","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_account_settings_image_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_account_settings_images_response_body"}}},"description":"The requested object creation was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Create an Account Image","tags":["account"]},"summary":"Account settings images"},"/v1/account/settings/images/{label_image_id}":{"delete":{"description":"Delete Account Image By Id","operationId":"delete_account_image_by_id","parameters":[{"description":"Label Image Id","in":"path","name":"label_image_id","required":true,"schema":{"$ref":"#/components/schemas/image_id"}}],"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Delete Account Image By Id","tags":["account"]},"description":"ShipEngine Account images","get":{"description":"Retrieve information for an account image.","operationId":"get_account_settings_images_by_id","parameters":[{"description":"Label Image Id","in":"path","name":"label_image_id","required":true,"schema":{"$ref":"#/components/schemas/image_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_account_settings_images_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Account Image By ID","tags":["account"]},"put":{"description":"Update information for an account image.","operationId":"update_account_settings_images_by_id","parameters":[{"description":"Label Image Id","in":"path","name":"label_image_id","required":true,"schema":{"$ref":"#/components/schemas/image_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_account_settings_image_request_body"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Update Account Image By ID","tags":["account"]},"summary":"Account settings images"},"/v1/addresses/recognize":{"description":"Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful address data (e.g. recipient name, address line 1, line 2, city, postal code) from this unstructured text.\n","put":{"description":"The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more.\n\nData often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels.\n\n> **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.\n","operationId":"parse_address","requestBody":{"content":{"application/json":{"examples":{"some_known_fields":{"description":"You can optionally provide an `address` object containing any already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.\n","summary":"Some known fields","value":{"address":{"address_residential_indicator":"yes","country_code":"US"},"text":"Margie McMiller at 3800 North Lamar suite 200 in austin, tx.  The zip code there is 78652."}},"text_only":{"description":"This is the simplest way to call the address-recognition API. Just pass the text to be parsed and nothing else.\n","summary":"Text only","value":{"text":"Margie McMiller at 3800 North Lamar suite 200 in austin, tx.  The zip code there is 78652."}}},"schema":{"$ref":"#/components/schemas/parse_address_request_body"}}},"description":"The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.\n","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"some_known_fields":{"description":"This response is shows that the address-recognition API was able to recognize all the address entities in the text.  Notice that the `country_code` and `address_residential_indicator` fields are populated with the values that were provided in the request.\n","value":{"address":{"address_line1":"3800 North Lamar","address_line2":"Suite 200","address_residential_indicator":"yes","city_locality":"Austin","country_code":"US","name":"Margie McMiller","postal_code":78652,"state_province":"TX"},"entities":[{"end_index":14,"result":{"value":"Margie McMiller"},"score":0.9519646137063122,"start_index":0,"text":"Margie McMiller","type":"person"},{"end_index":34,"result":{"line":1,"value":"3800 North Lamar"},"score":0.9805313966503588,"start_index":19,"text":"3800 North Lamar","type":"address_line"},{"end_index":22,"result":{"type":"cardinal","value":3800},"score":0.9805313966503588,"start_index":19,"text":3800,"type":"number"},{"end_index":44,"result":{"line":2,"value":"Suite 200"},"score":1,"start_index":36,"text":"suite 200","type":"address_line"},{"end_index":44,"result":{"type":"cardinal","value":200},"score":0.9805313966503588,"start_index":42,"text":200,"type":"number"},{"end_index":54,"result":{"value":"Austin"},"score":0.9805313966503588,"start_index":49,"text":"austin","type":"city_locality"},{"end_index":58,"result":{"name":"Texas","value":"TX"},"score":0.6082904353940255,"start_index":57,"text":"tx","type":"state_province"},{"end_index":88,"result":{"value":78652},"score":0.9519646137063122,"start_index":84,"text":78652,"type":"postal_code"}],"score":0.9122137426845613}},"text_only":{"description":"This response shows that the address-recognition API was able to recognize all the address entities in the text.  Notice that the `country_code` is not populated and the `address_residential_indicator` is \"unknown\", since neither of these fields was included in the text.\n","value":{"address":{"address_line1":"3800 North Lamar","address_line2":"Suite 200","address_residential_indicator":"unknown","city_locality":"Austin","name":"Margie McMiller","postal_code":78652,"state_province":"TX"},"entities":[{"end_index":14,"result":{"value":"Margie McMiller"},"score":0.9519646137063122,"start_index":0,"text":"Margie McMiller","type":"person"},{"end_index":34,"result":{"line":1,"value":"3800 North Lamar"},"score":0.9805313966503588,"start_index":19,"text":"3800 North Lamar","type":"address_line"},{"end_index":22,"result":{"type":"cardinal","value":3800},"score":0.9805313966503588,"start_index":19,"text":3800,"type":"number"},{"end_index":44,"result":{"line":2,"value":"Suite 200"},"score":1,"start_index":36,"text":"suite 200","type":"address_line"},{"end_index":44,"result":{"type":"cardinal","value":200},"score":0.9805313966503588,"start_index":42,"text":200,"type":"number"},{"end_index":54,"result":{"value":"Austin"},"score":0.9805313966503588,"start_index":49,"text":"austin","type":"city_locality"},{"end_index":58,"result":{"name":"Texas","value":"TX"},"score":0.6082904353940255,"start_index":57,"text":"tx","type":"state_province"},{"end_index":88,"result":{"value":78652},"score":0.9519646137063122,"start_index":84,"text":78652,"type":"postal_code"}],"score":0.9122137426845613}}},"schema":{"$ref":"#/components/schemas/parse_address_response_body"}}},"description":"Returns the parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.\n"},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Parse an address","tags":["addresses"]},"summary":"Parse an address"},"/v1/addresses/validate":{"description":"Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges.\nShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.\n","post":{"description":"Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges.\nShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.\n","operationId":"validate_address","requestBody":{"content":{"application/json":{"examples":{"all_known_fields_request":{"description":"A call that returns a status of `verified`.","summary":"All Known Fields","value":[{"address_line1":"500 South Buena Vista Street","city_locality":"Burbank","company_name":"The Walt Disney Company","country_code":"US","name":"Mickey and Minnie Mouse","phone":"714-781-4565","postal_code":91521,"state_province":"CA"}]}},"schema":{"$ref":"#/components/schemas/validate_address_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"all_known_fields":{"description":"A response for a `verified` status call.","summary":"All Known Fields","value":[{"matched_address":{"address_line1":"500 S BUENA VISTA ST","address_line2":null,"address_line3":null,"address_residential_indicator":"no","city_locality":"BURBANK","company_name":"THE WALT DISNEY COMPANY","country_code":"US","name":"MICKEY AND MINNIE MOUSE","phone":"714-781-4565","postal_code":"91521-0007","state_province":"CA"},"messages":[],"original_address":{"address_line1":"500 South Buena Vista Street","address_line2":null,"address_line3":null,"address_residential_indicator":"unknown","city_locality":"Burbank","company_name":"The Walt Disney Company","country_code":"US","name":"Mickey and Minnie Mouse","phone":"714-781-4565","postal_code":91521,"state_province":"CA"},"status":"verified"}]},"empty_fields":{"description":"A response for an `unverified` API Call with error message","summary":"Empty Fields","value":[{"matched_address":null,"messages":[{"code":"a1001","detail_code":"unsupported_country","message":"country_code is not currently a supported country please check the documentation for acceptable 2-letter country codes.","type":"error"}],"original_address":{"address_line1":null,"address_line2":null,"address_line3":null,"address_residential_indicator":"unknown","city_locality":null,"company_name":null,"country_code":null,"name":null,"phone":null,"postal_code":null,"state_province":null},"status":"unverified"}]}},"schema":{"$ref":"#/components/schemas/validate_address_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Validate An Address","tags":["addresses"]},"summary":"Address Validation"},"/v1/batches":{"description":"Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time.\nWhen ShipEngine generates labels it relies on many carriers, their services, their dependencies, and a number of other variables\nto fulfill your requests; those requests can take a few minutes for us to get back to you.\n","get":{"description":"List Batches associated with your Shipengine account","operationId":"list_batches","parameters":[{"in":"query","name":"status","required":false,"schema":{"$ref":"#/components/schemas/batch_status"}},{"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\n","example":2,"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"The number of results to return per response.","example":50,"in":"query","name":"page_size","required":false,"schema":{"default":25,"format":"int32","minimum":1,"type":"integer"}},{"description":"Controls the sort order of the query.","in":"query","name":"sort_dir","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/sort_dir"}],"default":"desc"}},{"description":"Batch Number","in":"query","name":"batch_number","required":false,"schema":{"type":"string"}},{"in":"query","name":"sort_by","required":false,"schema":{"$ref":"#/components/schemas/batches_sort_by"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_batches_response_body"}}},"description":"The request was a success."},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"List Batches","tags":["batches"]},"post":{"description":"Create a Batch","operationId":"create_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_batch_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_batch_response_body"}}},"description":"The requested object creation was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Create A Batch","tags":["batches"]},"summary":"Batches"},"/v1/batches/external_batch_id/{external_batch_id}":{"description":"Retrive a batch from an external batch ID","get":{"description":"Get Batch By External ID","operationId":"get_batch_by_external_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_batch_by_external_id_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Batch By External ID","tags":["batches"]},"parameters":[{"example":"13553d7f-3c87-4771-bae1-c49bacef11cb","in":"path","name":"external_batch_id","required":true,"schema":{"type":"string"}}],"summary":"External Batch ID"},"/v1/batches/{batch_id}":{"delete":{"description":"Delete Batch By Id","operationId":"delete_batch","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Delete Batch By Id","tags":["batches"]},"description":"Check the status of your batch by retrieving it with a Batch ID.","get":{"description":"Get Batch By ID","operationId":"get_batch_by_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_batch_by_id_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Batch By ID","tags":["batches"]},"parameters":[{"description":"Batch ID","in":"path","name":"batch_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"put":{"description":"Update Batch By Id","operationId":"update_batch","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Update Batch By Id","tags":["batches"]},"summary":"Batch By ID"},"/v1/batches/{batch_id}/add":{"description":"You can check your balance for a particular carrier by calling [List Carriers](https://www.shipengine.com/docs/reference/list-carriers/) endpoint.\nFor any carrier account where requires_funded_amount is true, you can add funds.\n","parameters":[{"description":"Batch ID","in":"path","name":"batch_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"post":{"description":"Add a Shipment or Rate to a Batch","operationId":"add_to_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_to_batch_request_body"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Add to a Batch","tags":["batches"]},"summary":"Add Funds to a Carrier"},"/v1/batches/{batch_id}/errors":{"description":"Error handling in batches are handled differently than in a single synchronous request.\nYou must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.\n","get":{"description":"Error handling in batches are handled differently than in a single synchronous request.\nYou must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.\n","operationId":"list_batch_errors","parameters":[{"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.\n","example":2,"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"in":"query","name":"pagesize","required":false,"schema":{"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_batch_errors_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Batch Errors","tags":["batches"]},"parameters":[{"description":"Batch ID","in":"path","name":"batch_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"summary":"Batch Errors"},"/v1/batches/{batch_id}/process/labels":{"description":"Process Batch ID Labels","parameters":[{"description":"Batch ID","in":"path","name":"batch_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"post":{"description":"Process Batch ID Labels","operationId":"process_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/process_batch_request_body"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Process Batch ID Labels","tags":["batches"]},"summary":"Process Batch ID Labels"},"/v1/batches/{batch_id}/remove":{"description":"Remove a list of shipments from a batch","parameters":[{"description":"Batch ID","in":"path","name":"batch_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"post":{"description":"Remove a shipment or rate from a batch","operationId":"remove_from_batch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/remove_from_batch_request_body"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Remove From Batch","tags":["batches"]},"summary":"Remove Batch By ID"},"/v1/carriers":{"description":"Carriers are a company or individual that specializes in transporting freight from one destination to another.\nShipengine allows you to easily integrate with multiple carriers so you can chose the shipping option that is right for you.\n","get":{"description":"List all carriers that have been added to this account","operationId":"list_carriers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_carriers_response_body"}}},"description":"The request was a success."},"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_carriers_response_body"}}},"description":"The request was a partial success. It contains results, as well as errors."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"List Carriers","tags":["carriers"]},"summary":"Carriers"},"/v1/carriers/{carrier_id}":{"description":"Perform actions and get information on individual carriers connected with your account.","get":{"description":"Retrive carrier info by ID","operationId":"get_carrier_by_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_carrier_by_id_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Carrier By ID","tags":["carriers"]},"parameters":[{"description":"Carrier ID","example":"se-28529731","in":"path","name":"carrier_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"summary":"Individual carriers"},"/v1/carriers/{carrier_id}/add_funds":{"description":"All carriers require that funds to be attached to an account to ensure payment for the various services they provide to their customers.","parameters":[{"description":"Carrier ID","example":"se-28529731","in":"path","name":"carrier_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"put":{"description":"Add Funds To A Carrier","operationId":"add_funds_to_carrier","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_funds_to_carrier_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_funds_to_carrier_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Add Funds To Carrier","tags":["carriers"]},"summary":"Carrier Funds"},"/v1/carriers/{carrier_id}/options":{"description":"Carriers support various options for particular shipments. Ex. (non-machinable, is_alcohol, fragile, etc)","get":{"description":"Get a list of the options available for the carrier","operationId":"get_carrier_options","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_carrier_options_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Carrier Options","tags":["carriers"]},"parameters":[{"description":"Carrier ID","example":"se-28529731","in":"path","name":"carrier_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"summary":"Carrier Options"},"/v1/carriers/{carrier_id}/packages":{"description":"Carriers support many different package types, Shipengine supports retrieving all available package so that\nyou can best determine what is right for your particular shipment.\n","get":{"description":"List the package types associated with the carrier","operationId":"list_carrier_package_types","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_carrier_package_types_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"List Carrier Package Types","tags":["carriers"]},"parameters":[{"description":"Carrier ID","example":"se-28529731","in":"path","name":"carrier_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"summary":"Carrier Packages"},"/v1/carriers/{carrier_id}/services":{"description":"Carrier services usually refer to the various shipping options that a carrier provides to its customers.\nEx. Priority mail, overnight, international\n","get":{"description":"List the services associated with the carrier ID","operationId":"list_carrier_services","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_carrier_services_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"List Carrier Services","tags":["carriers"]},"parameters":[{"description":"Carrier ID","example":"se-28529731","in":"path","name":"carrier_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"summary":"Carrier Services"},"/v1/connections/carriers/{carrier_name}":{"description":"Carrier connections","parameters":[{"description":"The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.","example":"dhl_express","in":"path","name":"carrier_name","required":true,"schema":{"$ref":"#/components/schemas/carrier_name"}}],"post":{"description":"Connect a carrier account","operationId":"connect_carrier","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connect_carrier_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connect_carrier_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Connect a carrier account","tags":["carrier_accounts"]},"summary":"Carrier connections"},"/v1/connections/carriers/{carrier_name}/{carrier_id}":{"delete":{"description":"Disconnect a carrier","operationId":"disconnect_carrier","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Disconnect a carrier","tags":["carrier_accounts"]},"description":"Disconnect a carrier","parameters":[{"description":"The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.","example":"dhl_express","in":"path","name":"carrier_name","required":true,"schema":{"$ref":"#/components/schemas/carrier_name"}},{"description":"Carrier ID","example":"se-28529731","in":"path","name":"carrier_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"summary":"Disconnect a carrier"},"/v1/connections/carriers/{carrier_name}/{carrier_id}/settings":{"description":"Carrier settings","get":{"description":"Get carrier settings","operationId":"get_carrier_settings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_carrier_settings_response_body"}}},"description":"The request was a success."},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get carrier settings","tags":["carrier_accounts"]},"parameters":[{"description":"The carrier name, such as `ups`, `fedex`, or `dhl_express`.","example":"dhl_express","in":"path","name":"carrier_name","required":true,"schema":{"$ref":"#/components/schemas/carrier_name_with_settings"}},{"description":"Carrier ID","example":"se-28529731","in":"path","name":"carrier_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"put":{"description":"Update carrier settings","operationId":"update_carrier_settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_carrier_settings_request_body"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Update carrier settings","tags":["carrier_accounts"]},"summary":"Carrier settings"},"/v1/connections/insurance/shipsurance":{"delete":{"description":"Disconnect a Shipsurance Account","operationId":"disconnect_insurer","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disconnect_insurer_response_body"}}},"description":"The request was a success"},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Disconnect a Shipsurance Account","tags":["insurance"]},"description":"Shipsurance Connection","post":{"description":"Connect a Shipsurance Account","operationId":"connect_insurer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connect_insurer_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connect_insurer_response_body"}}},"description":"The request was a success"},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Connect a Shipsurance Account","tags":["insurance"]},"summary":"Shipsurance Connection"},"/v1/downloads/{dir}/{subdir}/{filename}":{"description":"This endpoint is used to download forms that are generated in the various pdf, png, zpl formats\nsuch as labels and batches\n","get":{"description":"Get File","operationId":"download_file","parameters":[{"in":"query","name":"download","required":false,"schema":{"type":"string"}},{"in":"query","name":"rotation","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/download_file_pdf_response_body"}},"application/zpl":{"schema":{"$ref":"#/components/schemas/download_file_zpl_response_body"}},"image/png":{"schema":{"$ref":"#/components/schemas/download_file_png_response_body"}}},"description":"The request was a success"},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Download File","tags":["downloads"]},"parameters":[{"in":"path","name":"subdir","required":true,"schema":{"type":"string"}},{"in":"path","name":"filename","required":true,"schema":{"type":"string"}},{"in":"path","name":"dir","required":true,"schema":{"type":"string"}}],"summary":"File Download"},"/v1/environment/webhooks":{"description":"ShipEngine exposes asynchronous operations for long running operations such as batch labels and rates.\nWebhooks allow the ShipEngine servers to contact your servers when an operation changes state, such as a batch label creation completion.\n","get":{"description":"List all webhooks currently enabled for the account.","operationId":"list_webhooks","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_webhooks_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"List Webhooks","tags":["webhooks"]},"post":{"description":"Create a webook for specific events in the environment.","operationId":"create_webhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_webhook_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_webhook_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"409":{"$ref":"#/components/responses/409_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Create a Webhook","tags":["webhooks"]},"summary":"Webhooks"},"/v1/environment/webhooks/{webhook_id}":{"delete":{"description":"Delete a webhook","operationId":"delete_webhook","responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Delete Webhook By ID","tags":["webhooks"]},"description":"Retrieve, update, and delete information for individual webhooks","get":{"description":"Retrieve individual webhook by an ID","operationId":"get_webhook_by_id","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_webhook_by_id_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Webhook By ID","tags":["webhooks"]},"parameters":[{"description":"Webhook ID","in":"path","name":"webhook_id","required":true,"schema":{"$ref":"#/components/schemas/se_id"}}],"put":{"description":"Update the webhook url property","operationId":"update_webhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_webhook_request_body"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response_body"}},"text/plain":{"schema":{"$ref":"#/components/schemas/empty_response_body"}}},"description":"The request was successful."},"400":{"$ref":"#/components/responses/400_error_response"},"404":{"$ref":"#/components/responses/404_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Update a Webhook","tags":["webhooks"]},"summary":"Webhook"},"/v1/insurance/shipsurance/add_funds":{"description":"[Shipsurance](https://www.shipsurance.com/) is a shipping insurance company offering coverage for shipments sent via the major shipping carriers worldwide.\n","patch":{"description":"You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100,\nand may want to add funds to insurance rather than keeping the account funded.\n","operationId":"add_funds_to_insurance","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_funds_to_insurance_request_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/add_funds_to_insurance_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Add Funds To Insurance","tags":["insurance"]},"summary":"Shipsurance"},"/v1/insurance/shipsurance/balance":{"description":"[Shipsurance](https://www.shipsurance.com/) is a shipping insurance company offering coverage for shipments sent via the major shipping carriers worldwide.\n","get":{"description":"Retrieve the balance of your Shipsurance account.","operationId":"get_insurance_balance","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_insurance_balance_response_body"}}},"description":"The request was a success."},"400":{"$ref":"#/components/responses/400_error_response"},"500":{"$ref":"#/components/responses/500_error_response"}},"summary":"Get Insurance Funds Balance","tags":["insurance"]},"summary":"Shipsurance"},"/v1/labels":{"description":"Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/)\nin the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n","get":{"description":"This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time.\n\nBy default, all labels are returned, 25 at a time, starting with the most recently created ones.  You can combine multiple filter options to narrow-down the results.  For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`\n","operationId":"list_labels","parameters":[{"description":"Only return labels that