Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.shipengine.com
/v1/account/settings/images
Create an Account Image
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/account_settings_images"
}
}
},
"required": true
}
POST /v1/account/settings/images
/v1/addresses/validate
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.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/validate_address_request_body"
},
"examples": {
"all_known_fields_request": {
"value": [
{
"name": "Mickey and Minnie Mouse",
"phone": "714-781-4565",
"postal_code": 91521,
"company_name": "The Walt Disney Company",
"country_code": "US",
"address_line1": "500 South Buena Vista Street",
"city_locality": "Burbank",
"state_province": "CA"
}
],
"summary": "All Known Fields",
"description": "A call that returns a status of `verified`."
}
}
}
},
"required": true
}
POST /v1/addresses/validate
/v1/batches
Create a Batch
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create_batch_request"
}
}
},
"required": true
}
POST /v1/batches
/v1/batches/{batch_id}/add
Add a Shipment or Rate to a Batch
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/modify_batch"
}
}
},
"required": true
}
POST /v1/batches/{batch_id}/add
/v1/batches/{batch_id}/process/labels
Process Batch ID Labels
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/process_batch_request_body"
}
}
},
"required": true
}
POST /v1/batches/{batch_id}/process/labels
/v1/batches/{batch_id}/remove
Remove a shipment or rate from a batch
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/modify_batch"
}
}
},
"required": true
}
POST /v1/batches/{batch_id}/remove
/v1/connections/carriers/{carrier_name}
Connect a carrier account
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/connect_carrier_request_body"
}
}
},
"required": true
}
POST /v1/connections/carriers/{carrier_name}
/v1/connections/insurance/shipsurance
Connect a Shipsurance Account
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/connect_insurer_request_body"
}
}
},
"required": true
}
POST /v1/connections/insurance/shipsurance
/v1/labels
Purchase and print a label for shipment
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/label"
}
}
},
"required": true
}
POST /v1/labels
/v1/labels/rates/{rate_id}
When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/purchase_label_without_shipment"
}
}
},
"required": true
}
POST /v1/labels/rates/{rate_id}
/v1/labels/shipment/{shipment_id}
Purchase a label using a shipment ID that has already been created with the desired address and package info.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create_label_from_shipment_request_body"
}
}
},
"required": true
}
POST /v1/labels/shipment/{shipment_id}
/v1/labels/{label_id}/return
Create a return label
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create_return_label_request_body"
}
}
},
"required": true
}
POST /v1/labels/{label_id}/return
/v1/manifests
Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create_manifest_request_body"
}
}
},
"required": true
}
POST /v1/manifests
/v1/pickups
Schedule a package pickup with a carrier
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pickup"
}
}
},
"required": true
}
POST /v1/pickups
/v1/packages
Create a custom package type to better assist in getting accurate rate estimates
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/package_type"
}
}
},
"required": true
}
POST /v1/packages
/v1/rates
It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rate_request_options"
}
}
},
"required": true
}
POST /v1/rates
/v1/rates/bulk
Get Bulk Shipment Rates
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rate_request_rate_options"
}
}
},
"required": true
}
POST /v1/rates/bulk
/v1/rates/estimate
Get Rate Estimates
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/rate_estimate_options"
}
}
},
"required": true
}
POST /v1/rates/estimate
/v1/service_points/list
List carrier service points by location
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/get_service_points_request"
}
}
},
"required": true
}
POST /v1/service_points/list
/v1/shipments
Create one or multiple shipments.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create_shipments_request_body"
}
}
},
"required": true
}
POST /v1/shipments
/v1/shipments/{shipment_id}/tags/{tag_name}
Add a tag to the shipment object
POST /v1/shipments/{shipment_id}/tags/{tag_name}
/v1/tags/{tag_name}
Create a new Tag for customizing how you track your shipments
POST /v1/tags/{tag_name}
/v1/tokens/ephemeral
This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| redirect | query | optional | Include a redirect url to the application formatted with the ephemeral token. |
POST /v1/tokens/ephemeral
/v1/tracking/start
Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| carrier_code | query | optional | string | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. |
| tracking_number | query | optional | string | The tracking number associated with a shipment |
POST /v1/tracking/start
/v1/tracking/stop
Unsubscribe from tracking updates for a package.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| carrier_code | query | optional | string | A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. |
| tracking_number | query | optional | string | The tracking number associated with a shipment |
POST /v1/tracking/stop
/v1/warehouses
Create a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied in the request body then it is assumed that the origin address is the return address as well
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/warehouse"
}
}
},
"required": true
}
POST /v1/warehouses
/v1/environment/webhooks
Create a webook for specific events in the environment.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create_webhook_request_body"
}
}
},
"required": true
}
POST /v1/environment/webhooks
Allowed incoterms
{
"enum": [
"exw",
"fca",
"cpt",
"cip",
"dpu",
"dap",
"ddp",
"fas",
"fob",
"cfr",
"cif",
"ddu",
"daf",
"deq",
"des"
],
"type": "string",
"title": "Allowed incoterms"
}
account_settings
{
"type": "object",
"title": "account_settings",
"properties": {
"default_label_layout": {
"$ref": "#/components/schemas/default_label_layout"
}
},
"description": "A ShipEngine account settings response body",
"x-konfig-properties": {}
}
account_settings_images
{
"type": "object",
"title": "account_settings_images",
"properties": {
"name": {
"type": "string",
"example": "My logo",
"maxLength": 50,
"minLength": 1,
"description": "A human readable name for the image.\n"
},
"created_at": {
"$ref": "#/components/schemas/date_time"
},
"image_data": {
"type": "string",
"example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==",
"description": "A base64 encoded string representation of the image.\n"
},
"is_default": {
"type": "boolean",
"example": false,
"description": "Indicates whether this image is set as default.\n"
},
"modified_at": {
"$ref": "#/components/schemas/date_time"
},
"label_image_id": {
"$ref": "#/components/schemas/image_id"
},
"image_content_type": {
"allOf": [
{
"enum": [
"image/png",
"image/jpeg"
],
"type": "string",
"description": "The image type"
}
],
"description": "The file type of the image. \n"
}
},
"description": "A ShipEngine account images body",
"x-konfig-properties": {
"created_at": {
"readOnly": true,
"description": "The date and time that the image was created in ShipEngine."
},
"modified_at": {
"readOnly": true,
"description": "The date and time that the image was modified in ShipEngine."
},
"label_image_id": {
"readOnly": true,
"description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n"
}
}
}
add_funds_to_carrier_response_body
{
"type": "object",
"title": "add_funds_to_carrier_response_body",
"required": [
"balance"
],
"properties": {
"balance": {
"$ref": "#/components/schemas/monetary_value"
}
},
"description": "The current balance of the requested carrier account",
"x-konfig-properties": {
"balance": {
"readOnly": true,
"description": "The current balance of the account"
}
}
}
address_residential_indicator
{
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"title": "address_residential_indicator",
"description": "Indicates whether an address is residential."
}
address_validating_shipment
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/validate_shipment_fields"
},
{
"$ref": "#/components/schemas/partial_shipment"
}
],
"title": "address_validating_shipment",
"required": [
"shipment_id",
"carrier_id",
"service_code",
"ship_to",
"ship_from"
],
"description": "An address validating shipment"
}
address_validation_code
{
"enum": [
"a1000",
"a1001",
"a1002",
"a1003",
"a1004",
"a1005",
"a1006",
"a1007",
"a1008",
"r1000",
"r1001",
"r1002",
"r1003"
],
"type": "string",
"title": "address_validation_code",
"description": "The error codes that can be returned by the address validation API"
}
address_validation_detail_code
{
"enum": [
"unsupported_country",
"non_supported_country",
"minimum_postal_code_verification_failed",
"street_does_not_match_unique_street_name",
"multiple_directionals",
"multiple_matches",
"suite_not_valid",
"suite_missing",
"incompatible_paired_labels",
"invalid_house_number",
"missing_house_number",
"invalid_box_number",
"invalid_charge_event",
"missing_box_number",
"missing_cmra_or_private_mail_box_number",
"suite_has_no_secondaries",
"postal_code_changed_or_added",
"state_province_changed_or_added",
"city_locality_changed_or_added",
"urbanization_changed",
"street_name_spelling_changed_or_added",
"street_name_type_changed_or_added",
"street_direction_changed_or_added",
"suite_type_changed_or_added",
"suite_unit_number_changed_or_added",
"double_dependent_locality_changed_or_added",
"subadministrative_area_changed_or_added",
"subnational_area_changed_or_added",
"po_box_changed_or_added",
"premise_type_changed_or_added",
"house_number_changed",
"organization_changed_or_added",
"partially_verified_to_state_level",
"partially_verified_to_city_level",
"partially_verified_to_street_level",
"partially_verified_to_premise_level",
"verified_to_state_level",
"verified_to_city_level",
"verified_to_street_level",
"verified_to_premise_level",
"verified_to_suite_level",
"coded_to_street_lavel",
"coded_to_neighborhood_level",
"coded_to_community_level",
"coded_to_state_level",
"coded_to_rooftop_level",
"coded_to_rooftop_interpolation_level",
"name_max_length_exceeded",
"phone_max_length_exceeded",
"company_name_max_length_exceeded",
"line1_min_max_length",
"line2_max_length_exceeded",
"line3_max_length_exceeded",
"city_locality_max_length_exceeded",
"state_province_max_length_exceeded",
"invalid_postal_code",
"country_invalid_length",
"address_not_found"
],
"type": "string",
"title": "address_validation_detail_code",
"description": "The detailed error codes that can be returned by the address validation API"
}
address_validation_message_type
{
"enum": [
"error",
"warning",
"info"
],
"type": "string",
"title": "address_validation_message_type",
"description": "The different types of messages that can be returned by the address validation API"
}
address_validation_result
{
"type": "object",
"title": "address_validation_result",
"required": [
"status",
"original_address",
"matched_address",
"messages"
],
"properties": {
"status": {
"$ref": "#/components/schemas/address_validation_status"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/response_message"
},
"default": [],
"readOnly": true,
"description": "The list of messages that were generated during the address validation request."
},
"matched_address": {
"allOf": [
{
"$ref": "#/components/schemas/partial_address"
}
],
"nullable": true,
"readOnly": true,
"description": "The matched address found by the Shipengine API"
},
"original_address": {
"$ref": "#/components/schemas/partial_address"
}
},
"description": "An address validation result",
"x-konfig-properties": {
"original_address": {
"description": "The original address that was sent for validation"
}
}
}
address_validation_status
{
"enum": [
"unverified",
"verified",
"warning",
"error"
],
"type": "string",
"title": "address_validation_status",
"description": "The possible address validation status values"
}
advanced_shipment_options
{
"type": "object",
"title": "advanced_shipment_options",
"properties": {
"dry_ice": {
"type": "boolean",
"default": false,
"description": "Indicates if the shipment contain dry ice"
},
"origin_type": {
"allOf": [
{
"$ref": "#/components/schemas/origin_type"
}
],
"default": null,
"nullable": true
},
"bill_to_party": {
"allOf": [
{
"$ref": "#/components/schemas/bill_to_party"
}
],
"default": null,
"nullable": true,
"description": "Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set.\n"
},
"custom_field1": {
"type": "string",
"default": null,
"nullable": true,
"maxLength": 100,
"description": "An arbitrary field that can be used to store information about the shipment.\n"
},
"custom_field2": {
"type": "string",
"default": null,
"nullable": true,
"maxLength": 100,
"description": "An arbitrary field that can be used to store information about the shipment.\n"
},
"custom_field3": {
"type": "string",
"default": null,
"nullable": true,
"maxLength": 100,
"description": "An arbitrary field that can be used to store information about the shipment.\n"
},
"fedex_freight": {
"type": "object",
"properties": {
"booking_confirmation": {
"type": "string"
},
"shipper_load_and_count": {
"type": "string"
}
},
"description": "Provide details for the Fedex freight service"
},
"freight_class": {
"type": "string",
"default": null,
"example": 77.5,
"nullable": true,
"description": "The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\".\n"
},
"dry_ice_weight": {
"allOf": [
{
"$ref": "#/components/schemas/weight"
}
],
"nullable": true,
"description": "The weight of the dry ice in the shipment"
},
"non_machinable": {
"type": "boolean",
"default": false,
"description": "Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details.\n"
},
"bill_to_account": {
"type": "string",
"default": null,
"nullable": true,
"description": "This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields.\n"
},
"dangerous_goods": {
"type": "boolean",
"default": false,
"description": "Indicates if the Dangerous goods are present in the shipment"
},
"shipper_release": {
"type": "boolean",
"default": null,
"nullable": true
},
"contains_alcohol": {
"type": "boolean",
"default": false,
"description": "Indicates that the shipment contains alcohol."
},
"saturday_delivery": {
"type": "boolean",
"default": false,
"description": "Enables Saturday delivery, if supported by the carrier."
},
"additional_handling": {
"type": "boolean",
"default": null,
"nullable": true,
"description": "Indicate to the carrier that this shipment requires additional handling.\n"
},
"bill_to_postal_code": {
"type": "string",
"default": null,
"nullable": true,
"description": "The postal code of the third-party that is responsible for shipping costs.\n"
},
"collect_on_delivery": {
"$ref": "#/components/schemas/collect_on_delivery"
},
"delivered_duty_paid": {
"type": "boolean",
"default": false,
"description": "Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.\n"
},
"bill_to_country_code": {
"allOf": [
{
"$ref": "#/components/schemas/country_code"
}
],
"default": null,
"nullable": true,
"description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs.\n"
},
"third_party_consignee": {
"type": "boolean",
"default": false,
"description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached"
},
"dangerous_goods_contact": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the contact"
},
"phone": {
"type": "string",
"description": "Phone number of the contact"
}
},
"description": "Contact information for Dangerous goods"
},
"use_ups_ground_freight_pricing": {
"type": "boolean",
"default": null,
"nullable": true,
"description": "Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified.\n"
}
},
"description": "Advanced shipment options"
}
alternative_identifier
{
"type": "object",
"title": "alternative_identifier",
"properties": {
"type": {
"type": "string",
"example": "last_mile_tracking_number",
"minLength": 1,
"description": "The type of alternative_identifier that corresponds to the value.\n"
},
"value": {
"type": "string",
"example": "12345678912345678912",
"minLength": 1,
"description": "The value of the alternative_identifier.\n"
}
},
"description": "Additional information some carriers may provide by which to identify a given label in their system. \n"
}
alternative_identifiers
{
"type": "object",
"title": "alternative_identifiers",
"properties": {
"alternative_identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/alternative_identifier"
},
"nullable": true,
"readOnly": true,
"description": "Alternative identifiers associated with this package.\n"
}
}
}
ancillary_service_endorsement
{
"enum": [
"none",
"return_service_requested",
"forwarding_service_requested",
"address_service_requested",
"change_service_requested",
"leave_if_no_response"
],
"type": "string",
"title": "ancillary_service_endorsement",
"description": "[Ancillary service endorsements](https://pe.usps.com/text/qsg300/Q507.htm) are used by mailers to request an addressee's new address and to provide the carrier with instructions on how to handle packages that are undeliverable as addressed.\n\n| Ancillary Service Endorsement | Description\n|--------------------------------|-----------------------------------------------------\n| `none` | No ancillary service is requested. Depending on the carrier servive, the package may be forwarded, returned, or discarded.\n| `return_service_requested` | The package is returned to the sender. If possible, notification of the new address is is included with the returned package.\n| `forwarding_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender.\n| `address_service_requested` | Forward the package to the new address, if possible; otherwise, return it to the sender. This is similar to `forwarding_service_requested`, but different restrictions and charges may apply.\n| `change_service_requested` | The package is discarded. If possible, notification of the new address is sent to the sender.\n| `leave_if_no_response` |\n"
}
batch
{
"type": "object",
"title": "batch",
"required": [
"label_layout",
"label_format",
"batch_id",
"batch_number",
"external_batch_id",
"batch_notes",
"created_at",
"processed_at",
"errors",
"process_errors",
"warnings",
"completed",
"forms",
"count",
"batch_shipments_url",
"batch_labels_url",
"batch_errors_url",
"label_download",
"form_download",
"status"
],
"properties": {
"count": {
"type": "integer",
"format": "int32",
"example": 2,
"minimum": 0,
"readOnly": true,
"description": "The total of errors, warnings, and completed properties"
},
"forms": {
"type": "integer",
"format": "int32",
"example": 3,
"minimum": 0,
"readOnly": true,
"description": "The number of forms for customs that are available for download"
},
"errors": {
"type": "integer",
"format": "int32",
"example": 2,
"minimum": 0,
"readOnly": true,
"description": "The number of errors that occurred while generating the batch"
},
"status": {
"$ref": "#/components/schemas/batch_status"
},
"batch_id": {
"$ref": "#/components/schemas/se_id"
},
"warnings": {
"type": "integer",
"format": "int32",
"example": 1,
"minimum": 0,
"readOnly": true,
"description": "The number of warnings that occurred while generating the batch"
},
"completed": {
"type": "integer",
"format": "int32",
"example": 1,
"minimum": 0,
"readOnly": true,
"description": "The number of labels generated in the batch"
},
"created_at": {
"$ref": "#/components/schemas/date_time"
},
"batch_notes": {
"type": "string",
"default": "",
"example": "Batch for morning shipment",
"nullable": true,
"readOnly": true,
"description": "Custom notes you can add for each created batch"
},
"batch_number": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "The batch number."
},
"label_format": {
"$ref": "#/components/schemas/label_format"
},
"label_layout": {
"$ref": "#/components/schemas/label_layout"
},
"processed_at": {
"allOf": [
{
"$ref": "#/components/schemas/date_time"
}
],
"nullable": true,
"readOnly": true,
"description": "The date and time the batch was processed in ShipEngine"
},
"form_download": {
"$ref": "#/components/schemas/optional_link"
},
"label_download": {
"$ref": "#/components/schemas/label_download"
},
"process_errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
},
"errors": null,
"readOnly": true,
"description": "The errors associated with the failed API call"
},
"batch_errors_url": {
"$ref": "#/components/schemas/optional_link"
},
"batch_labels_url": {
"$ref": "#/components/schemas/optional_link"
},
"external_batch_id": {
"type": "string",
"nullable": true,
"readOnly": true,
"minLength": 0,
"description": "A string that uniquely identifies the external batch"
},
"batch_shipments_url": {
"$ref": "#/components/schemas/optional_link"
}
},
"description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n",
"x-konfig-properties": {
"status": {
"readOnly": true
},
"batch_id": {
"readOnly": true,
"description": "A string that uniquely identifies the batch"
},
"created_at": {
"readOnly": true,
"description": "The date and time the batch was created in ShipEngine"
},
"label_format": {
"default": "pdf",
"readOnly": true
},
"label_layout": {
"default": "4x6",
"readOnly": true,
"description": "label layout"
},
"form_download": {
"readOnly": true,
"description": "The form download for any customs that are needed"
},
"label_download": {
"readOnly": true,
"description": "The label download for the batch"
},
"batch_errors_url": {
"readOnly": true,
"description": "Link to batch errors endpoint"
},
"batch_labels_url": {
"description": "Link to batch labels query"
},
"batch_shipments_url": {
"description": "The batch shipments endpoint"
}
}
}
batch_response_error
{
"type": "object",
"title": "batch_response_error",
"properties": {
"error": {
"type": "string",
"example": "Recipient address has not been verified.",
"readOnly": true,
"minLength": 1,
"description": "Error message associated with the shipment."
},
"shipment_id": {
"$ref": "#/components/schemas/se_id"
},
"external_shipment_id": {
"type": "string",
"readOnly": true,
"description": "An external shipment id associated with the shipment"
}
},
"description": "A batch response error",
"x-konfig-properties": {
"shipment_id": {
"readOnly": true,
"description": "A string that uniquely identifies the shipment"
}
}
}
batch_status
{
"enum": [
"open",
"queued",
"processing",
"completed",
"completed_with_errors",
"archived",
"notifying",
"invalid"
],
"type": "string",
"title": "batch_status",
"description": "The possible batch status values"
}
batches_sort_by
{
"enum": [
"ship_date",
"processed_at",
"created_at"
],
"type": "string",
"title": "batches_sort_by",
"description": "The possible batches sort by values"
}
bill_to_party
{
"enum": [
"recipient",
"third_party"
],
"type": "string",
"title": "bill_to_party",
"description": "The possible bill to party values"
}
bulk_rate
{
"type": "object",
"title": "bulk_rate",
"required": [
"rate_request_id",
"shipment_id",
"created_at",
"status",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
},
"readOnly": true,
"description": "An array of errors that were returned while retrieving the bulk rate"
},
"status": {
"$ref": "#/components/schemas/rate_response_status"
},
"created_at": {
"$ref": "#/components/schemas/date_time"
},
"shipment_id": {
"$ref": "#/components/schemas/se_id"
},
"rate_request_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A bulk rate",
"x-konfig-properties": {
"status": {
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"shipment_id": {
"readOnly": true,
"description": "A string that uniquely identifies the shipment"
},
"rate_request_id": {
"readOnly": true,
"description": "A string that uniquely identifies the rate request"
}
}
}
calculate_rates_response_body
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/partial_shipment"
},
{
"$ref": "#/components/schemas/rate_response"
}
],
"title": "calculate_rates_response_body",
"required": [
"rate_response",
"shipment_id",
"ship_date",
"created_at",
"modified_at",
"shipment_status",
"return_to",
"confirmation",
"customs",
"advanced_options",
"insurance_provider",
"tags",
"packages",
"total_weight"
],
"description": "A rate shipment response body"
}
carrier
{
"type": "object",
"title": "carrier",
"properties": {
"balance": {
"type": "number",
"format": "double",
"example": 3799.52,
"minimum": 0,
"readOnly": true,
"description": "Current available balance"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carrier_advanced_option"
},
"readOnly": true,
"description": "A list of options that are available to that carrier"
},
"primary": {
"type": "boolean",
"readOnly": true,
"description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation"
},
"nickname": {
"type": "string",
"example": "ShipEngine Account - Stamps.com",
"readOnly": true,
"minLength": 1,
"description": "Nickname given to the account when initially setting up the carrier."
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/package_type"
},
"readOnly": true,
"description": "A list of package types that are supported by the carrier"
},
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/service"
},
"readOnly": true,
"description": "A list of services that are offered by the carrier"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"carrier_code": {
"$ref": "#/components/schemas/carrier_code"
},
"friendly_name": {
"type": "string",
"example": "Stamps.com",
"readOnly": true,
"minLength": 1,
"description": "Screen readable name"
},
"account_number": {
"type": "string",
"example": "account_570827",
"readOnly": true,
"minLength": 1,
"description": "The account number that the carrier is connected to."
},
"requires_funded_amount": {
"type": "boolean",
"readOnly": true,
"description": "Indicates whether the carrier requires funding to use its services"
},
"supports_label_messages": {
"type": "boolean",
"readOnly": true,
"description": "The carrier supports adding custom label messages to an order."
},
"disabled_by_billing_plan": {
"type": "boolean",
"readOnly": true,
"description": "The carrier is disabled by the current ShipEngine account's billing plan."
},
"has_multi_package_supporting_services": {
"type": "boolean",
"readOnly": true,
"description": "Carrier supports multiple packages per shipment"
}
},
"description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n",
"x-konfig-properties": {
"carrier_id": {
"readOnly": true,
"description": "A string that uniquely identifies the carrier."
},
"carrier_code": {
"readOnly": true,
"description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n"
}
}
}
carrier_advanced_option
{
"type": "object",
"title": "carrier_advanced_option",
"properties": {
"name": {
"type": "string",
"example": "contains_alcohol",
"readOnly": true,
"minLength": 1,
"description": "Name of advanced option"
},
"description": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "Description of option"
},
"default_value": {
"type": "string",
"example": false,
"readOnly": true,
"minLength": 1,
"description": "Default value of option"
}
},
"description": "Advanced options that are specific to the carrier"
}
carrier_code
{
"type": "string",
"title": "carrier_code",
"example": "dhl_express",
"pattern": "^[a-z0-9]+(_[a-z0-9]+)*$",
"description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n"
}
carrier_name
{
"enum": [
"access_worldwide",
"amazon_buy_shipping",
"amazon_shipping_uk",
"apc",
"asendia",
"australia_post",
"canada_post",
"dhl_ecommerce",
"dhl_express",
"dhl_express_au",
"dhl_express_ca",
"dhl_express_uk",
"dpd",
"endicia",
"fedex",
"fedex_uk",
"firstmile",
"imex",
"newgistics",
"ontrac",
"purolator_canada",
"royal_mail",
"rr_donnelley",
"seko",
"sendle",
"stamps_com",
"ups"
],
"type": "string",
"title": "carrier_name",
"description": "The shipping carriers that are supported by ShipEngine"
}
carrier_name_with_settings
{
"enum": [
"dhl_express",
"fedex",
"newgistics",
"ups"
],
"type": "string",
"title": "carrier_name_with_settings",
"description": "The shipping carriers for which ShipEngine supports carrier settings"
}
collect_on_delivery
{
"type": "object",
"title": "collect_on_delivery",
"properties": {
"payment_type": {
"$ref": "#/components/schemas/collect_on_delivery_payment_type"
},
"payment_amount": {
"$ref": "#/components/schemas/payment_amount"
}
},
"description": "Defer payment until package is delivered, instead of when it is ordered.",
"x-konfig-properties": {}
}
collect_on_delivery_payment_type
{
"enum": [
"any",
"cash",
"cash_equivalent",
"none"
],
"type": "string",
"title": "collect_on_delivery_payment_type",
"description": "Types of payment that are supported"
}
compare_bulk_rates_response_body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk_rate"
},
"title": "compare_bulk_rates_response_body",
"description": "A bulk rate response body"
}
connect_access_worldwide_request_body
{
"type": "object",
"title": "connect_access_worldwide_request_body",
"required": [
"nickname",
"username",
"password"
],
"properties": {
"nickname": {
"type": "string",
"example": "Stamps.com",
"minLength": 1,
"description": "The nickname associated with the carrier connection"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Access Worldwide Password"
},
"username": {
"type": "string",
"minLength": 1,
"description": "Access Worldwide Username"
}
},
"description": "An Access Worldwide account information request body"
}
connect_amazon_buy_shipping_request_body
{
"type": "object",
"title": "connect_amazon_buy_shipping_request_body",
"required": [
"nickname",
"merchant_seller_id",
"email",
"mws_auth_token"
],
"properties": {
"email": {
"$ref": "#/components/schemas/email"
},
"nickname": {
"type": "string",
"example": "Test Amazon Buy Shipping",
"minLength": 1,
"description": "Nickname to be associated with the account connection"
},
"mws_auth_token": {
"type": "string",
"minLength": 1
},
"merchant_seller_id": {
"type": "string",
"minLength": 1
}
},
"description": "An Amazon account information request body",
"x-konfig-properties": {}
}
connect_amazon_shipping_uk
{
"type": "object",
"title": "connect_amazon_shipping_uk",
"required": [
"nickname",
"auth_code"
],
"properties": {
"nickname": {
"type": "string",
"example": "Stamps.com",
"minLength": 1,
"description": "The nickname associated with the carrier connection"
},
"auth_code": {
"type": "string",
"minLength": 1,
"description": "Amazon UK Shipping auth code."
}
},
"description": "An Amazon Shipping UK account information request body"
}
connect_apc_request_body
{
"type": "object",
"title": "connect_apc_request_body",
"required": [
"nickname",
"username",
"password"
],
"properties": {
"nickname": {
"type": "string",
"example": "APC carrier account",
"minLength": 1,
"description": "The nickname for the APC account"
},
"password": {
"type": "string",
"example": 12345,
"minLength": 1,
"description": "The password for the APC account"
},
"username": {
"type": "string",
"example": "john_doe",
"minLength": 1,
"description": "The username for the APC account"
}
},
"description": "An APC account information request body"
}
connect_asendia_request_body
{
"type": "object",
"title": "connect_asendia_request_body",
"required": [
"nickname",
"account_number",
"ftp_username",
"ftp_password"
],
"properties": {
"nickname": {
"type": "string",
"example": "Asendia account",
"minLength": 1,
"description": "The nickname of the Asendia account"
},
"ftp_password": {
"type": "string",
"minLength": 1,
"description": "FTP password"
},
"ftp_username": {
"type": "string",
"minLength": 1,
"description": "FTP username"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Asendia account number"
}
},
"description": "An Asendia account information request body"
}
connect_australia_post_request_body
{
"type": "object",
"title": "connect_australia_post_request_body",
"required": [
"account_number",
"api_key",
"api_secret",
"nickname"
],
"properties": {
"api_key": {
"type": "string",
"minLength": 1,
"description": "API key"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"api_secret": {
"type": "string",
"minLength": 1,
"description": "API secret"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "An Australia Post account information request body"
}
connect_canada_post_request_body
{
"type": "object",
"title": "connect_canada_post_request_body",
"required": [
"nickname",
"api_key",
"api_secret",
"account_number",
"contract_id"
],
"properties": {
"api_key": {
"type": "string",
"minLength": 1,
"description": "Canada Post Account API Key"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"api_secret": {
"type": "string",
"minLength": 1,
"description": "Canada Post Account API Secret"
},
"contract_id": {
"type": "string",
"minLength": 1,
"description": "Canada Post Account Contract ID"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Canada Post Account Number"
}
},
"description": "A Canada Post account information request body"
}
connect_carrier_request_body
{
"oneOf": [
{
"$ref": "#/components/schemas/connect_access_worldwide_request_body"
},
{
"$ref": "#/components/schemas/connect_amazon_buy_shipping_request_body"
},
{
"$ref": "#/components/schemas/connect_amazon_shipping_uk"
},
{
"$ref": "#/components/schemas/connect_apc_request_body"
},
{
"$ref": "#/components/schemas/connect_asendia_request_body"
},
{
"$ref": "#/components/schemas/connect_australia_post_request_body"
},
{
"$ref": "#/components/schemas/connect_canada_post_request_body"
},
{
"$ref": "#/components/schemas/connect_dhl_ecommerce_request_body"
},
{
"$ref": "#/components/schemas/connect_dhl_express_request_body"
},
{
"$ref": "#/components/schemas/connect_dhl_express_au_request_body"
},
{
"$ref": "#/components/schemas/connect_dhl_express_ca_request_body"
},
{
"$ref": "#/components/schemas/connect_dhl_express_uk_request_body"
},
{
"$ref": "#/components/schemas/connect_dpd_request_body"
},
{
"$ref": "#/components/schemas/connect_endicia_request_body"
},
{
"$ref": "#/components/schemas/connect_fedex_request_body"
},
{
"$ref": "#/components/schemas/connect_fedex_uk_request_body"
},
{
"$ref": "#/components/schemas/connect_firstmile_request_body"
},
{
"$ref": "#/components/schemas/connect_imex_request_body"
},
{
"$ref": "#/components/schemas/connect_newgistics_request_body"
},
{
"$ref": "#/components/schemas/connect_ontrac_request_body"
},
{
"$ref": "#/components/schemas/connect_purolator_request_body"
},
{
"$ref": "#/components/schemas/connect_royal_mail_request_body"
},
{
"$ref": "#/components/schemas/connect_rr_donnelley_request_body"
},
{
"$ref": "#/components/schemas/connect_seko_request_body"
},
{
"$ref": "#/components/schemas/connect_sendle_request_body"
},
{
"$ref": "#/components/schemas/connect_stamps_request_body"
},
{
"$ref": "#/components/schemas/connect_ups_request_body"
}
],
"title": "connect_carrier_request_body"
}
connect_carrier_response_body
{
"type": "object",
"title": "connect_carrier_response_body",
"required": [
"carrier_id"
],
"properties": {
"carrier_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A connect account response body",
"x-konfig-properties": {
"carrier_id": {
"description": "A string that uniquely identifies the carrier"
}
}
}
connect_dhl_ecommerce_request_body
{
"type": "object",
"title": "connect_dhl_ecommerce_request_body",
"required": [
"nickname",
"client_id",
"username",
"password",
"pickup_number",
"distribution_center"
],
"properties": {
"api_key": {
"type": "string",
"minLength": 1,
"description": "The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account.\n"
},
"sold_to": {
"type": "string",
"description": "Sold To field"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "A nickname to help you identify this account"
},
"password": {
"type": "string",
"minLength": 1,
"description": "The account password"
},
"username": {
"type": "string",
"minLength": 1,
"description": "The account username"
},
"client_id": {
"type": "string",
"minLength": 1,
"description": "The client id"
},
"api_secret": {
"type": "string",
"minLength": 1,
"description": "The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account.\n"
},
"ftp_password": {
"type": "string",
"minLength": 1,
"deprecated": true,
"description": "FTP password"
},
"ftp_username": {
"type": "string",
"minLength": 1,
"deprecated": true,
"description": "FTP username"
},
"pickup_number": {
"type": "string",
"minLength": 1,
"description": "The pickup number"
},
"software_name": {
"type": "string"
},
"account_number": {
"type": "string",
"minLength": 1,
"deprecated": true,
"description": "Account number"
},
"registration_id": {
"type": "string"
},
"distribution_center": {
"type": "string",
"minLength": 1,
"description": "The distribution center"
},
"ancillary_endorsement": {
"$ref": "#/components/schemas/ancillary_service_endorsement"
}
},
"description": "A DHL Ecommerce account information request body",
"x-konfig-properties": {}
}
connect_dhl_express_au_request_body
{
"type": "object",
"title": "connect_dhl_express_au_request_body",
"required": [
"nickname",
"account_number"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A DHL Express AU account information request body"
}
connect_dhl_express_ca_request_body
{
"type": "object",
"title": "connect_dhl_express_ca_request_body",
"required": [
"nickname",
"account_number"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A DHL Express CA account information request body"
}
connect_dhl_express_request_body
{
"type": "object",
"title": "connect_dhl_express_request_body",
"required": [
"nickname",
"account_number"
],
"properties": {
"site_id": {
"type": "string",
"minLength": 1,
"description": "Required if password is provided"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Required if site id is provided"
},
"country_code": {
"$ref": "#/components/schemas/country_code"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A DHL express account information request body",
"x-konfig-properties": {}
}
connect_dhl_express_uk_request_body
{
"type": "object",
"title": "connect_dhl_express_uk_request_body",
"required": [
"account_number",
"site_id",
"password",
"nickname"
],
"properties": {
"site_id": {
"$ref": "#/components/schemas/se_id"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Password"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A DHL Express UK account information request body",
"x-konfig-properties": {
"site_id": {
"description": "A string that uniquely identifies the site"
}
}
}
connect_dpd_request_body
{
"type": "object",
"title": "connect_dpd_request_body",
"required": [
"account_number",
"password",
"nickname"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Password"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A DPD account information request body"
}
connect_endicia_request_body
{
"type": "object",
"title": "connect_endicia_request_body",
"required": [
"nickname",
"account",
"passphrase"
],
"properties": {
"account": {
"type": "string",
"minLength": 1,
"description": "Account"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"passphrase": {
"type": "string",
"minLength": 1,
"description": "Passphrase"
}
},
"description": "An Endicia account information request body"
}
connect_fedex_request_body
{
"type": "object",
"title": "connect_fedex_request_body",
"required": [
"account_number",
"address1",
"city",
"country_code",
"email",
"first_name",
"last_name",
"phone",
"postal_code",
"state",
"nickname",
"agree_to_eula"
],
"properties": {
"city": {
"type": "string",
"minLength": 1,
"description": "The city"
},
"email": {
"$ref": "#/components/schemas/email"
},
"phone": {
"type": "string",
"minLength": 1,
"description": "Phone number"
},
"state": {
"type": "string",
"minLength": 1,
"description": "State"
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company"
},
"address1": {
"type": "string",
"minLength": 1,
"description": "Address"
},
"address2": {
"type": "string",
"minLength": 1,
"description": "Address"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"last_name": {
"type": "string",
"minLength": 1,
"description": "Last name"
},
"first_name": {
"type": "string",
"minLength": 1,
"description": "First name"
},
"postal_code": {
"type": "string",
"minLength": 1,
"description": "Postal Code"
},
"country_code": {
"type": "string",
"minLength": 1,
"description": "Country code"
},
"meter_number": {
"type": "string",
"minLength": 1,
"description": "Meter number"
},
"agree_to_eula": {
"type": "boolean",
"description": "Boolean signaling agreement to the Fedex End User License Agreement"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A Fedex account information request body",
"x-konfig-properties": {
"email": {
"description": "The email address"
}
}
}
connect_fedex_uk_request_body
{
"type": "object",
"title": "connect_fedex_uk_request_body",
"required": [
"account_number",
"address1",
"city",
"country_code",
"email",
"first_name",
"last_name",
"phone",
"postal_code",
"state",
"nickname",
"agree_to_eula"
],
"properties": {
"city": {
"type": "string",
"minLength": 1,
"description": "The city"
},
"email": {
"$ref": "#/components/schemas/email"
},
"phone": {
"type": "string",
"minLength": 1,
"description": "Phone number"
},
"state": {
"type": "string",
"minLength": 1,
"description": "State"
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company"
},
"address1": {
"type": "string",
"minLength": 1,
"description": "Address"
},
"address2": {
"type": "string",
"minLength": 1,
"description": "Address"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"last_name": {
"type": "string",
"minLength": 1,
"description": "Last name"
},
"first_name": {
"type": "string",
"minLength": 1,
"description": "First name"
},
"postal_code": {
"type": "string",
"minLength": 1,
"description": "Postal Code"
},
"country_code": {
"type": "string",
"minLength": 1,
"description": "Country code"
},
"meter_number": {
"type": "string",
"minLength": 1,
"description": "Meter number"
},
"agree_to_eula": {
"type": "boolean",
"description": "Boolean signaling agreement to the Fedex End User License Agreement"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A Fedex UK account information request body",
"x-konfig-properties": {
"email": {
"description": "The email address"
}
}
}
connect_firstmile_request_body
{
"type": "object",
"title": "connect_firstmile_request_body",
"required": [
"nickname",
"mailer_id",
"password"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Password"
},
"mailer_id": {
"$ref": "#/components/schemas/se_id"
},
"profile_name": {
"type": "string",
"minLength": 1,
"description": "Profile name"
}
},
"description": "A First Mile account information request body",
"x-konfig-properties": {
"mailer_id": {
"description": "A string that uniquely identifies the mailer"
}
}
}
connect_imex_request_body
{
"type": "object",
"title": "connect_imex_request_body",
"required": [
"nickname",
"username",
"password"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Password"
},
"username": {
"type": "string",
"minLength": 1,
"description": "Username"
}
},
"description": "An Imex account information request body"
}
connect_insurer_request_body
{
"type": "object",
"title": "connect_insurer_request_body",
"required": [
"email",
"policy_id"
],
"properties": {
"email": {
"$ref": "#/components/schemas/email"
},
"policy_id": {
"type": "string",
"minLength": 1
}
},
"description": "A create shipsurance connection request body",
"x-konfig-properties": {}
}
connect_insurer_response_body
{
"type": "object",
"title": "connect_insurer_response_body"
}
connect_newgistics_request_body
{
"type": "object",
"title": "connect_newgistics_request_body",
"required": [
"induction_site",
"nickname"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"mailer_id": {
"type": "integer",
"format": "int32",
"minimum": 0,
"description": "Mailer id"
},
"merchant_id": {
"type": "integer",
"format": "int32",
"minimum": 0,
"description": "Merchant id"
},
"induction_site": {
"type": "string",
"minLength": 1,
"description": "Induction site"
}
},
"description": "A Newgistics account information request body"
}
connect_ontrac_request_body
{
"type": "object",
"title": "connect_ontrac_request_body",
"required": [
"nickname",
"account_number",
"password"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Password"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "An Ontrac account information request body"
}
connect_purolator_request_body
{
"type": "object",
"title": "connect_purolator_request_body",
"required": [
"account_number",
"activation_key",
"nickname"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
},
"activation_key": {
"type": "string",
"minLength": 1,
"description": "Activation key"
}
},
"description": "A Purolator account information request body"
}
connect_royal_mail_request_body
{
"type": "object",
"title": "connect_royal_mail_request_body",
"required": [
"account_number",
"contact_name",
"city",
"postal_code",
"nickname"
],
"properties": {
"city": {
"type": "string",
"minLength": 1,
"description": "City"
},
"email": {
"$ref": "#/components/schemas/email"
},
"phone": {
"type": "string",
"minLength": 1,
"description": "Phone"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"oba_email": {
"$ref": "#/components/schemas/email"
},
"postal_code": {
"type": "string",
"minLength": 1,
"description": "Postal code"
},
"company_name": {
"type": "string",
"minLength": 1,
"description": "Company name"
},
"contact_name": {
"type": "string",
"minLength": 1,
"description": "Contact name"
},
"street_line1": {
"type": "string",
"minLength": 1,
"description": "Street line1"
},
"street_line2": {
"type": "string",
"minLength": 1,
"description": "Street line2"
},
"street_line3": {
"type": "string",
"minLength": 1,
"description": "Street line3"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
}
},
"description": "A Royal Mail account information request body",
"x-konfig-properties": {
"email": {
"description": "The email address"
},
"oba_email": {
"description": "The oba email address"
}
}
}
connect_rr_donnelley_request_body
{
"type": "object",
"title": "connect_rr_donnelley_request_body",
"required": [
"nickname",
"username",
"password"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Password"
},
"username": {
"type": "string",
"minLength": 1,
"description": "Username"
}
},
"description": "A RR Donnelley account information request body"
}
connect_seko_request_body
{
"type": "object",
"title": "connect_seko_request_body",
"required": [
"nickname",
"access_key"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"access_key": {
"type": "string",
"minLength": 1,
"description": "Seko Account Access Key"
}
},
"description": "A SEKO account information request body"
}
connect_sendle_request_body
{
"type": "object",
"title": "connect_sendle_request_body",
"required": [
"nickname",
"sendle_id",
"api_key"
],
"properties": {
"api_key": {
"type": "string",
"minLength": 1,
"description": "API key"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"sendle_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A Sendle account information request body",
"x-konfig-properties": {
"sendle_id": {
"description": "A string that uniquely identifies the sendle"
}
}
}
connect_stamps_request_body
{
"type": "object",
"title": "connect_stamps_request_body",
"required": [
"nickname",
"username",
"password"
],
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"password": {
"type": "string",
"minLength": 1,
"description": "Password"
},
"username": {
"type": "string",
"minLength": 1,
"description": "Username"
}
},
"description": "A Stamps account information request body"
}
connect_ups_request_body
{
"type": "object",
"title": "connect_ups_request_body",
"required": [
"nickname",
"account_number",
"account_country_code",
"account_postal_code",
"first_name",
"last_name",
"company",
"address1",
"city",
"state",
"postal_code",
"country_code",
"email",
"phone",
"agree_to_technology_agreement"
],
"properties": {
"city": {
"type": "string",
"minLength": 1,
"description": "City"
},
"email": {
"$ref": "#/components/schemas/email"
},
"phone": {
"type": "string",
"minLength": 1,
"description": "Phone"
},
"state": {
"type": "string",
"minLength": 1,
"description": "State"
},
"title": {
"type": "string",
"minLength": 1,
"description": "Title"
},
"company": {
"type": "string",
"minLength": 1,
"description": "Company"
},
"invoice": {
"$ref": "#/components/schemas/ups_invoice"
},
"address1": {
"type": "string",
"minLength": 1,
"description": "Address Line 1"
},
"address2": {
"type": "string",
"minLength": 1,
"description": "Address Line 2"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "Nickname"
},
"last_name": {
"type": "string",
"minLength": 1,
"description": "Last name"
},
"first_name": {
"type": "string",
"minLength": 1,
"description": "First name"
},
"postal_code": {
"type": "string",
"minLength": 1,
"description": "Postal code"
},
"country_code": {
"type": "string",
"minLength": 1,
"description": "Country code"
},
"account_number": {
"type": "string",
"minLength": 1,
"description": "Account number"
},
"invoice_amount": {
"type": "number",
"format": "double",
"description": "The invoice amount"
},
"account_postal_code": {
"type": "string",
"minLength": 1,
"description": "Account postal code"
},
"account_country_code": {
"type": "string",
"minLength": 1,
"description": "Account country code"
},
"invoice_currency_code": {
"type": "string",
"description": "The invoice currency code"
},
"agree_to_technology_agreement": {
"type": "boolean",
"description": "The Agreement to the [UPS Technology Agreement](https://www.ups.com/assets/resources/media/UTA_with_EUR.pdf)"
}
},
"description": "A UPS account information request body",
"x-konfig-properties": {
"email": {
"description": "The email address"
},
"invoice": {
"description": "The UPS invoice"
}
}
}
contact_details
{
"type": "object",
"title": "contact_details",
"required": [
"name",
"email",
"phone"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"email": {
"$ref": "#/components/schemas/email"
},
"phone": {
"type": "string",
"minLength": 7,
"description": "Phone number associated"
}
},
"x-konfig-properties": {}
}
country_code
{
"type": "string",
"title": "country_code",
"example": "CA",
"maxLength": 2,
"minLength": 2,
"description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n"
}
create_and_process_batch_request_body
{
"type": "object",
"title": "create_and_process_batch_request_body",
"properties": {
"rate_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "Array of rate IDs used in the batch"
},
"batch_notes": {
"type": "string",
"example": "This is my batch",
"minLength": 1,
"description": "Add custom messages for a particular batch"
},
"shipment_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "Array of shipment IDs used in the batch"
},
"process_labels": {
"type": "object",
"properties": {
"ship_date": {
"$ref": "#/components/schemas/date_time"
},
"label_format": {
"$ref": "#/components/schemas/label_format"
},
"label_layout": {
"$ref": "#/components/schemas/label_layout"
},
"display_scheme": {
"$ref": "#/components/schemas/display_scheme"
},
"create_batch_and_process_labels": {
"type": "boolean",
"description": "When 'true', the batch will be enqueued for processing"
}
},
"description": "The information used to process the batch",
"x-konfig-properties": {
"ship_date": {
"description": "The Ship date the batch is being processed for"
},
"label_format": {
"default": "pdf"
},
"label_layout": {
"type": "string",
"default": "4x6"
},
"display_scheme": {
"default": "label",
"description": "The display format that the label should be shown in."
}
}
},
"external_batch_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A create and process batch request body",
"x-konfig-properties": {
"external_batch_id": {
"description": "A string that uniquely identifies the external batch"
}
}
}
create_and_validate_shipment
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/partial_shipment"
},
{
"$ref": "#/components/schemas/create_shipment_response_body_fields"
}
],
"title": "create_and_validate_shipment",
"description": "A create and validate shipment resource"
}
create_batch_request
{
"oneOf": [
{
"$ref": "#/components/schemas/create_batch_request_body"
},
{
"$ref": "#/components/schemas/create_and_process_batch_request_body"
}
],
"title": "create_batch_request"
}
create_batch_request_body
{
"type": "object",
"title": "create_batch_request_body",
"properties": {
"rate_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "Array of rate IDs used in the batch"
},
"batch_notes": {
"type": "string",
"example": "This is my batch",
"minLength": 1,
"description": "Add custom messages for a particular batch"
},
"shipment_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "Array of shipment IDs used in the batch"
},
"external_batch_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A create batch request body",
"x-konfig-properties": {
"external_batch_id": {
"description": "A string that uniquely identifies the external batch"
}
}
}
create_label_from_shipment_request_body
{
"type": "object",
"title": "create_label_from_shipment_request_body",
"properties": {
"label_format": {
"$ref": "#/components/schemas/label_format"
},
"label_layout": {
"$ref": "#/components/schemas/label_layout"
},
"display_scheme": {
"$ref": "#/components/schemas/display_scheme"
},
"validate_address": {
"$ref": "#/components/schemas/validate_address"
},
"label_download_type": {
"$ref": "#/components/schemas/label_download_type"
}
},
"description": "A purchase label without shipment request body",
"x-konfig-properties": {
"label_format": {
"default": "pdf"
},
"label_layout": {
"default": "4x6"
},
"display_scheme": {
"default": "label",
"description": "The display format that the label should be shown in."
}
}
}
create_manifest_by_object_request_body
{
"type": "object",
"title": "create_manifest_by_object_request_body",
"required": [
"carrier_id",
"warehouse_id",
"ship_date"
],
"properties": {
"label_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "The list of label ids to include for the manifest"
},
"ship_date": {
"type": "string",
"format": "date-time",
"example": "2018-09-23T15:00:00.000Z",
"minLength": 1,
"description": "The ship date that the shipment will be sent out on"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"warehouse_id": {
"$ref": "#/components/schemas/se_id"
},
"excluded_label_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "The list of label ids to exclude from the manifest"
}
},
"description": "A create manifest request body",
"x-konfig-properties": {
"carrier_id": {
"description": "A string that uniquely identifies the carrier"
},
"warehouse_id": {
"description": "A string that uniquely identifies the warehouse"
}
}
}
create_manifest_label_ids_request_body
{
"type": "object",
"title": "create_manifest_label_ids_request_body",
"required": [
"label_ids"
],
"properties": {
"label_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "The list of label ids to include in the manifest"
}
},
"description": "A create manifest request body"
}
create_manifest_request_body
{
"oneOf": [
{
"$ref": "#/components/schemas/create_manifest_by_object_request_body"
},
{
"$ref": "#/components/schemas/create_manifest_label_ids_request_body"
}
],
"title": "create_manifest_request_body"
}
create_manifest_response_body
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/manifests"
},
{
"$ref": "#/components/schemas/manifests_requests"
},
{
"$ref": "#/components/schemas/deprecated_manifest"
},
{
"$ref": "#/components/schemas/error_with_label_id_response_body"
}
],
"title": "create_manifest_response_body",
"required": [
"manifest_id",
"form_id",
"created_at",
"ship_date",
"shipments",
"warehouse_id",
"submission_id",
"carrier_id",
"manifest_download"
],
"description": "A create manifest response body"
}
create_return_label_request_body
{
"type": "object",
"title": "create_return_label_request_body",
"properties": {
"charge_event": {
"$ref": "#/components/schemas/label_charge_event"
},
"label_format": {
"$ref": "#/components/schemas/label_format"
},
"label_layout": {
"$ref": "#/components/schemas/label_layout"
},
"display_scheme": {
"$ref": "#/components/schemas/display_scheme"
},
"label_image_id": {
"allOf": [
{
"$ref": "#/components/schemas/image_id"
}
],
"nullable": true,
"description": "The label image resource that was used to create a custom label image."
},
"label_download_type": {
"$ref": "#/components/schemas/label_download_type"
}
},
"description": "A create return label request body",
"x-konfig-properties": {
"charge_event": {
"description": "The label charge event.\n"
},
"label_format": {
"default": "pdf",
"description": "The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\n"
},
"label_layout": {
"default": "4x6",
"description": "The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format.\n"
},
"display_scheme": {
"default": "label",
"description": "The display format that the label should be shown in."
},
"label_download_type": {
"default": "url",
"writeOnly": true
}
}
}
create_shipment_response_body_fields
{
"type": "object",
"title": "create_shipment_response_body_fields",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"example": "Parameter value '100000000.00' is out of range.",
"minLength": 1,
"description": "An error that occurred while creating a shipment."
},
"readOnly": true,
"deprecated": true,
"description": "An array of errors that occurred while creating shipment."
},
"address_validation": {
"$ref": "#/components/schemas/address_validation_result"
}
},
"x-konfig-properties": {
"address_validation": {
"description": "The address validation"
}
}
}
create_shipments_request_body
{
"type": "object",
"title": "create_shipments_request_body",
"required": [
"shipments"
],
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/address_validating_shipment"
},
"minItems": 1,
"description": "An array of shipments to be created."
}
},
"description": "A create shipments request body"
}
create_shipments_response_body
{
"type": "object",
"title": "create_shipments_response_body",
"required": [
"has_errors",
"shipments"
],
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/create_and_validate_shipment"
},
"description": "An array of shipments that were created."
},
"has_errors": {
"type": "boolean",
"default": false,
"description": "Indicates if errors occured while creating the shipments"
}
},
"description": "A create shipments response body"
}
create_webhook_request_body
{
"type": "object",
"title": "create_webhook_request_body",
"required": [
"event",
"url"
],
"properties": {
"url": {
"$ref": "#/components/schemas/url"
},
"event": {
"$ref": "#/components/schemas/webhook_event"
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/webhook_header"
},
"description": "Array of custom webhook headers"
}
},
"description": "A create webhook request body",
"x-konfig-properties": {
"url": {
"example": "https://[YOUR ENDPOINT ID].x.requestbin.com",
"description": "The url that the webhook sends the request to"
}
}
}
currency
{
"type": "string",
"title": "currency",
"description": "The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\n"
}
customs_item
{
"type": "object",
"title": "customs_item",
"required": [
"customs_item_id"
],
"properties": {
"sku": {
"type": "string",
"nullable": true,
"description": "The SKU (Stock Keeping Unit) of the customs item"
},
"value": {
"type": "number",
"format": "double",
"minimum": 0,
"description": "The monetary amount, in the specified currency."
},
"weight": {
"$ref": "#/components/schemas/weight"
},
"quantity": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0,
"description": "The quantity of this item in the shipment."
},
"description": {
"type": "string",
"default": null,
"nullable": true,
"maxLength": 100,
"description": "A description of the item"
},
"value_currency": {
"type": "string",
"description": "The currencies that are supported by ShipEngine are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html\n"
},
"customs_item_id": {
"$ref": "#/components/schemas/se_id"
},
"sku_description": {
"type": "string",
"nullable": true,
"description": "Description of the Custom Item's SKU"
},
"unit_of_measure": {
"type": "string",
"nullable": true
},
"country_of_origin": {
"allOf": [
{
"$ref": "#/components/schemas/country_code"
}
],
"default": null,
"nullable": true,
"description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n"
},
"harmonized_tariff_code": {
"type": "string",
"default": null,
"example": 3926.1,
"nullable": true,
"description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item."
}
},
"description": "The customs declaration for a single item in the shipment.",
"x-konfig-properties": {
"weight": {
"description": "The item weight"
},
"customs_item_id": {
"readOnly": true,
"description": "A string that uniquely identifies the customs item"
}
}
}
dangerous_amount
{
"type": "object",
"title": "dangerous_amount",
"properties": {
"unit": {
"type": "string",
"default": null,
"nullable": true,
"description": "The unit of dangerous goods."
},
"amount": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0,
"description": "The amount of dangerous goods."
}
},
"description": "This model represents the amount of the dangerous goods.."
}
dangerous_goods
{
"type": "object",
"title": "dangerous_goods",
"properties": {
"quantity": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0,
"description": "Quantity of dangerous goods."
},
"id_number": {
"type": "string",
"default": null,
"nullable": true,
"description": "UN number to identify the dangerous goods."
},
"radioactive": {
"type": "boolean",
"example": false,
"nullable": true,
"description": "Indication if the substance is radioactive."
},
"tunnel_code": {
"type": "string",
"default": null,
"nullable": true,
"description": "Defines which types of tunnels the shipment is allowed to go through"
},
"product_class": {
"type": "string",
"default": null,
"nullable": true,
"description": "Dangerous goods product class based on regulation."
},
"shipping_name": {
"type": "string",
"default": null,
"nullable": true,
"description": "Trade description of the dangerous goods."
},
"packaging_type": {
"type": "string",
"default": null,
"nullable": true,
"description": "The type of exterior packaging used to contain the dangerous good."
},
"technical_name": {
"type": "string",
"default": null,
"nullable": true,
"description": "Recognized Technical or chemical name of dangerous goods."
},
"transport_mean": {
"$ref": "#/components/schemas/transport_mean"
},
"packaging_group": {
"$ref": "#/components/schemas/packaging_group"
},
"dangerous_amount": {
"$ref": "#/components/schemas/dangerous_amount"
},
"regulation_level": {
"$ref": "#/components/schemas/regulation_level"
},
"transport_category": {
"type": "string",
"default": null,
"nullable": true,
"description": "Transport category assign to dangerous goods for the transport purpose."
},
"reportable_quantity": {
"type": "boolean",
"example": false,
"nullable": true,
"description": "Indication if the substance needs to be reported to regulatory authority based on the quantity."
},
"regulation_authority": {
"type": "string",
"default": null,
"nullable": true,
"description": "Name of the regulatory authority."
},
"packaging_instruction": {
"type": "string",
"default": null,
"nullable": true,
"description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container."
},
"additional_description": {
"type": "string",
"default": null,
"nullable": true,
"description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier"
},
"product_class_subsidiary": {
"type": "string",
"default": null,
"nullable": true,
"description": "A secondary of product class for substances presenting more than one particular hazard"
},
"packaging_instruction_section": {
"$ref": "#/components/schemas/packaging_instruction_section"
}
},
"description": "Dangerous goods attribute associated with the product\n",
"x-konfig-properties": {
"dangerous_amount": {
"description": "This model represents the amount of the dangerous goods."
}
}
}
date
{
"type": "string",
"title": "date",
"format": "date-time",
"example": "2018-09-23T00:00:00.000Z",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$",
"description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date, but not a specific time. The value _may_ contain a time component, but it will be set to `00:00:00` UTC by ShipEngine.\n"
}
date_time
{
"type": "string",
"title": "date_time",
"format": "date-time",
"example": "2018-09-23T15:00:00.000Z",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$",
"description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n"
}
default_label_layout
{
"enum": [
"4x6",
"Letter"
],
"type": "string",
"title": "default_label_layout",
"description": "The possible default label layout values"
}
delete_pickup_by_id_response_body
{
"allOf": [
{
"$ref": "#/components/schemas/error_response_body"
},
{
"$ref": "#/components/schemas/delete_scheduled_pickup_response_body"
}
],
"title": "delete_pickup_by_id_response_body"
}
delete_scheduled_pickup_response_body
{
"type": "object",
"title": "delete_scheduled_pickup_response_body",
"required": [
"pickup_id"
],
"properties": {
"pickup_id": {
"$ref": "#/components/schemas/pickup_resource_id"
}
},
"description": "A delete scheduled pickup response body",
"x-konfig-properties": {}
}
delivery_confirmation
{
"enum": [
"none",
"delivery",
"signature",
"adult_signature",
"direct_signature",
"delivery_mailed",
"verbal_confirmation"
],
"type": "string",
"title": "delivery_confirmation",
"description": "The possible delivery confirmation values"
}
deprecated_manifest
{
"type": "object",
"title": "deprecated_manifest",
"properties": {
"form_id": {
"$ref": "#/components/schemas/se_id"
},
"label_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"readOnly": true,
"deprecated": true,
"description": "An array of the label ids used in this manifest."
},
"ship_date": {
"type": "string",
"format": "date-time",
"example": "2019-07-12T13:37:39.050Z",
"minLength": 1,
"deprecated": true,
"description": "The date-time that the manifests shipments will be picked up"
},
"shipments": {
"type": "integer",
"format": "int32",
"example": 100,
"minimum": 1,
"readOnly": true,
"deprecated": true,
"description": "The number of shipments that are included in this manifest"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2019-07-12T13:37:39.050Z",
"minLength": 1,
"deprecated": true,
"description": "The date-time that the manifest was created"
},
"manifest_id": {
"$ref": "#/components/schemas/se_id"
},
"warehouse_id": {
"$ref": "#/components/schemas/se_id"
},
"submission_id": {
"type": "string",
"example": "9475711899564878915476",
"minLength": 1,
"deprecated": true,
"description": "A string that uniquely identifies the submission"
},
"manifest_download": {
"$ref": "#/components/schemas/manifest_download"
}
},
"description": "Deprecated manifest resource",
"x-konfig-properties": {
"form_id": {
"deprecated": true,
"description": "A string that uniquely identifies the form"
},
"carrier_id": {
"deprecated": true,
"description": "A string that uniquely identifies the carrier"
},
"manifest_id": {
"deprecated": true,
"description": "A string that uniquely identifies the manifest"
},
"warehouse_id": {
"deprecated": true,
"description": "A string that uniquely identifies the warehouse"
},
"manifest_download": {
"deprecated": true
}
}
}
dhl_express_account_settings
{
"type": "object",
"title": "dhl_express_account_settings",
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Account nickname"
},
"is_primary_account": {
"type": "boolean",
"description": "Indicates if this is primary account"
},
"should_hide_account_number_on_archive_doc": {
"type": "boolean",
"description": "Indicates if the account number should be hidden on the archive documentation"
}
},
"description": "A DHL Express account settings"
}
dimension_unit
{
"enum": [
"inch",
"centimeter"
],
"type": "string",
"title": "dimension_unit",
"description": "The dimension units that are supported by ShipEngine."
}
dimensions
{
"type": "object",
"title": "dimensions",
"required": [
"unit",
"length",
"width",
"height"
],
"properties": {
"unit": {
"$ref": "#/components/schemas/dimension_unit"
},
"width": {
"type": "number",
"format": "double",
"default": 0,
"minimum": 0,
"description": "The width of the package, in the specified unit"
},
"height": {
"type": "number",
"format": "double",
"default": 0,
"minimum": 0,
"description": "The length of the package, in the specified unit"
},
"length": {
"type": "number",
"format": "double",
"default": 0,
"minimum": 0,
"description": "The length of the package, in the specified unit"
}
},
"description": "The dimensions of a package",
"x-konfig-properties": {
"unit": {
"default": "inch"
}
}
}
disconnect_insurer_response_body
{
"type": "object",
"title": "disconnect_insurer_response_body"
}
display_scheme
{
"enum": [
"label",
"qr_code",
"label_and_qr_code"
],
"type": "string",
"title": "display_scheme",
"description": "The display format that the label should be shown in."
}
download_file_pdf_response_body
{
"type": "string",
"title": "download_file_pdf_response_body",
"format": "binary"
}
download_file_png_response_body
{
"type": "string",
"title": "download_file_png_response_body",
"format": "binary"
}
download_file_zpl_response_body
{
"type": "string",
"title": "download_file_zpl_response_body",
"format": "binary"
}
email
{
"type": "string",
"title": "email",
"format": "email",
"example": "john.doe@example.com",
"minLength": 1,
"description": "An email address."
}
empty_response_body
{
"type": "string",
"title": "empty_response_body",
"maxLength": 0,
"minLength": 0
}
error
{
"type": "object",
"title": "error",
"required": [
"error_source",
"error_type",
"error_code",
"message"
],
"properties": {
"message": {
"type": "string",
"example": "Body of request cannot be null.",
"readOnly": true,
"minLength": 1,
"description": "An error message associated with the failed API call"
},
"error_code": {
"$ref": "#/components/schemas/error_code"
},
"error_type": {
"$ref": "#/components/schemas/error_type"
},
"error_source": {
"$ref": "#/components/schemas/error_source"
}
},
"description": "The error structure that gets returned with almost all failed API calls\n",
"x-konfig-properties": {}
}
error_code
{
"enum": [
"auto_fund_not_supported",
"batch_cannot_be_modified",
"carrier_conflict",
"carrier_disconnected",
"carrier_not_connected",
"carrier_not_supported",
"confirmation_not_supported",
"default_warehouse_cannot_be_deleted",
"field_conflict",
"field_value_required",
"forbidden",
"identifier_conflict",
"identifiers_must_match",
"insufficient_funds",
"invalid_address",
"invalid_billing_plan",
"invalid_field_value",
"invalid_identifier",
"invalid_status",
"invalid_string_length",
"label_images_not_supported",
"meter_failure",
"order_source_not_active",
"rate_limit_exceeded",
"refresh_not_supported",
"request_body_required",
"return_label_not_supported",
"settings_not_supported",
"subscription_inactive",
"terms_not_accepted",
"tracking_not_supported",
"trial_expired",
"unauthorized",
"unknown",
"unspecified",
"verification_failure",
"warehouse_conflict",
"webhook_event_type_conflict",
"customs_items_required",
"incompatible_paired_labels",
"invalid_charge_event",
"invalid_object",
"no_rates_returned"
],
"type": "string",
"title": "error_code",
"description": "The error code specified for the failed API Call"
}
error_response_body
{
"type": "object",
"title": "error_response_body",
"required": [
"request_id",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
},
"readOnly": true,
"description": "The errors associated with the failed API call"
},
"request_id": {
"$ref": "#/components/schemas/uuid"
}
},
"description": "An error response body",
"x-konfig-properties": {
"request_id": {
"description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n"
}
}
}
error_source
{
"enum": [
"carrier",
"order_source",
"shipengine"
],
"type": "string",
"title": "error_source",
"description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n"
}
error_type
{
"enum": [
"account_status",
"business_rules",
"validation",
"security",
"system",
"integrations"
],
"type": "string",
"title": "error_type",
"description": "The type of error\n"
}
error_with_label_id_response_body
{
"type": "object",
"title": "error_with_label_id_response_body",
"required": [
"request_id",
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
},
"readOnly": true,
"description": "The errors associated with the failed API call"
},
"request_id": {
"$ref": "#/components/schemas/uuid"
}
},
"description": "An error response body",
"x-konfig-properties": {
"request_id": {
"description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n"
}
}
}
estimate_rates_response_body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/rate_estimate"
},
"title": "estimate_rates_response_body",
"description": "A rate estimate response body"
}
fedex_account_settings
{
"type": "object",
"title": "fedex_account_settings",
"properties": {
"nickname": {
"type": "string",
"minLength": 1,
"description": "Account nickname"
},
"pickup_type": {
"$ref": "#/components/schemas/fedex_pickup_type"
},
"smart_post_hub": {
"$ref": "#/components/schemas/smart_post_hub"
},
"signature_image": {
"type": "string"
},
"letterhead_image": {
"type": "string"
},
"is_primary_account": {
"type": "boolean"
},
"smart_post_endorsement": {
"$ref": "#/components/schemas/ancillary_service_endorsement"
}
},
"description": "A Fedex account settings request body",
"x-konfig-properties": {}
}
fedex_pickup_type
{
"enum": [
"none",
"regular_pickup",
"request_courier",
"drop_box",
"business_service_center",
"station"
],
"type": "string",
"title": "fedex_pickup_type",
"description": "Tax identifier type for customs declaration\n\n|Pickup Type |Description\n|--------------------------|-----------------------------------------\n|`none` | Not specified\n|`regular_pickup` | You already have a daily pickup scheduled with FedEx\n|`request_courier` | You will call FedEx to request a courier\n|`drop_box` | You will drop-off packages in a FedEx drop box\n|`business_service_center` | You will drop-off packages at an authorized FedEx business service center\n|`station` | You will drop-off the package at a FedEx Station\n"
}
get_carrier_options_response_body
{
"type": "object",
"title": "get_carrier_options_response_body",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carrier_advanced_option"
},
"readOnly": true,
"description": "AN array of carrier options"
}
},
"description": "A carrier list options response body"
}
get_carrier_settings_response_body
{
"oneOf": [
{
"$ref": "#/components/schemas/dhl_express_account_settings"
},
{
"$ref": "#/components/schemas/fedex_account_settings"
},
{
"$ref": "#/components/schemas/ups_account_settings"
}
],
"title": "get_carrier_settings_response_body"
}
get_carriers_response_body
{
"allOf": [
{
"$ref": "#/components/schemas/list_carriers_response_body"
},
{
"$ref": "#/components/schemas/error_response_body"
}
],
"title": "get_carriers_response_body"
}
get_pickup_by_id_response_body
{
"allOf": [
{
"$ref": "#/components/schemas/pickup"
},
{
"$ref": "#/components/schemas/error_response_body"
}
],
"title": "get_pickup_by_id_response_body"
}
get_pickups_response_body
{
"allOf": [
{
"$ref": "#/components/schemas/list_pickup_response_body"
},
{
"$ref": "#/components/schemas/error_response_body"
}
],
"title": "get_pickups_response_body"
}
get_service_point_by_id_response_body
{
"type": "object",
"title": "get_service_point_by_id_response_body",
"properties": {
"service_point": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"example": 48.842608,
"description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html"
},
"long": {
"type": "number",
"format": "double",
"example": 0.032875,
"description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html"
},
"type": {
"enum": [
"pudo",
"locker"
],
"type": "string",
"default": "pudo",
"description": "Service point type"
},
"features": {
"type": "array",
"items": {
"enum": [
"drop_off_point",
"pickup_point",
"print_services",
"after_hours_locker",
"after_hours_dropbox"
],
"type": "string"
},
"description": "Service features"
},
"postal_code": {
"$ref": "#/components/schemas/postal_code"
},
"carrier_code": {
"$ref": "#/components/schemas/carrier_code"
},
"company_name": {
"type": "string",
"example": "My fancy company name",
"description": "If this is a business address, then the company name should be specified here."
},
"country_code": {
"$ref": "#/components/schemas/country_code"
},
"phone_number": {
"type": "string",
"example": "555-555-5555",
"description": "Phone number associated"
},
"address_line1": {
"type": "string",
"example": "PLACE DU CANADA",
"description": "The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines."
},
"city_locality": {
"type": "string",
"example": "TRUN",
"description": "The name of the city or locality"
},
"service_codes": {
"type": "array",
"items": {
"type": "string",
"description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) service code."
}
},
"state_province": {
"type": "string",
"example": "TRUN",
"description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation."
},
"service_point_id": {
"type": "string",
"example": "614940",
"description": "A unique identifier for a carrier drop off point."
},
"hours_of_operation": {
"type": "object",
"properties": {
"friday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"monday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"sunday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"tuesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"saturday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"thursday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"wednesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
}
},
"description": "Hours of operation"
}
},
"x-konfig-properties": {}
}
},
"description": "A get service point by ID response body"
}
get_service_points_request
{
"oneOf": [
{
"$ref": "#/components/schemas/get_service_points_request_body"
}
],
"title": "get_service_points_request"
}
get_service_points_request_body
{
"type": "object",
"title": "get_service_points_request_body",
"required": [
"providers"
],
"properties": {
"lat": {
"type": "number",
"format": "double",
"example": 48.874518928233094,
"description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html"
},
"long": {
"type": "number",
"format": "double",
"example": 2.3591775711639404,
"description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html"
},
"radius": {
"type": "integer",
"format": "int32",
"example": 500,
"description": "Search radius in kilometers"
},
"address": {
"type": "object",
"required": [
"country_code"
],
"properties": {
"postal_code": {
"$ref": "#/components/schemas/postal_code"
},
"country_code": {
"$ref": "#/components/schemas/country_code"
},
"address_line1": {
"type": "string",
"example": "1999 Bishop Grandin Blvd.",
"description": "The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines."
},
"address_line2": {
"type": "string"
},
"address_line3": {
"type": "string"
},
"city_locality": {
"type": "string",
"description": "The name of the city or locality"
},
"state_province": {
"type": "string",
"description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation."
}
},
"description": "Structured address to search by.",
"x-konfig-properties": {
"postal_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"providers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"carrier_id": {
"type": "string",
"example": "se-123456",
"description": "Uniquely identifies a carrier connection"
},
"service_code": {
"type": "array",
"items": {
"type": "string",
"example": "chronoclassic",
"description": "Uniquely identifies a shipping service"
}
}
}
},
"description": "An array of shipping service providers and service codes"
},
"max_results": {
"type": "integer",
"format": "int32",
"example": 25,
"description": "The maximum number of service points to return"
},
"address_query": {
"type": "string",
"example": "177A Bleecker Street New York",
"description": "Unstructured text to search for service points by."
}
},
"description": "A get service points request body. Caller must provide exactly one of address_query, address, or lat / long pair."
}
identifier_type
{
"enum": [
"vat",
"eori",
"ssn",
"ein",
"tin",
"ioss",
"pan",
"voec",
"pccc",
"oss",
"passport",
"abn"
],
"type": "string",
"title": "identifier_type",
"description": "Tax identifier type for customs declaration\n\n|Pickup Type | Description\n|---------------|-----------------------------------------\n|`vat` | The tax identifier is a Value Added Tax.\n|`eori` | The tax identifier is an Economic Operators Registration and Identification Number (EORI).\n|`ssn` | The tax identifier is a Social Security Number.\n|`ein` | The tax identifier is an Employer Identification Number (EIN).\n|`tin` | The tax identifier is a Tax Identification Number (TIN).\n|`ioss` | The tax identifier is an Import One-Stop Shop (IOSS).\n|`pan` | The tax identifier is a Permanent Account Number (PAN).\n|`voec` | The tax identifier is a Norwegian VAT On E-Commerce(VOEC).\n|`pccc` | The tax identifier is a Personal Customs Clearance Code (PCCC).\n|`oss` | The tax identifier is an One-Stop Shop (OSS).\n|`passport` | The tax identifier is a Passport Number.\n|`abn` | The tax identifier is an Australian Business Number.\n"
}
image_id
{
"type": "string",
"title": "image_id",
"example": "img_DtBXupDBxREpHnwEXhTfgK",
"minLength": 4,
"description": "Used to identify an image resource."
}
importer_of_records
{
"type": "object",
"title": "importer_of_records",
"required": [
"name",
"address_line1",
"city_locality",
"postal_code",
"country_code"
],
"properties": {
"name": {
"type": "string",
"example": "John Doe",
"minLength": 1,
"description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n"
},
"email": {
"type": "string",
"example": "example@example.com",
"nullable": true,
"description": "Email for the address owner.\n"
},
"phone": {
"type": "string",
"example": "+1 204-253-9411 ext. 123",
"minLength": 1,
"description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n"
},
"postal_code": {
"$ref": "#/components/schemas/postal_code"
},
"company_name": {
"type": "string",
"example": "The Home Depot",
"nullable": true,
"minLength": 1,
"description": "If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set.\n"
},
"country_code": {
"$ref": "#/components/schemas/country_code"
},
"address_line1": {
"type": "string",
"example": "1999 Bishop Grandin Blvd.",
"minLength": 1,
"description": "The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\n"
},
"address_line2": {
"type": "string",
"example": "Unit 408",
"nullable": true,
"minLength": 1,
"description": "The second line of the street address. For some addresses, this line may not be needed.\n"
},
"address_line3": {
"type": "string",
"example": "Building #7",
"nullable": true,
"minLength": 1,
"description": "The third line of the street address. For some addresses, this line may not be needed.\n"
},
"city_locality": {
"type": "string",
"example": "Winnipeg",
"minLength": 1,
"description": "The name of the city or locality"
},
"state_province": {
"type": "string",
"example": "Manitoba",
"minLength": 1,
"description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\n"
}
},
"description": "importer of records address, anywhere in the world.\n",
"x-konfig-properties": {
"country_code": {
"description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n"
}
}
}
insurance_provider
{
"enum": [
"none",
"shipsurance",
"carrier",
"third_party"
],
"type": "string",
"title": "insurance_provider",
"description": "The possible insurance provider values"
}
international_shipment_options
{
"type": "object",
"title": "international_shipment_options",
"required": [
"contents",
"non_delivery"
],
"properties": {
"contents": {
"$ref": "#/components/schemas/package_contents"
},
"declaration": {
"type": "string",
"description": "Declaration statement to be placed on the commercial invoice"
},
"non_delivery": {
"$ref": "#/components/schemas/non_delivery"
},
"customs_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customs_item"
},
"default": [],
"minItems": 0,
"deprecated": true,
"description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)"
},
"importer_of_record": {
"$ref": "#/components/schemas/importer_of_records"
},
"terms_of_trade_code": {
"$ref": "#/components/schemas/Allowed incoterms"
},
"contents_explanation": {
"type": "string",
"description": "Explanation for contents (required if the `contents` is provided as `other`)"
},
"invoice_additional_details": {
"$ref": "#/components/schemas/invoice_additional_details"
}
},
"description": "Options for international shipments, such as customs declarations.",
"x-konfig-properties": {
"contents": {
"default": "merchandise",
"description": "The type of contents in this shipment. This may impact import duties or customs treatment."
},
"non_delivery": {
"default": "return_to_sender",
"description": "Indicates what to do if a package is unable to be delivered."
},
"importer_of_record": {
"type": "object"
},
"terms_of_trade_code": {
"type": "string",
"description": "Specifies the supported terms of trade code (incoterms)"
},
"invoice_additional_details": {
"type": "object"
}
}
}
invoice_additional_details
{
"type": "object",
"title": "invoice_additional_details",
"properties": {
"discount": {
"$ref": "#/components/schemas/monetary_value"
},
"other_charge": {
"$ref": "#/components/schemas/monetary_value"
},
"freight_charge": {
"$ref": "#/components/schemas/monetary_value"
},
"insurance_charge": {
"$ref": "#/components/schemas/monetary_value"
},
"other_charge_description": {
"type": "string",
"description": "Description for the other charge (if provided)."
}
},
"description": "The additional information to put on commercial invoice \n",
"x-konfig-properties": {
"discount": {
"description": "Discount for shipment."
},
"other_charge": {
"description": "Other charge for shipment."
},
"freight_charge": {
"description": "Freight Charge for shipment."
},
"insurance_charge": {
"description": "Insurance Charge for shipment."
}
}
}
key
{
"type": "string",
"title": "key",
"example": "custom-key",
"min_length": 1,
"description": "Key/name of a header"
}
label
{
"type": "object",
"title": "label",
"properties": {
"status": {
"$ref": "#/components/schemas/label_status"
},
"voided": {
"type": "boolean",
"readOnly": true,
"description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n"
},
"batch_id": {
"$ref": "#/components/schemas/se_id"
},
"label_id": {
"$ref": "#/components/schemas/se_id"
},
"packages": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/package"
},
{
"$ref": "#/components/schemas/alternative_identifiers"
}
]
},
"readOnly": true,
"description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n"
},
"shipment": {
"$ref": "#/components/schemas/partial_shipment"
},
"ship_date": {
"$ref": "#/components/schemas/date"
},
"trackable": {
"type": "boolean",
"readOnly": true,
"description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n"
},
"voided_at": {
"allOf": [
{
"$ref": "#/components/schemas/date_time"
}
],
"nullable": true,
"readOnly": true,
"description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"created_at": {
"$ref": "#/components/schemas/date_time"
},
"rma_number": {
"type": "string",
"nullable": true,
"description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n"
},
"test_label": {
"type": "boolean",
"default": false,
"writeOnly": true,
"deprecated": true,
"description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account."
},
"shipment_id": {
"$ref": "#/components/schemas/se_id"
},
"carrier_code": {
"$ref": "#/components/schemas/carrier_code"
},
"charge_event": {
"$ref": "#/components/schemas/label_charge_event"
},
"label_format": {
"$ref": "#/components/schemas/label_format"
},
"label_layout": {
"$ref": "#/components/schemas/label_layout"
},
"package_code": {
"$ref": "#/components/schemas/package_code"
},
"service_code": {
"$ref": "#/components/schemas/service_code"
},
"form_download": {
"allOf": [
{
"$ref": "#/components/schemas/optional_link"
}
],
"nullable": true,
"readOnly": true,
"description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n"
},
"shipment_cost": {
"$ref": "#/components/schemas/monetary_value"
},
"display_scheme": {
"$ref": "#/components/schemas/display_scheme"
},
"insurance_cost": {
"$ref": "#/components/schemas/monetary_value"
},
"label_download": {
"$ref": "#/components/schemas/label_download"
},
"label_image_id": {
"allOf": [
{
"$ref": "#/components/schemas/image_id"
}
],
"nullable": true,
"description": "The label image resource that was used to create a custom label image."
},
"insurance_claim": {
"allOf": [
{
"$ref": "#/components/schemas/optional_link"
}
],
"nullable": true,
"readOnly": true,
"description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n"
},
"is_return_label": {
"type": "boolean",
"description": "Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned.\n"
},
"tracking_number": {
"type": "string",
"example": "782758401696",
"readOnly": true,
"minLength": 1,
"description": "The tracking number for the package. Tracking number formats vary across carriers."
},
"tracking_status": {
"$ref": "#/components/schemas/tracking_status"
},
"is_international": {
"type": "boolean",
"readOnly": true,
"description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n"
},
"validate_address": {
"$ref": "#/components/schemas/validate_address"
},
"outbound_label_id": {
"$ref": "#/components/schemas/se_id"
},
"label_download_type": {
"$ref": "#/components/schemas/label_download_type"
},
"alternative_identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/alternative_identifier"
},
"nullable": true,
"readOnly": true,
"description": "Additional information some carriers may provide by which to identify a given label in their system. \n"
},
"requested_comparison_amount": {
"$ref": "#/components/schemas/monetary_value"
}
},
"description": "A label represents the physical sticker that you affix to a package to ship it. ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them.\n",
"x-konfig-properties": {
"status": {
"readOnly": true
},
"batch_id": {
"readOnly": true,
"description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n"
},
"label_id": {
"readOnly": true,
"description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n"
},
"shipment": {
"writeOnly": true,
"description": "The shipment information used to generate the label"
},
"ship_date": {
"readOnly": true,
"description": "The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n"
},
"carrier_id": {
"readOnly": true,
"description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n"
},
"created_at": {
"readOnly": true,
"description": "The date and time that the label was created in ShipEngine."
},
"shipment_id": {
"readOnly": true,
"description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n"
},
"carrier_code": {
"readOnly": true,
"description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n"
},
"charge_event": {
"description": "The label charge event.\n"
},
"label_format": {
"default": "pdf",
"description": "The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\n"
},
"label_layout": {
"default": "4x6",
"description": "The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format.\n"
},
"package_code": {
"readOnly": true,
"description": "The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\n"
},
"service_code": {
"readOnly": true,
"description": "The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n"
},
"shipment_cost": {
"readOnly": true,
"description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n"
},
"display_scheme": {
"default": "label",
"description": "The display format that the label should be shown in."
},
"insurance_cost": {
"readOnly": true,
"description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n"
},
"label_download": {
"readOnly": true
},
"tracking_status": {
"readOnly": true,
"description": "The current status of the package, such as `in_transit` or `delivered`"
},
"validate_address": {
"default": "validate_and_clean",
"writeOnly": true
},
"outbound_label_id": {
"writeOnly": true,
"description": "The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is\nrequired by some carriers.\n"
},
"label_download_type": {
"default": "url",
"writeOnly": true
},
"requested_comparison_amount": {
"readOnly": true,
"description": "The total shipping cost for the specified comparison_rate_type.\n"
}
}
}
label_charge_event
{
"enum": [
"carrier_default",
"on_creation",
"on_carrier_acceptance"
],
"type": "string",
"title": "label_charge_event",
"description": "Determines when the user's account will be charged for the label."
}
label_download
{
"type": "object",
"title": "label_download",
"properties": {
"pdf": {
"$ref": "#/components/schemas/url"
},
"png": {
"$ref": "#/components/schemas/url"
},
"zpl": {
"$ref": "#/components/schemas/url"
},
"href": {
"$ref": "#/components/schemas/url"
}
},
"description": "Reference to the various downloadable file formats for the generated label\n",
"x-konfig-properties": {
"pdf": {
"description": "The URL for the pdf generated label"
},
"png": {
"description": "The URL for the png generated label"
},
"zpl": {
"description": "The URL for the zpl generated label"
},
"href": {
"description": "The URL of the linked resource, if any"
}
}
}
label_download_type
{
"enum": [
"url",
"inline"
],
"type": "string",
"title": "label_download_type",
"description": "There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/):\n\n|Label Download Type | Description\n|--------------------|------------------------------\n|`url` |You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.<br><br>This is the default if `label_download_type` is unspecified.\n|`inline` |You will receive the Base64-encoded label as part of the response. No need for a second request to download the label.\n"
}
label_format
{
"enum": [
"pdf",
"png",
"zpl"
],
"type": "string",
"title": "label_format",
"description": "The possible file formats in which shipping labels can be downloaded. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.\n\n|Label Format | Supported Carriers\n|--------------|-----------------------------------\n|`pdf` | All carriers\n|`png` | `fedex` <br> `stamps_com` <br> `ups` <br> `usps`\n|`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `rr_donnelley` <br> `stamps_com` <br> `ups` <br> `usps`\n"
}
label_layout
{
"enum": [
"4x6",
"letter"
],
"type": "string",
"title": "label_layout",
"description": "The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format.\n"
}
label_messages
{
"type": "object",
"title": "label_messages",
"required": [
"reference1",
"reference2",
"reference3"
],
"properties": {
"reference1": {
"type": "string",
"default": null,
"nullable": true,
"description": "The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc.\n"
},
"reference2": {
"type": "string",
"default": null,
"nullable": true,
"description": "The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc.\n"
},
"reference3": {
"type": "string",
"default": null,
"nullable": true,
"description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n"
}
},
"description": "Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.\n\n|Carrier |Max lines |Max line length\n|-------------------|----------|--------------------\n|USPS (Stamps.com) |3 |60\n|FedEx |3 |35 for the first line. 30 for additional lines.\n|UPS |2 |35\n|OnTrac |2 |25\n"
}
label_status
{
"enum": [
"processing",
"completed",
"error",
"voided"
],
"type": "string",
"title": "label_status",
"description": "The possible statuses that a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/) can be in.\n\n|Status |Description\n|:------------|:-----------------------------------------------------\n|`processing` |When labels are created in a [batch](https://www.shipengine.com/docs/labels/bulk/), it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in `processing` status.\n|`completed` |The label was successfully created\n|`error` |The label could not be created due to an error, such as an invalid delivery address\n|`voided` |The label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n"
}
list_batch_errors_response_body
{
"type": "object",
"title": "list_batch_errors_response_body",
"required": [
"errors",
"links"
],
"properties": {
"links": {
"$ref": "#/components/schemas/pagination_link"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/batch_response_error"
},
"default": [],
"readOnly": true,
"description": "The errors currently associated with the batch"
}
},
"description": "A batch errors response body",
"x-konfig-properties": {
"links": {
"readOnly": true
}
}
}
list_batches_response_body
{
"type": "object",
"title": "list_batches_response_body",
"required": [
"batches",
"total",
"page",
"pages",
"links"
],
"properties": {
"page": {
"type": "integer",
"format": "int32",
"example": 1,
"minimum": 1,
"readOnly": true,
"description": "The page that is currently being read"
},
"links": {
"$ref": "#/components/schemas/pagination_link"
},
"pages": {
"type": "integer",
"format": "int32",
"example": 10,
"minimum": 1,
"readOnly": true,
"description": "The total number of batch pages the API call returned"
},
"total": {
"type": "integer",
"format": "int64",
"example": 10,
"minimum": 0,
"readOnly": true,
"description": "The total number of batches the API call returned"
},
"batches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/batch"
},
"minItems": 0,
"readOnly": true,
"description": "Batch List"
}
},
"description": "A list batch response body",
"x-konfig-properties": {
"links": {
"readOnly": true
}
}
}
list_carrier_package_types_response_body
{
"type": "object",
"title": "list_carrier_package_types_response_body",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/package_type"
},
"readOnly": true,
"description": "An array of custom package types"
}
},
"description": "A list carrier package types response body"
}
list_carrier_services_response_body
{
"type": "object",
"title": "list_carrier_services_response_body",
"properties": {
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/service"
},
"readOnly": true,
"description": "An array of services associated with the carrier"
}
},
"description": "A carrier list services response body"
}
list_carriers_response_body
{
"type": "object",
"title": "list_carriers_response_body",
"required": [
"carriers"
],
"properties": {
"carriers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carrier"
},
"readOnly": true,
"description": "The carrier response body"
}
},
"description": "A carrier list response body"
}
list_manifests_response_body
{
"type": "object",
"title": "list_manifests_response_body",
"required": [
"manifests",
"total",
"page",
"pages",
"links"
],
"properties": {
"page": {
"type": "integer",
"format": "int32",
"example": 3,
"minimum": 1,
"readOnly": true,
"description": "Current page of the list manifests results"
},
"links": {
"$ref": "#/components/schemas/pagination_link"
},
"pages": {
"type": "integer",
"format": "int32",
"example": 4,
"minimum": 1,
"readOnly": true,
"description": "Total number of pages for list manifests results"
},
"total": {
"type": "integer",
"format": "int64",
"example": 3,
"minimum": 0,
"readOnly": true,
"description": "The total number of manifests returned"
},
"manifests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/manifest"
},
"default": [],
"readOnly": true,
"description": "The list of available manifests"
}
},
"description": "A list manifests response body",
"x-konfig-properties": {
"links": {
"readOnly": true,
"description": "Helpful links to other pages of results"
}
}
}
list_package_types_response_body
{
"type": "object",
"title": "list_package_types_response_body",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/package_type"
},
"readOnly": true,
"description": "An array of custom package types"
}
},
"description": "A list package types response body"
}
list_pickup_response_body
{
"type": "object",
"title": "list_pickup_response_body",
"required": [
"pickups",
"total",
"page",
"pages",
"links"
],
"properties": {
"page": {
"type": "integer",
"format": "int32",
"example": 3,
"minimum": 1,
"readOnly": true,
"description": "Current page of the list pickups results"
},
"links": {
"$ref": "#/components/schemas/pagination_link"
},
"pages": {
"type": "integer",
"format": "int32",
"example": 4,
"minimum": 1,
"readOnly": true,
"description": "Total number of pages for list pickups results"
},
"total": {
"type": "integer",
"format": "int64",
"example": 3,
"minimum": 0,
"readOnly": true,
"description": "The total number of pickups returned"
},
"pickups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pickup"
},
"description": "An array of pickups associated with the user's account."
}
},
"description": "A list pickup response body",
"x-konfig-properties": {
"links": {
"readOnly": true,
"description": "Helpful links to other pages of results"
}
}
}
list_service_points_response_body
{
"type": "object",
"title": "list_service_points_response_body",
"properties": {
"lat": {
"type": "number",
"format": "double",
"example": 48.842608,
"description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html"
},
"long": {
"type": "number",
"format": "double",
"example": 0.032875,
"description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
},
"readOnly": true,
"description": "The errors associated with the failed API call"
},
"service_points": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"example": 48.842608,
"description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html"
},
"long": {
"type": "number",
"format": "double",
"example": 0.032875,
"description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html"
},
"type": {
"enum": [
"pudo",
"locker"
],
"type": "string",
"default": "pudo",
"description": "Service point type"
},
"features": {
"type": "array",
"items": {
"enum": [
"drop_off_point",
"pickup_point",
"print_services",
"after_hours_locker",
"after_hours_dropbox"
],
"type": "string"
},
"description": "Service features"
},
"postal_code": {
"$ref": "#/components/schemas/postal_code"
},
"carrier_code": {
"$ref": "#/components/schemas/carrier_code"
},
"company_name": {
"type": "string",
"example": "My fancy company name",
"description": "If this is a business address, then the company name should be specified here."
},
"country_code": {
"$ref": "#/components/schemas/country_code"
},
"phone_number": {
"type": "string",
"example": "555-555-5555",
"description": "Phone number associated"
},
"address_line1": {
"type": "string",
"example": "PLACE DU CANADA",
"description": "The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines."
},
"city_locality": {
"type": "string",
"example": "TRUN",
"description": "The name of the city or locality"
},
"service_codes": {
"type": "array",
"items": {
"type": "string",
"example": "chronoclassic",
"description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) service code."
}
},
"state_province": {
"type": "string",
"example": "TRUN",
"description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation."
},
"service_point_id": {
"type": "string",
"example": "614940",
"description": "A unique identifier for a carrier drop off point."
},
"distance_in_meters": {
"type": "number",
"format": "double",
"example": 728.9959308847579,
"description": "Distance in meters"
},
"hours_of_operation": {
"type": "object",
"properties": {
"friday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"monday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"sunday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"tuesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"saturday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"thursday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
},
"wednesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "string",
"example": "09:15",
"description": "Opening time"
},
"close": {
"type": "string",
"example": "12:00",
"description": "Closing time"
}
}
}
}
},
"description": "Hours of operation"
}
},
"x-konfig-properties": {}
}
}
},
"description": "A list service points response body"
}
list_shipments_response_body
{
"type": "object",
"title": "list_shipments_response_body",
"required": [
"shipments",
"total",
"page",
"pages",
"links"
],
"properties": {
"page": {
"type": "integer",
"format": "int32",
"example": null,
"minimum": 1,
"readOnly": true
},
"links": {
"$ref": "#/components/schemas/pagination_link"
},
"pages": {
"type": "integer",
"format": "int32",
"minimum": 1,
"readOnly": true
},
"total": {
"type": "integer",
"format": "int64",
"example": 1990,
"minimum": 0,
"readOnly": true,
"description": "Total number of shipments returned by the api call"
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/partial_shipment"
},
"readOnly": true,
"description": "The list of shipments returned by the api call"
}
},
"description": "A list shipment response body",
"x-konfig-properties": {
"links": {
"readOnly": true
}
}
}
list_tags_response_body
{
"type": "object",
"title": "list_tags_response_body",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tag"
},
"description": "The array of tags returned by the API call"
}
},
"description": "Response body from a successful GET /tags API call"
}
list_warehouses_response_body
{
"type": "object",
"title": "list_warehouses_response_body",
"required": [
"warehouses"
],
"properties": {
"warehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/warehouse"
},
"readOnly": true,
"description": "The array of warehouses returned by the API call"
}
},
"description": "A warehouse list response body"
}
list_webhooks_response_body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/webhook"
},
"title": "list_webhooks_response_body",
"description": "A webhook list response body"
}
manifest
{
"type": "object",
"title": "manifest",
"properties": {
"form_id": {
"$ref": "#/components/schemas/se_id"
},
"label_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"readOnly": true,
"description": "An array of the label ids used in this manifest."
},
"ship_date": {
"type": "string",
"format": "date-time",
"example": "2019-07-12T13:37:39.050Z",
"readOnly": true,
"minLength": 1,
"description": "The date-time that the manifests shipments will be picked up"
},
"shipments": {
"type": "integer",
"format": "int32",
"example": 100,
"minimum": 1,
"readOnly": true,
"description": "The number of shipments that are included in this manifest"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2019-07-12T13:37:39.050Z",
"readOnly": true,
"minLength": 1,
"description": "The date-time that the manifest was created"
},
"manifest_id": {
"$ref": "#/components/schemas/se_id"
},
"warehouse_id": {
"$ref": "#/components/schemas/se_id"
},
"submission_id": {
"type": "string",
"example": "9475711899564878915476",
"readOnly": true,
"minLength": 1,
"description": "A string that uniquely identifies the submission"
},
"manifest_download": {
"$ref": "#/components/schemas/manifest_download"
}
},
"description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n",
"x-konfig-properties": {
"form_id": {
"readOnly": true,
"description": "A string that uniquely identifies the form"
},
"carrier_id": {
"readOnly": true,
"description": "A string that uniquely identifies the carrier"
},
"manifest_id": {
"readOnly": true,
"description": "A string that uniquely identifies the manifest"
},
"warehouse_id": {
"readOnly": true,
"description": "A string that uniquely identifies the warehouse"
},
"manifest_download": {
"readOnly": true
}
}
}
manifest_download
{
"type": "object",
"title": "manifest_download",
"properties": {
"href": {
"$ref": "#/components/schemas/url"
}
},
"description": "Object containing the href link to download the manifest file",
"x-konfig-properties": {
"href": {
"description": "The URL of the linked resource, if any"
}
}
}
manifest_request
{
"type": "object",
"title": "manifest_request",
"properties": {
"status": {
"$ref": "#/components/schemas/manifest_request_status"
},
"manifest_request_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A reference to the manifest request",
"x-konfig-properties": {
"manifest_request_id": {
"readOnly": true,
"description": "A string that uniquely identifies a manifest request"
}
}
}
manifest_request_status
{
"enum": [
"in_progress",
"completed"
],
"type": "string",
"title": "manifest_request_status",
"description": "The possible statuses of a manifest request"
}
manifests
{
"type": "object",
"title": "manifests",
"properties": {
"manifests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/manifest"
},
"description": "Resulting Manifests"
}
},
"description": "An array of manifest resources"
}
manifests_requests
{
"type": "object",
"title": "manifests_requests",
"properties": {
"manifest_requests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/manifest_request"
},
"description": "Resulting manifest requests with statuses"
}
},
"description": "An array of manifest requests"
}
modify_batch
{
"type": "object",
"title": "modify_batch",
"properties": {
"rate_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "Array of Rate IDs to be modifed on the batch"
},
"shipment_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "The Shipment Ids to be modified on the batch"
}
},
"description": "A modify batch object"
}
monetary_value
{
"type": "object",
"title": "monetary_value",
"required": [
"currency",
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"minimum": 0,
"description": "The monetary amount, in the specified currency."
},
"currency": {
"$ref": "#/components/schemas/currency"
}
},
"description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n",
"x-konfig-properties": {}
}
non_delivery
{
"enum": [
"return_to_sender",
"treat_as_abandoned"
],
"type": "string",
"title": "non_delivery",
"description": "The possible non delivery values"
}
normalized_entity
{
"type": "object",
"title": "normalized_entity",
"properties": {},
"description": "The normalized value of the entity.\n\nMost entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".\n\nSome entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.\n",
"additionalProperties": true
}
optional_link
{
"type": "object",
"title": "optional_link",
"properties": {
"href": {
"$ref": "#/components/schemas/url"
},
"type": {
"type": "string",
"minLength": 1,
"description": "The type of resource, or the type of relationship to the parent resource"
}
},
"description": "A link to a related resource, or an empty object if there is no resource to link to",
"x-konfig-properties": {
"href": {
"description": "The URL of the linked resource, if any"
}
}
}
order_source_name
{
"enum": [
"amazon_ca",
"amazon_us",
"brightpearl",
"channel_advisor",
"cratejoy",
"ebay",
"etsy",
"jane",
"groupon_goods",
"magento",
"paypal",
"seller_active",
"shopify",
"stitch_labs",
"squarespace",
"three_dcart",
"tophatter",
"walmart",
"woo_commerce",
"volusion"
],
"type": "string",
"title": "order_source_name",
"description": "The order sources that are supported by ShipEngine"
}
origin_type
{
"enum": [
"pickup",
"drop_off"
],
"type": "string",
"title": "origin_type",
"description": "Indicates if the package will be picked up or dropped off by the carrier"
}
package
{
"type": "object",
"title": "package",
"required": [
"weight"
],
"properties": {
"weight": {
"$ref": "#/components/schemas/weight"
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/products"
},
"default": [],
"minItems": 0,
"description": "Details about products inside packages (Information provided would be used on custom documentation)"
},
"sequence": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "Package sequence"
},
"dimensions": {
"$ref": "#/components/schemas/dimensions"
},
"package_id": {
"$ref": "#/components/schemas/se_id"
},
"package_code": {
"$ref": "#/components/schemas/package_code"
},
"form_download": {
"$ref": "#/components/schemas/optional_link"
},
"insured_value": {
"$ref": "#/components/schemas/monetary_value"
},
"label_download": {
"$ref": "#/components/schemas/label_download"
},
"label_messages": {
"$ref": "#/components/schemas/label_messages"
},
"tracking_number": {
"$ref": "#/components/schemas/tracking_number"
},
"content_description": {
"type": "string",
"example": "Hand knitted wool socks",
"nullable": true,
"maxLength": 35,
"minLength": 1,
"description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n"
},
"external_package_id": {
"type": "string",
"minLength": 1,
"description": "An external package id."
}
},
"description": "A package associated with a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n",
"x-konfig-properties": {
"weight": {
"description": "The package weight"
},
"dimensions": {
"description": "The package dimensions"
},
"package_id": {
"description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)"
},
"package_code": {
"description": "The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type.\n"
},
"form_download": {
"readOnly": true,
"description": "The form download for any customs that are needed"
},
"insured_value": {
"default": [
{
"amount": 0,
"currency": "usd"
}
],
"description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n"
},
"label_download": {
"readOnly": true,
"description": "The label download for the package"
},
"tracking_number": {
"readOnly": true,
"description": "The tracking number for the package. The format depends on the carrier.\n"
}
}
}
package_code
{
"type": "string",
"title": "package_code",
"example": "small_flat_rate_box",
"pattern": "^[a-z0-9]+(_[a-z0-9]+)*$",
"maxLength": 50,
"minLength": 1,
"description": "A [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. Use the code `package` for custom or unknown package types.\n"
}
package_contents
{
"enum": [
"merchandise",
"documents",
"gift",
"returned_goods",
"sample",
"other"
],
"type": "string",
"title": "package_contents",
"description": "The possible package contents values"
}
package_type
{
"type": "object",
"title": "package_type",
"required": [
"name",
"package_code"
],
"properties": {
"name": {
"type": "string",
"example": "laptop_box",
"maxLength": 50,
"minLength": 1
},
"dimensions": {
"$ref": "#/components/schemas/dimensions"
},
"package_id": {
"$ref": "#/components/schemas/se_id"
},
"description": {
"type": "string",
"example": "Packaging for laptops",
"nullable": true,
"maxLength": 500,
"description": "Provides a helpful description for the custom package."
},
"package_code": {
"$ref": "#/components/schemas/package_code"
}
},
"description": "A package type that a carrier supports for shipment.",
"x-konfig-properties": {
"dimensions": {
"description": "The custom dimensions for the package."
},
"package_id": {
"description": "A string that uniquely identifies the package."
}
}
}
packaging_group
{
"enum": [
"i",
"ii",
"iii"
],
"type": "string",
"title": "packaging_group"
}
packaging_instruction_section
{
"enum": [
"section_1",
"section_2",
"section_1a",
"section_1b"
],
"type": "string",
"title": "packaging_instruction_section"
}
paged_list_response_body
{
"type": "object",
"title": "paged_list_response_body",
"required": [
"total",
"page",
"pages",
"links"
],
"properties": {
"page": {
"type": "integer",
"example": 1,
"minimum": 1,
"description": "The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items."
},
"links": {
"$ref": "#/components/schemas/pagination_link"
},
"pages": {
"type": "integer",
"example": 4,
"minimum": 0,
"description": "The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero."
},
"total": {
"type": "integer",
"example": 2750,
"minimum": 0,
"description": "The total number of items across all pages of results"
}
},
"description": "Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.\n",
"x-konfig-properties": {},
"additionalProperties": true
}
pagination_link
{
"type": "object",
"title": "pagination_link",
"required": [
"first",
"last",
"prev",
"next"
],
"properties": {
"last": {
"$ref": "#/components/schemas/optional_link"
},
"next": {
"$ref": "#/components/schemas/optional_link"
},
"prev": {
"$ref": "#/components/schemas/optional_link"
},
"first": {
"$ref": "#/components/schemas/optional_link"
}
},
"description": "Helpful links to other pages of results",
"x-konfig-properties": {
"last": {
"description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n"
},
"next": {
"description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n"
},
"prev": {
"description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n"
},
"first": {
"description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n"
}
}
}
parse_address_request_body
{
"type": "object",
"title": "parse_address_request_body",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"example": "Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652.",
"minLength": 1,
"description": "The unstructured text that contains address-related entities"
},
"address": {
"$ref": "#/components/schemas/partial_address"
}
},
"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",
"x-konfig-properties": {
"address": {
"description": "You can optionally provide any already-known address 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"
}
}
}
parse_address_response_body
{
"type": "object",
"title": "parse_address_response_body",
"required": [
"score",
"address",
"entities"
],
"properties": {
"score": {
"type": "number",
"format": "double",
"maximum": 1,
"minimum": 0,
"description": "A confidence score between zero and one that indicates how certain the API is that it understood the text.\n"
},
"address": {
"$ref": "#/components/schemas/partial_address"
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recognized_entity"
},
"minItems": 0,
"description": "All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value.\n"
}
},
"description": "The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.\n",
"x-konfig-properties": {
"address": {
"description": "The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.\n\n> **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct.\n"
}
}
}
parse_shipment_request_body
{
"type": "object",
"title": "parse_shipment_request_body",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"example": "I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400.\n",
"minLength": 1,
"description": "The unstructured text that contains shipping-related entities"
},
"shipment": {
"$ref": "#/components/schemas/partial_shipment"
}
},
"description": "The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.\n",
"x-konfig-properties": {
"shipment": {
"description": "You can optionally provide a `shipment` object containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.\n"
}
}
}
parse_shipment_response_body
{
"type": "object",
"title": "parse_shipment_response_body",
"required": [
"score",
"shipment",
"entities"
],
"properties": {
"score": {
"type": "number",
"format": "double",
"maximum": 1,
"minimum": 0,
"description": "A confidence score between zero and one that indicates how certain the API is that it understood the text.\n"
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recognized_entity"
},
"minItems": 0,
"description": "All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value.\n"
},
"shipment": {
"$ref": "#/components/schemas/partial_shipment"
}
},
"description": "The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.\n",
"x-konfig-properties": {
"shipment": {
"description": "The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.\n\n> **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct.\n"
}
}
}
partial_address
{
"type": "object",
"title": "partial_address",
"properties": {
"name": {
"type": "string",
"example": "John Doe",
"minLength": 1,
"description": "The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field.\n"
},
"email": {
"type": "string",
"example": "example@example.com",
"nullable": true,
"description": "Email for the address owner.\n"
},
"phone": {
"type": "string",
"example": "+1 204-253-9411 ext. 123",
"minLength": 1,
"description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n"
},
"postal_code": {
"$ref": "#/components/schemas/postal_code"
},
"company_name": {
"type": "string",
"example": "The Home Depot",
"nullable": true,
"minLength": 1,
"description": "If this is a business address, then the company name should be specified here.\n"
},
"country_code": {
"$ref": "#/components/schemas/country_code"
},
"address_line1": {
"type": "string",
"example": "1999 Bishop Grandin Blvd.",
"minLength": 1,
"description": "The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.\n"
},
"address_line2": {
"type": "string",
"example": "Unit 408",
"nullable": true,
"minLength": 1,
"description": "The second line of the street address. For some addresses, this line may not be needed.\n"
},
"address_line3": {
"type": "string",
"example": "Building #7",
"nullable": true,
"minLength": 1,
"description": "The third line of the street address. For some addresses, this line may not be needed.\n"
},
"city_locality": {
"type": "string",
"example": "Winnipeg",
"minLength": 1,
"description": "The name of the city or locality"
},
"state_province": {
"type": "string",
"example": "Manitoba",
"minLength": 1,
"description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.\n"
},
"address_residential_indicator": {
"$ref": "#/components/schemas/address_residential_indicator"
}
},
"description": "A complete or partial mailing address.",
"x-konfig-properties": {
"country_code": {
"description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n"
},
"address_residential_indicator": {
"default": "unknown",
"example": "no",
"description": "Indicates whether this is a residential address."
}
}
}
partial_shipment
{
"type": "object",
"title": "partial_shipment",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tag"
},
"default": [],
"minItems": 0,
"readOnly": true,
"description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/shipment_item"
},
"default": [],
"description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n"
},
"customs": {
"allOf": [
{
"$ref": "#/components/schemas/international_shipment_options"
}
],
"default": null,
"nullable": true,
"description": "Customs information. This is usually only needed for international shipments.\n"
},
"ship_to": {
"$ref": "#/components/schemas/shipping_address_to"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/package"
},
"minItems": 1,
"description": "The packages in the shipment.\n\n> **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.\n"
},
"is_return": {
"type": "boolean",
"default": false,
"nullable": true,
"description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n"
},
"return_to": {
"$ref": "#/components/schemas/shipping_address"
},
"ship_date": {
"$ref": "#/components/schemas/date"
},
"ship_from": {
"$ref": "#/components/schemas/shipping_address"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"created_at": {
"$ref": "#/components/schemas/date_time"
},
"modified_at": {
"$ref": "#/components/schemas/date_time"
},
"shipment_id": {
"$ref": "#/components/schemas/se_id"
},
"confirmation": {
"$ref": "#/components/schemas/delivery_confirmation"
},
"service_code": {
"$ref": "#/components/schemas/service_code"
},
"total_weight": {
"$ref": "#/components/schemas/weight"
},
"warehouse_id": {
"allOf": [
{
"$ref": "#/components/schemas/se_id"
}
],
"default": null,
"nullable": true,
"description": "The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.\n"
},
"shipment_number": {
"type": "string",
"nullable": true,
"maxLength": 50,
"description": "A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.\n\n> **Warning:** The `shipment_number` is limited to 50 characters. Any additional characters will be truncated.\n"
},
"shipment_status": {
"$ref": "#/components/schemas/shipment_status"
},
"tax_identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tax_identifier"
},
"nullable": true
},
"advanced_options": {
"$ref": "#/components/schemas/advanced_shipment_options"
},
"external_order_id": {
"type": "string",
"nullable": true,
"description": "ID that the Order Source assigned"
},
"order_source_code": {
"$ref": "#/components/schemas/order_source_name"
},
"insurance_provider": {
"$ref": "#/components/schemas/insurance_provider"
},
"comparison_rate_type": {
"type": "string",
"example": "retail",
"nullable": true,
"description": "Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS."
},
"external_shipment_id": {
"type": "string",
"nullable": true,
"maxLength": 50,
"description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n\n> **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.\n"
}
},
"description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n",
"x-konfig-properties": {
"ship_to": {
"description": "The recipient's mailing address"
},
"return_to": {
"description": "The return address for this shipment. Defaults to the `ship_from` address.\n"
},
"ship_date": {
"description": "The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.\n"
},
"ship_from": {
"description": "The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.\n"
},
"carrier_id": {
"description": "The carrier account that is billed for the shipping charges"
},
"created_at": {
"readOnly": true,
"description": "The date and time that the shipment was created in ShipEngine."
},
"modified_at": {
"readOnly": true,
"description": "The date and time that the shipment was created or last modified."
},
"shipment_id": {
"readOnly": true,
"description": "A string that uniquely identifies the shipment"
},
"confirmation": {
"default": "none",
"description": "The type of delivery confirmation that is required for this shipment."
},
"service_code": {
"description": "The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n"
},
"total_weight": {
"readOnly": true,
"description": "The combined weight of all packages in the shipment"
},
"shipment_status": {
"default": "pending",
"readOnly": true,
"description": "The current status of the shipment"
},
"advanced_options": {
"description": "Advanced shipment options. These are entirely optional."
},
"insurance_provider": {
"default": "none",
"description": "The insurance provider to use for any insured packages in the shipment.\n"
}
}
}
partial_shipping_address
{
"type": "object",
"title": "partial_shipping_address",
"properties": {
"instructions": {
"type": "string",
"nullable": true,
"minLength": 1,
"description": "Additional text about how to handle the shipment at this address.\n"
}
},
"description": "A complete or partial mailing address."
}
partial_shipping_address_to
{
"type": "object",
"title": "partial_shipping_address_to",
"properties": {
"geolocation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"what3words"
],
"type": "string",
"example": "what3words",
"description": "Enum of available type of geolocation items:\n - 'what3words' functionality allows to specify a location by providing 3 words that have been assign to the specific location see [link](https://what3words.com/business) for more details.\n"
},
"value": {
"type": "string",
"example": "cats.with.thumbs",
"description": "value of the geolocation item"
}
}
}
},
"instructions": {
"type": "string",
"nullable": true,
"minLength": 1,
"description": "Additional text about how to handle the shipment at this address.\n"
}
},
"description": "A complete or partial mailing address."
}
payment_amount
{
"type": "object",
"title": "payment_amount",
"properties": {
"amount": {
"type": "number",
"format": "double",
"minimum": 0
},
"currency": {
"$ref": "#/components/schemas/currency"
}
},
"x-konfig-properties": {}
}
pickup
{
"type": "object",
"title": "pickup",
"properties": {
"label_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "Label IDs that will be included in the pickup request"
},
"pickup_id": {
"$ref": "#/components/schemas/pickup_resource_id"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"created_at": {
"$ref": "#/components/schemas/date_time"
},
"cancelled_at": {
"$ref": "#/components/schemas/date_time"
},
"pickup_notes": {
"type": "string",
"minLength": 0,
"description": "Used by some carriers to give special instructions for a package pickup"
},
"warehouse_id": {
"$ref": "#/components/schemas/se_id"
},
"pickup_window": {
"$ref": "#/components/schemas/pickup_window"
},
"pickup_address": {
"$ref": "#/components/schemas/partial_address"
},
"pickup_windows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pickup_windows"
},
"readOnly": true,
"description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n"
},
"contact_details": {
"$ref": "#/components/schemas/contact_details"
},
"confirmation_number": {
"type": "string",
"example": "292513CL4A3",
"nullable": true,
"readOnly": true,
"description": "The carrier confirmation number for the scheduled pickup."
}
},
"description": "The information necessary to schedule a package pickup\n",
"x-konfig-properties": {
"pickup_id": {
"readOnly": true
},
"carrier_id": {
"readOnly": true,
"description": "The carrier_id associated with the pickup"
},
"created_at": {
"readOnly": true,
"description": "The date and time that the pickup was created in ShipEngine."
},
"cancelled_at": {
"readOnly": true,
"description": "The date and time that the pickup was cancelled in ShipEngine."
},
"warehouse_id": {
"readOnly": true,
"description": "The warehouse_id associated with the pickup"
},
"pickup_address": {
"readOnly": true
}
}
}
pickup_resource_id
{
"type": "string",
"title": "pickup_resource_id",
"example": "pik_3YcKU5zdtJuCqoeNwyqqbW",
"minLength": 4,
"description": "Pickup Resource ID"
}
pickup_window
{
"type": "object",
"title": "pickup_window",
"required": [
"start_at",
"end_at"
],
"writeOnly": true,
"properties": {
"end_at": {
"$ref": "#/components/schemas/date_time"
},
"start_at": {
"$ref": "#/components/schemas/date_time"
}
},
"description": "The desired time range for the package pickup.",
"x-konfig-properties": {}
}
pickup_windows
{
"type": "object",
"title": "pickup_windows",
"properties": {
"end_at": {
"$ref": "#/components/schemas/date_time"
},
"start_at": {
"$ref": "#/components/schemas/date_time"
}
},
"x-konfig-properties": {}
}
postal_code
{
"type": "string",
"title": "postal_code",
"example": "78756-3717",
"minLength": 1,
"description": "postal code"
}
process_batch_request_body
{
"type": "object",
"title": "process_batch_request_body",
"properties": {
"ship_date": {
"$ref": "#/components/schemas/date_time"
},
"label_format": {
"$ref": "#/components/schemas/label_format"
},
"label_layout": {
"$ref": "#/components/schemas/label_layout"
},
"display_scheme": {
"$ref": "#/components/schemas/display_scheme"
}
},
"description": "A process batch request body",
"x-konfig-properties": {
"ship_date": {
"description": "The Ship date the batch is being processed for"
},
"label_format": {
"default": "pdf"
},
"label_layout": {
"type": "string",
"default": "4x6"
},
"display_scheme": {
"default": "label",
"description": "The display format that the label should be shown in."
}
}
}
products
{
"type": "object",
"title": "products",
"properties": {
"sku": {
"type": "string",
"nullable": true,
"description": "The SKU (Stock Keeping Unit) of the item"
},
"value": {
"$ref": "#/components/schemas/monetary_value"
},
"weight": {
"$ref": "#/components/schemas/weight"
},
"mid_code": {
"type": "string",
"nullable": true,
"description": "Manufacturers Identification code"
},
"quantity": {
"type": "integer",
"format": "int32",
"default": 0,
"minimum": 0,
"description": "The quantity of this item in the shipment."
},
"vat_rate": {
"type": "number",
"format": "double",
"example": 0.2,
"nullable": true,
"description": "VAT rate applicable to the item"
},
"description": {
"type": "string",
"default": null,
"nullable": true,
"maxLength": 100,
"description": "A description of the item"
},
"product_url": {
"type": "string",
"nullable": true,
"description": "link to the item on the seller website"
},
"dangerous_goods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dangerous_goods"
},
"default": [],
"minItems": 0,
"description": "Details about dangerous goods inside products"
},
"sku_description": {
"type": "string",
"nullable": true,
"description": "Description of the Custom Item's SKU"
},
"unit_of_measure": {
"type": "string",
"nullable": true
},
"country_of_origin": {
"allOf": [
{
"$ref": "#/components/schemas/country_code"
}
],
"default": null,
"nullable": true,
"description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n"
},
"harmonized_tariff_code": {
"type": "string",
"default": null,
"example": 3926.1,
"nullable": true,
"description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item."
}
},
"description": "The customs declaration for a single item in the shipment.",
"x-konfig-properties": {
"value": {
"description": "The declared value of each item"
},
"weight": {
"description": "The item weight"
}
}
}
purchase_label_without_shipment
{
"type": "object",
"title": "purchase_label_without_shipment",
"properties": {
"label_format": {
"$ref": "#/components/schemas/label_format"
},
"label_layout": {
"$ref": "#/components/schemas/label_layout"
},
"display_scheme": {
"$ref": "#/components/schemas/display_scheme"
},
"validate_address": {
"$ref": "#/components/schemas/validate_address"
},
"label_download_type": {
"$ref": "#/components/schemas/label_download_type"
}
},
"description": "A purchase label without shipment resource",
"x-konfig-properties": {
"label_format": {
"default": "pdf"
},
"label_layout": {
"default": "4x6"
},
"display_scheme": {
"default": "label",
"description": "The display format that the label should be shown in."
}
}
}
rate
{
"type": "object",
"title": "rate",
"required": [
"rate_id",
"rate_type",
"carrier_id",
"shipping_amount",
"insurance_amount",
"confirmation_amount",
"other_amount",
"zone",
"package_type",
"guaranteed_service",
"negotiated_rate",
"service_type",
"service_code",
"trackable",
"carrier_code",
"carrier_nickname",
"carrier_friendly_name",
"validation_status",
"warning_messages",
"error_messages"
],
"properties": {
"zone": {
"type": "integer",
"format": "int32",
"example": 6,
"minimum": 0,
"nullable": true,
"readOnly": true,
"description": "Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\ncustom zones that vary depending upon the ship_to and ship_from location\n"
},
"rate_id": {
"$ref": "#/components/schemas/se_id"
},
"rate_type": {
"$ref": "#/components/schemas/rate_type"
},
"ship_date": {
"type": "string",
"format": "date-time",
"readOnly": true,
"minLength": 1,
"description": "ship date"
},
"trackable": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if rate is trackable"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"tax_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"carrier_code": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "carrier code"
},
"other_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"package_type": {
"type": "string",
"example": "package",
"nullable": true,
"readOnly": true,
"minLength": 1,
"description": "package type that this rate was estimated for"
},
"service_code": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "service code for the rate"
},
"service_type": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "service type"
},
"delivery_days": {
"type": "integer",
"format": "int32",
"example": 5,
"minimum": 1,
"readOnly": true,
"description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n"
},
"error_messages": {
"type": "array",
"items": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "error message"
},
"minItems": 0,
"readOnly": true,
"description": "The error messages"
},
"negotiated_rate": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if the rates been negotiated"
},
"shipping_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"carrier_nickname": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "carrier nickname"
},
"insurance_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"warning_messages": {
"type": "array",
"items": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "warning message"
},
"minItems": 0,
"readOnly": true,
"description": "The warning messages"
},
"validation_status": {
"$ref": "#/components/schemas/validation_status"
},
"guaranteed_service": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if the rate is guaranteed."
},
"confirmation_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"carrier_delivery_days": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "The carrier delivery days"
},
"carrier_friendly_name": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "carrier friendly name"
},
"estimated_delivery_date": {
"$ref": "#/components/schemas/date"
},
"requested_comparison_amount": {
"$ref": "#/components/schemas/monetary_value"
}
},
"description": "A rate",
"x-konfig-properties": {
"rate_id": {
"readOnly": true,
"description": "A string that uniquely identifies the rate"
},
"rate_type": {
"readOnly": true
},
"carrier_id": {
"readOnly": true,
"description": "A string that uniquely identifies the carrier"
},
"tax_amount": {
"readOnly": true,
"description": "Tariff and additional taxes associated with an international shipment."
},
"other_amount": {
"readOnly": true,
"description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price."
},
"shipping_amount": {
"readOnly": true,
"description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price."
},
"insurance_amount": {
"readOnly": true,
"description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price."
},
"validation_status": {
"readOnly": true
},
"confirmation_amount": {
"readOnly": true,
"description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price."
},
"estimated_delivery_date": {
"readOnly": true
},
"requested_comparison_amount": {
"readOnly": true,
"description": "The total shipping cost for the specified comparison_rate_type."
}
}
}
rate_estimate
{
"type": "object",
"title": "rate_estimate",
"required": [
"rate_type",
"carrier_id",
"shipping_amount",
"insurance_amount",
"confirmation_amount",
"other_amount",
"zone",
"package_type",
"guaranteed_service",
"negotiated_rate",
"service_type",
"service_code",
"trackable",
"carrier_code",
"carrier_nickname",
"carrier_friendly_name",
"validation_status",
"warning_messages",
"error_messages"
],
"properties": {
"zone": {
"type": "integer",
"format": "int32",
"example": 6,
"minimum": 0,
"nullable": true,
"readOnly": true,
"description": "Certain carriers base [their rates](https://blog.stamps.com/2017/09/08/usps-postal-zones/) off of\ncustom zones that vary depending upon the ship_to and ship_from location\n"
},
"rate_type": {
"$ref": "#/components/schemas/rate_type"
},
"ship_date": {
"type": "string",
"format": "date-time",
"readOnly": true,
"minLength": 1,
"description": "ship date"
},
"trackable": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if rate is trackable"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"tax_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"carrier_code": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc."
},
"other_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"package_type": {
"type": "string",
"example": "package",
"nullable": true,
"readOnly": true,
"minLength": 1,
"description": "package type that this rate was estimated for"
},
"service_code": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "service code for the rate"
},
"service_type": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "service type"
},
"delivery_days": {
"type": "integer",
"format": "int32",
"example": 5,
"minimum": 1,
"readOnly": true,
"description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n"
},
"error_messages": {
"type": "array",
"items": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "error message"
},
"minItems": 0,
"readOnly": true,
"description": "The error messages"
},
"negotiated_rate": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if the rates been negotiated"
},
"shipping_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"carrier_nickname": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "carrier nickname"
},
"insurance_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"warning_messages": {
"type": "array",
"items": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "warning message"
},
"minItems": 0,
"readOnly": true,
"description": "The warning messages"
},
"validation_status": {
"$ref": "#/components/schemas/validation_status"
},
"guaranteed_service": {
"type": "boolean",
"readOnly": true,
"description": "Indicates if the rate is guaranteed."
},
"confirmation_amount": {
"$ref": "#/components/schemas/monetary_value"
},
"carrier_delivery_days": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "The carrier delivery days"
},
"carrier_friendly_name": {
"type": "string",
"readOnly": true,
"minLength": 1,
"description": "carrier friendly name"
},
"estimated_delivery_date": {
"$ref": "#/components/schemas/date"
}
},
"description": "A rate estimate",
"x-konfig-properties": {
"rate_type": {
"readOnly": true
},
"carrier_id": {
"readOnly": true,
"description": "A string that uniquely identifies the carrier"
},
"tax_amount": {
"readOnly": true,
"description": "Tariff and additional taxes associated with an international shipment."
},
"other_amount": {
"readOnly": true,
"description": "Any other charges associated with this rate"
},
"shipping_amount": {
"readOnly": true,
"description": "The shipping amount"
},
"insurance_amount": {
"readOnly": true,
"description": "The insurance amount"
},
"validation_status": {
"readOnly": true
},
"confirmation_amount": {
"readOnly": true,
"description": "The confirmation amount"
},
"estimated_delivery_date": {
"readOnly": true
}
}
}
rate_estimate_by_carrier_id
{
"type": "object",
"title": "rate_estimate_by_carrier_id",
"properties": {
"carrier_id": {
"$ref": "#/components/schemas/se_id"
}
},
"x-konfig-properties": {
"carrier_id": {
"deprecated": true,
"description": "A string that uniquely identifies the carrier"
}
}
}
rate_estimate_by_carrier_ids
{
"type": "object",
"title": "rate_estimate_by_carrier_ids",
"properties": {
"carrier_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"minItems": 1,
"description": "Array of Carrier Ids"
}
}
}
rate_estimate_options
{
"type": "object",
"title": "rate_estimate_options",
"properties": {
"weight": {
"$ref": "#/components/schemas/weight"
},
"ship_date": {
"$ref": "#/components/schemas/date_time"
},
"dimensions": {
"$ref": "#/components/schemas/dimensions"
},
"confirmation": {
"$ref": "#/components/schemas/delivery_confirmation"
},
"to_postal_code": {
"$ref": "#/components/schemas/postal_code"
},
"to_country_code": {
"$ref": "#/components/schemas/country_code"
},
"from_postal_code": {
"$ref": "#/components/schemas/postal_code"
},
"to_city_locality": {
"type": "string",
"example": "Austin",
"minLength": 1,
"description": "The city locality the package is being shipped to"
},
"from_country_code": {
"$ref": "#/components/schemas/country_code"
},
"to_state_province": {
"type": "string",
"example": "Houston",
"minLength": 1,
"description": "To state province"
},
"from_city_locality": {
"type": "string",
"example": "Austin",
"minLength": 1,
"description": "from postal code"
},
"from_state_province": {
"type": "string",
"example": "Austin",
"minLength": 1,
"description": "From state province"
},
"address_residential_indicator": {
"$ref": "#/components/schemas/address_residential_indicator"
}
},
"x-konfig-properties": {
"weight": {
"description": "The weight of the package"
},
"ship_date": {
"type": "string",
"description": "ship date"
},
"dimensions": {
"description": "The dimensions of the package"
}
}
}
rate_request_body
{
"type": "object",
"title": "rate_request_body",
"required": [
"carrier_ids"
],
"properties": {
"is_return": {
"type": "boolean",
"description": "Indicate if it's a return shipment"
},
"carrier_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"minItems": 1,
"description": "Array of carrier ids to get rates for"
},
"package_types": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"service_codes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"description": "Item Service Codes"
}
},
"preferred_currency": {
"$ref": "#/components/schemas/currency"
},
"calculate_tax_amount": {
"type": "boolean",
"description": "Calculate the duties and tariffs for cross border shipments."
}
},
"description": "A rate request body",
"x-konfig-properties": {}
}
rate_request_by_shipment_ids
{
"type": "object",
"title": "rate_request_by_shipment_ids",
"required": [
"shipment_ids"
],
"properties": {
"shipment_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_id"
},
"description": "The array of shipment IDs"
}
}
}
rate_request_by_shipments
{
"type": "object",
"title": "rate_request_by_shipments",
"required": [
"shipments"
],
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/address_validating_shipment"
},
"minItems": 1,
"description": "The array of shipments to get bulk rate estimates for"
}
}
}
rate_request_options
{
"type": "object",
"title": "rate_request_options",
"properties": {
"rate_options": {
"$ref": "#/components/schemas/rate_request_body"
}
},
"x-konfig-properties": {
"rate_options": {
"description": "The rate options"
}
}
}
rate_request_rate_options
{
"type": "object",
"title": "rate_request_rate_options",
"properties": {
"rate_options": {
"$ref": "#/components/schemas/rate_request_body"
}
},
"x-konfig-properties": {
"rate_options": {
"description": "The rate options"
}
}
}
rate_response
{
"type": "object",
"title": "rate_response",
"properties": {
"rate_response": {
"$ref": "#/components/schemas/rates_information"
}
},
"x-konfig-properties": {
"rate_response": {
"description": "The rates response"
}
}
}
rate_response_status
{
"enum": [
"working",
"completed",
"partial",
"error"
],
"type": "string",
"title": "rate_response_status",
"description": "The possible rate response status values"
}
rate_type
{
"enum": [
"check",
"shipment"
],
"type": "string",
"title": "rate_type",
"description": "The possible rate type values"
}
rates_information
{
"type": "object",
"title": "rates_information",
"properties": {
"rates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/rate"
},
"readOnly": true,
"description": "An array of shipment rates"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
}
},
"status": {
"$ref": "#/components/schemas/rate_response_status"
},
"created_at": {
"$ref": "#/components/schemas/se_id"
},
"shipment_id": {
"$ref": "#/components/schemas/se_id"
},
"invalid_rates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/rate"
},
"default": [],
"readOnly": true,
"description": "An array of invalid shipment rates"
},
"rate_request_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A rates information resource",
"x-konfig-properties": {
"status": {
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the rate was created"
},
"shipment_id": {
"readOnly": true,
"description": "A string that uniquely identifies the shipment"
},
"rate_request_id": {
"readOnly": true,
"description": "A string that uniquely identifies the rate request"
}
}
}
reason_code
{
"enum": [
"unknown",
"unspecified",
"validation_failed",
"label_not_found_within_void_period",
"label_already_used",
"label_already_voided",
"contact_carrier"
],
"type": "string",
"title": "reason_code",
"description": "The possible normalized reasons a label void request may not have been approved"
}
recognized_entity
{
"type": "object",
"title": "recognized_entity",
"required": [
"type",
"score",
"text",
"start_index",
"end_index"
],
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "The substring from the original text that was recognized as this entity"
},
"type": {
"type": "string",
"minLength": 1,
"description": "The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.)"
},
"score": {
"type": "number",
"format": "double",
"maximum": 1,
"minimum": 0,
"description": "A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity\n"
},
"result": {
"$ref": "#/components/schemas/normalized_entity"
},
"end_index": {
"type": "integer",
"minimum": 0,
"description": "The index of the last character of this entity within the original text"
},
"start_index": {
"type": "integer",
"minimum": 0,
"description": "The index of the first character of this entity within the original text"
}
},
"description": "An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value.\n"
}
redirect
{
"enum": [
"shipengine-dashboard"
],
"type": "string",
"title": "redirect",
"description": "The resource to return a redirect URL to."
}
regulation_level
{
"enum": [
"lightly_regulated",
"fully_regulated",
"limited_quantities",
"excepted_quantity"
],
"type": "string",
"title": "regulation_level"
}
response_message
{
"type": "object",
"title": "response_message",
"required": [
"code",
"message",
"type",
"detail_code"
],
"properties": {
"code": {
"$ref": "#/components/schemas/address_validation_code"
},
"type": {
"$ref": "#/components/schemas/address_validation_message_type"
},
"message": {
"type": "string",
"example": "Invalid Postal Code",
"readOnly": true,
"minLength": 1,
"description": "Message explaining the address validation error"
},
"detail_code": {
"allOf": [
{
"$ref": "#/components/schemas/address_validation_detail_code"
}
],
"nullable": true
}
},
"description": "A response message that displays when additional info is needed for an address validation request.",
"x-konfig-properties": {
"code": {
"readOnly": true
},
"type": {
"readOnly": true
}
}
}
schedule_pickup_response_body
{
"allOf": [
{
"$ref": "#/components/schemas/pickup"
},
{
"$ref": "#/components/schemas/error_response_body"
}
],
"title": "schedule_pickup_response_body"
}
se_id
{
"type": "string",
"title": "se_id",
"example": "se-28529731",
"pattern": "^se(-[a-z0-9]+)+$",
"maxLength": 25,
"minLength": 1,
"description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc."
}
service
{
"type": "object",
"title": "service",
"properties": {
"name": {
"type": "string",
"example": "USPS First Class Mail",
"readOnly": true,
"minLength": 1,
"description": "User friendly service name"
},
"domestic": {
"type": "boolean",
"readOnly": true,
"description": "Supports domestic shipping"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"carrier_code": {
"$ref": "#/components/schemas/se_id"
},
"service_code": {
"type": "string",
"example": "usps_media_mail",
"readOnly": true,
"minLength": 1,
"description": "service code"
},
"international": {
"type": "boolean",
"readOnly": true,
"description": "Supports international shipping."
},
"is_multi_package_supported": {
"type": "boolean",
"readOnly": true,
"description": "Carrier supports multiple packages per shipment"
}
},
"description": "A service offered by the carrier",
"x-konfig-properties": {
"carrier_id": {
"readOnly": true,
"description": "A string that uniquely identifies the carrier"
}
}
}
service_code
{
"type": "string",
"title": "service_code",
"example": "usps_first_class_mail",
"pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$",
"description": "A [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/), such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.\n"
}
shipment_id_request
{
"type": "object",
"title": "shipment_id_request",
"properties": {
"shipment_id": {
"$ref": "#/components/schemas/se_id"
}
},
"x-konfig-properties": {
"shipment_id": {
"description": "A string that uniquely identifies the shipment"
}
}
}
shipment_item
{
"type": "object",
"title": "shipment_item",
"properties": {
"sku": {
"type": "string",
"nullable": true,
"description": "Item Stock Keeping Unit"
},
"asin": {
"type": "string",
"example": "B00005N5PF",
"nullable": true,
"maxLength": 10,
"minLength": 10,
"description": "Amazon Standard Identification Number"
},
"name": {
"type": "string",
"minLength": 0,
"description": "item name"
},
"quantity": {
"type": "integer",
"format": "int32",
"minimum": 0,
"description": "The quantity of this item included in the shipment"
},
"sales_order_id": {
"type": "string",
"nullable": true,
"description": "sales order id"
},
"external_order_id": {
"type": "string",
"nullable": true,
"description": "external order id"
},
"order_source_code": {
"$ref": "#/components/schemas/order_source_name"
},
"sales_order_item_id": {
"type": "string",
"nullable": true,
"description": "sales order item id"
},
"external_order_item_id": {
"type": "string",
"nullable": true,
"description": "external order item id"
}
},
"description": "A shipment item",
"x-konfig-properties": {}
}
shipment_request
{
"type": "object",
"title": "shipment_request",
"properties": {
"shipment": {
"$ref": "#/components/schemas/address_validating_shipment"
}
},
"x-konfig-properties": {
"shipment": {
"description": "The shipment object"
}
}
}
shipment_status
{
"enum": [
"pending",
"processing",
"label_purchased",
"cancelled"
],
"type": "string",
"title": "shipment_status",
"description": "The possible shipment status values"
}
shipments_sort_by
{
"enum": [
"modified_at",
"created_at"
],
"type": "string",
"title": "shipments_sort_by",
"description": "The possible shipments sort by values"
}
shipping_address
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/partial_address"
},
{
"$ref": "#/components/schemas/partial_shipping_address"
}
],
"title": "shipping_address"
}
shipping_address_to
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/partial_address"
},
{
"$ref": "#/components/schemas/partial_shipping_address_to"
}
],
"title": "shipping_address_to"
}
smart_post_hub
{
"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"
],
"type": "string",
"title": "smart_post_hub",
"description": "The possible smart post hub values"
}
sort_dir
{
"enum": [
"asc",
"desc"
],
"type": "string",
"title": "sort_dir",
"description": "Controls the sort order of queries\n\n|Value |Description\n|:---------|:-----------------------------------------------------\n|`asc` |Return results in ascending order\n|`desc` |Return results in descending order\n"
}
status_code
{
"enum": [
"un",
"ac",
"it",
"de",
"ex",
"at",
"ny"
],
"type": "string",
"title": "status_code",
"readOnly": true,
"description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`un` | Unknown\n|`ac` | Accepted\n|`it` | In Transit\n|`de` | Delivered\n|`ex` | Exception\n|`at` | Delivery Attempt\n|`ny` | Not Yet In System\n"
}
tag
{
"type": "object",
"title": "tag",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Fragile",
"minLength": 1,
"description": "The tag name."
}
},
"description": "Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\n"
}
tag_name
{
"type": "string",
"title": "tag_name",
"example": "Fragile",
"minLength": 1,
"description": "Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.\n"
}
tag_shipment_response_body
{
"type": "object",
"title": "tag_shipment_response_body",
"required": [
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Get shipment tags response body"
}
tax_identifier
{
"type": "object",
"title": "tax_identifier",
"required": [
"taxable_entity_type",
"identifier_type",
"issuing_authority",
"value"
],
"properties": {
"value": {
"type": "string",
"description": "The value of the identifier"
},
"identifier_type": {
"$ref": "#/components/schemas/identifier_type"
},
"issuing_authority": {
"type": "string",
"description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code."
},
"taxable_entity_type": {
"$ref": "#/components/schemas/taxable_entity_type"
}
},
"description": "A tax identifier object",
"x-konfig-properties": {}
}
taxable_entity_type
{
"enum": [
"shipper",
"recipient",
"ior"
],
"type": "string",
"title": "taxable_entity_type",
"description": "The taxable entity type for this tax item. Valid values include the following\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`shipper` | The shipper is responsible for this tax.\n|`recipient` | The recipient of the shipment is responsible for this tax.\n|`ior` | The importer of records is responsible for tax.\n"
}
tokens_get_ephemeral_token_response_body.yaml
{
"type": "object",
"title": "tokens_get_ephemeral_token_response_body.yaml",
"properties": {
"token": {
"type": "string",
"description": "The requested token that expires in 10 seconds."
},
"redirect_url": {
"type": "string",
"description": "The redirect url formatted with the requested token."
}
}
}
track_event
{
"type": "object",
"title": "track_event",
"required": [
"occurred_at",
"city_locality",
"state_province",
"postal_code",
"carrier_detail_code",
"status_code",
"status_description",
"carrier_status_code",
"carrier_status_description"
],
"properties": {
"signer": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "Signer information"
},
"latitude": {
"type": "number",
"format": "double",
"maximum": 90,
"minimum": -90,
"description": "Latitude coordinate of tracking event."
},
"longitude": {
"type": "number",
"format": "double",
"maximum": 180,
"minimum": -180,
"description": "Longitude coordinate of tracking event."
},
"event_code": {
"type": "string",
"minLength": 0,
"description": "Event Code"
},
"description": {
"type": "string",
"example": "Delivered, In/At Mailbox",
"readOnly": true,
"minLength": 0,
"description": "Event description"
},
"occurred_at": {
"$ref": "#/components/schemas/date_time"
},
"postal_code": {
"type": "string",
"example": 78756,
"readOnly": true,
"minLength": 0,
"description": "Postal code"
},
"status_code": {
"$ref": "#/components/schemas/status_code"
},
"company_name": {
"type": "string",
"example": "Stamps.com",
"readOnly": true,
"minLength": 0,
"description": "Company Name"
},
"country_code": {
"$ref": "#/components/schemas/country_code"
},
"city_locality": {
"type": "string",
"example": "AUSTIN",
"readOnly": true,
"minLength": 0,
"description": "City locality"
},
"state_province": {
"type": "string",
"example": "TX",
"readOnly": true,
"minLength": 2,
"description": "State province"
},
"status_description": {
"type": "string",
"example": "In Transit",
"readOnly": true,
"minLength": 1,
"description": "Event Status Description"
},
"carrier_detail_code": {
"type": "string",
"example": "OT",
"readOnly": true,
"minLength": 1,
"description": "Carrier detail code"
},
"carrier_occurred_at": {
"$ref": "#/components/schemas/date_time"
},
"carrier_status_code": {
"type": "string",
"example": 1,
"readOnly": true,
"minLength": 1,
"description": "Carrier status code"
},
"carrier_status_description": {
"type": "string",
"example": "Your item was delivered in or at the mailbox at 9:10 am on March",
"readOnly": true,
"minLength": 0,
"description": "carrier status description"
}
},
"description": "A track event",
"x-konfig-properties": {
"occurred_at": {
"description": "Timestamp for carrier event"
},
"carrier_occurred_at": {
"description": "Carrier timestamp for the event, it is assumed to be the local time of where the event occurred."
}
}
}
tracking_information
{
"type": "object",
"title": "tracking_information",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/track_event"
},
"readOnly": true,
"description": "The events that have occured during the lifetime of this tracking number."
},
"ship_date": {
"$ref": "#/components/schemas/date_time"
},
"carrier_id": {
"$ref": "#/components/schemas/se_id"
},
"status_code": {
"$ref": "#/components/schemas/status_code"
},
"carrier_code": {
"$ref": "#/components/schemas/carrier_code"
},
"tracking_url": {
"type": "string",
"example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234",
"readOnly": true,
"description": "Carrier Tracking Url, if available"
},
"tracking_number": {
"$ref": "#/components/schemas/tracking_number"
},
"status_description": {
"type": "string",
"example": "Delivered",
"readOnly": true,
"minLength": 0,
"description": "Status description"
},
"carrier_detail_code": {
"type": "string",
"example": "OT",
"readOnly": true,
"minLength": 1,
"description": "Carrier detail code"
},
"carrier_status_code": {
"type": "string",
"example": 1,
"readOnly": true,
"minLength": 1,
"description": "Carrier status code"
},
"actual_delivery_date": {
"$ref": "#/components/schemas/date_time"
},
"exception_description": {
"type": "string",
"readOnly": true,
"minLength": 0,
"description": "Exception description"
},
"estimated_delivery_date": {
"$ref": "#/components/schemas/date_time"
},
"carrier_status_description": {
"type": "string",
"example": "Your item was delivered in or at the mailbox at 9:10 am on March",
"readOnly": true,
"minLength": 0,
"description": "carrier status description"
}
},
"description": "A tracking information resource",
"x-konfig-properties": {}
}
tracking_number
{
"type": "string",
"title": "tracking_number",
"example": "1Z932R800392060079",
"minLength": 1,
"description": "A tracking number for a package. The format depends on the carrier."
}
tracking_status
{
"enum": [
"unknown",
"in_transit",
"error",
"delivered"
],
"type": "string",
"title": "tracking_status",
"description": "The different statuses that can apply to a shipment."
}
transport_mean
{
"enum": [
"ground",
"water",
"cargo_aircraft_only",
"passenger_aircraft"
],
"type": "string",
"title": "transport_mean"
}
update_amazon_buy_shipping_request_body
{
"type": "object",
"title": "update_amazon_buy_shipping_request_body",
"properties": {
"email": {
"type": "string",
"minLength": 1,
"description": "Email"
}
},
"description": "An amazon buy shipping account settings request body"
}
update_carrier_settings_request_body
{
"oneOf": [
{
"$ref": "#/components/schemas/dhl_express_account_settings"
},
{
"$ref": "#/components/schemas/fedex_account_settings"
},
{
"$ref": "#/components/schemas/update_newgistics_settings_request_body"
},
{
"$ref": "#/components/schemas/ups_account_settings"
},
{
"$ref": "#/components/schemas/update_amazon_buy_shipping_request_body"
}
],
"title": "update_carrier_settings_request_body"
}
update_newgistics_settings_request_body
{
"type": "object",
"title": "update_newgistics_settings_request_body",
"properties": {
"include_barcode_with_order_number": {
"type": "boolean"
},
"receive_email_on_manifest_processing": {
"type": "boolean"
}
},
"description": "A newgistics account settings request body"
}
update_shipment_fields
{
"type": "object",
"title": "update_shipment_fields",
"properties": {
"validate_address": {
"$ref": "#/components/schemas/validate_address"
}
},
"x-konfig-properties": {
"validate_address": {
"default": "no_validation"
}
}
}
update_shipment_request_body
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/partial_shipment"
},
{
"$ref": "#/components/schemas/update_shipment_fields"
}
],
"title": "update_shipment_request_body",
"required": [
"ship_to",
"ship_from"
],
"description": "An update shipment request body"
}
update_shipments_tags
{
"type": "object",
"title": "update_shipments_tags",
"example": {
"shipments_tags": [
{
"tags": [
"Fragile",
"International"
],
"shipment_id": "se-1014296"
},
{
"tags": [
"Fragile",
"International"
],
"shipment_id": "se-1014297"
}
]
},
"properties": {
"shipments_tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"shipment_id": {
"type": "string"
}
}
}
}
}
}
update_warehouse_settings_request_body
{
"type": "object",
"title": "update_warehouse_settings_request_body",
"properties": {
"is_default": {
"type": "boolean",
"example": true,
"nullable": true,
"description": "The default property on the warehouse."
}
},
"description": "An update warehouse settings request body"
}
update_webhook_request_body
{
"type": "object",
"title": "update_webhook_request_body",
"properties": {
"url": {
"$ref": "#/components/schemas/url"
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/webhook_header"
},
"description": "Array of custom webhook headers"
}
},
"description": "An update webhook request body",
"x-konfig-properties": {
"url": {
"example": "https://[YOUR ENDPOINT ID].x.requestbin.com",
"description": "The url that the wehbook sends the request"
}
}
}
ups_account_settings
{
"type": "object",
"title": "ups_account_settings",
"properties": {
"invoice": {
"$ref": "#/components/schemas/ups_invoice"
},
"nickname": {
"type": "string",
"minLength": 1,
"description": "nickname"
},
"pickup_type": {
"$ref": "#/components/schemas/ups_pickup_type"
},
"is_primary_account": {
"type": "boolean",
"description": "Indicates if this is the primary UPS account"
},
"account_postal_code": {
"type": "string",
"minLength": 5,
"description": "account postal code"
},
"use_negotiated_rates": {
"type": "boolean",
"description": "The use negotiated rates"
},
"use_consolidation_services": {
"type": "boolean",
"description": "The use consolidation services"
},
"use_ground_freight_pricing": {
"type": "boolean",
"description": "The use ground freight pricing"
},
"mail_innovations_cost_center": {
"type": "string",
"minLength": 0,
"description": "mail innovations cost center"
},
"mail_innovations_endorsement": {
"$ref": "#/components/schemas/ancillary_service_endorsement"
},
"use_carbon_neutral_shipping_program": {
"type": "boolean",
"description": "The use carbon neutral shipping program"
},
"use_order_number_on_mail_innovations_labels": {
"type": "boolean",
"description": "The use order number on mail innovations labels"
}
},
"description": "UPS account settings",
"x-konfig-properties": {
"invoice": {
"description": "The invoice"
}
}
}
ups_invoice
{
"type": "object",
"title": "ups_invoice",
"properties": {
"control_id": {
"$ref": "#/components/schemas/se_id"
},
"invoice_date": {
"type": "string",
"format": "date-time",
"minLength": 1,
"description": "invoice date"
},
"invoice_amount": {
"type": "number",
"format": "double",
"minimum": 0
},
"invoice_number": {
"type": "string",
"minLength": 1,
"description": "invoice number"
},
"invoice_currency_code": {
"type": "string"
}
},
"description": "UPS invoice",
"x-konfig-properties": {
"control_id": {
"description": "A string that uniquely identifies the control"
}
}
}
ups_pickup_type
{
"enum": [
"daily_pickup",
"occasional_pickup",
"customer_counter"
],
"type": "string",
"title": "ups_pickup_type",
"description": "The possible ups pickup type values"
}
url
{
"type": "string",
"title": "url",
"format": "url",
"example": "http://api.shipengine.com/v1/labels/se-28529731",
"minLength": 1,
"description": "A URL"
}
uuid
{
"type": "string",
"title": "uuid",
"format": "uuid",
"example": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"maxLength": 36,
"minLength": 36,
"description": "A UUID (a.k.a. GUID) that uniquely identifies a resource"
}
validate_address
{
"enum": [
"no_validation",
"validate_only",
"validate_and_clean"
],
"type": "string",
"title": "validate_address",
"description": "The possible validate address values"
}
validate_address_request_body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/partial_address"
},
"title": "validate_address_request_body",
"description": "An address validation request body"
}
validate_address_response_body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/address_validation_result"
},
"title": "validate_address_response_body",
"description": "An address validation response body"
}
validate_shipment_fields
{
"type": "object",
"title": "validate_shipment_fields",
"properties": {
"validate_address": {
"$ref": "#/components/schemas/validate_address"
}
},
"x-konfig-properties": {
"validate_address": {
"default": "no_validation"
}
}
}
validation_status
{
"enum": [
"valid",
"invalid",
"has_warnings",
"unknown"
],
"type": "string",
"title": "validation_status",
"description": "The possible validation status values"
}
value
{
"type": "string",
"title": "value",
"example": "custom-value",
"description": "Value of a header"
}
void_label_response_body
{
"type": "object",
"title": "void_label_response_body",
"required": [
"approved",
"message"
],
"properties": {
"message": {
"type": "string",
"example": "Unable to delete FedEx shipment. Unable to retrieve record from database.",
"readOnly": true,
"minLength": 0
},
"approved": {
"type": "boolean",
"example": false,
"readOnly": true,
"description": "Indicates whether the attempt to void the label was successful"
},
"reason_code": {
"$ref": "#/components/schemas/reason_code"
}
},
"description": "A void label response body",
"x-konfig-properties": {
"reason_code": {
"type": "string",
"example": "label_not_found_within_void_period",
"readOnly": true,
"description": "Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later."
}
}
}
warehouse
{
"type": "object",
"title": "warehouse",
"properties": {
"name": {
"type": "string",
"example": "Zero Cool HQ",
"minLength": 1,
"description": "Name of the warehouse"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2019-06-25T18:12:35.583Z",
"readOnly": true,
"minLength": 1,
"description": "Timestamp that indicates when the warehouse was created"
},
"is_default": {
"type": "boolean",
"default": false,
"nullable": true,
"description": "Designates which single warehouse is the default on the account"
},
"warehouse_id": {
"$ref": "#/components/schemas/se_id"
},
"origin_address": {
"$ref": "#/components/schemas/partial_address"
},
"return_address": {
"$ref": "#/components/schemas/partial_address"
}
},
"description": "A warehouse",
"x-konfig-properties": {
"warehouse_id": {
"readOnly": true,
"description": "A string that uniquely identifies the warehouse"
},
"origin_address": {
"description": "The origin address of the warehouse"
},
"return_address": {
"description": "The return address associated with the warehouse"
}
}
}
webhook
{
"type": "object",
"title": "webhook",
"properties": {
"url": {
"$ref": "#/components/schemas/url"
},
"event": {
"$ref": "#/components/schemas/webhook_event"
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/webhook_header"
},
"description": "Array of custom webhook headers"
},
"webhook_id": {
"$ref": "#/components/schemas/se_id"
}
},
"description": "A webhook",
"x-konfig-properties": {
"url": {
"example": "https://[YOUR ENDPOINT ID].x.requestbin.com",
"description": "The url that the webhook sends the request to"
},
"webhook_id": {
"readOnly": true,
"description": "A string that uniquely identifies the webhook"
}
}
}
webhook_event
{
"enum": [
"batch",
"carrier_connected",
"order_source_refresh_complete",
"rate",
"report_complete",
"sales_orders_imported",
"track"
],
"type": "string",
"title": "webhook_event",
"description": "The possible webook event values"
}
webhook_header
{
"type": "object",
"title": "webhook_header",
"required": [
"key",
"value"
],
"properties": {
"key": {
"$ref": "#/components/schemas/key"
},
"value": {
"$ref": "#/components/schemas/value"
}
},
"description": "Optional header to be specified in webhook"
}
weight
{
"type": "object",
"title": "weight",
"required": [
"value",
"unit"
],
"properties": {
"unit": {
"$ref": "#/components/schemas/weight_unit"
},
"value": {
"type": "number",
"format": "double",
"minimum": 0,
"description": "The weight, in the specified unit",
"exclusiveMinimum": true
}
},
"description": "The weight of a package",
"x-konfig-properties": {}
}
weight_unit
{
"enum": [
"pound",
"ounce",
"gram",
"kilogram"
],
"type": "string",
"title": "weight_unit",
"description": "The possible weight unit values"
}