Skip to content

Instantly share code, notes, and snippets.

@JamesMessinger

JamesMessinger/swagger.json

Last active September 24, 2022 14:53
Show Gist options
  • Save JamesMessinger/8407128e276d6f429209347a3cf64177 to your computer and use it in GitHub Desktop.
Save JamesMessinger/8407128e276d6f429209347a3cf64177 to your computer and use it in GitHub Desktop.
Download ZIP
ShipEngine API definition
Raw
swagger.json
{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "ShipEngine"
},
"host": "api.shipengine.com",
"schemes": [
"https"
],
"paths": {
"/v1/connections/carriers/access_worldwide": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "AccessWorldwideAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AccessWorldwideAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/access_worldwide/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "AccessWorldwideAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/addresses/validate": {
"post": {
"tags": [
"Address Validation"
],
"operationId": "AddressValidation_ValidateAddresses",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "addresses",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AddressDTO"
}
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AddressValidationResponseDTO"
}
},
"examples": {
"application/json": [
{
"status": 1,
"original_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"matched_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"messages": [
{
"code": 0,
"message": "",
"type": 0
}
]
},
{
"status": 1,
"original_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"matched_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"messages": [
{
"code": 0,
"message": "",
"type": 0
}
]
}
]
}
},
"400": {
"description": "Bad Request: The request contained errors.",
"schema": {
"$ref": "#/definitions/ApiErrorResponseDTO"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ApiErrorResponseDTO"
}
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/apc": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "ApcAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ApcAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/apc/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "ApcAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/asendia": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "AsendiaAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AsendiaAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/asendia/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "AsendiaAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/batches/{batch_id}/errors": {
"get": {
"tags": [
"Batches"
],
"operationId": "Batches_ListErrors",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "batch_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/BatchResponseErrors"
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/batches": {
"get": {
"tags": [
"Batches"
],
"operationId": "Batches_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"type": "string",
"enum": [
"open",
"queued",
"processing",
"completed",
"completed_with_errors",
"archived",
"notifying",
"invalid"
]
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page_size",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sort_dir",
"in": "query",
"required": false,
"type": "string",
"enum": [
"asc",
"desc"
]
},
{
"name": "sort_by",
"in": "query",
"required": false,
"type": "string",
"enum": [
"ship_date",
"processed_at"
]
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ListBatchResponse"
}
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"post": {
"tags": [
"Batches"
],
"operationId": "Batches_Create",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateBatchRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The requested object creation was a success.",
"schema": {
"$ref": "#/definitions/Batch"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/batches/{batch_id}/add": {
"post": {
"tags": [
"Batches"
],
"operationId": "Batches_AddToBatch",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "batch_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ModifyBatchRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/batches/{batch_id}/remove": {
"post": {
"tags": [
"Batches"
],
"operationId": "Batches_RemoveFromBatch",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "batch_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ModifyBatchRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/batches/{batch_id}": {
"get": {
"tags": [
"Batches"
],
"operationId": "Batches_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "batch_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Batch"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/batches/external_batch_id/{external_batch_id}": {
"get": {
"tags": [
"Batches"
],
"operationId": "Batches_GetByExternalId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "external_batch_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Batch"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/batches/{batch_id}/process/labels": {
"post": {
"tags": [
"Batches"
],
"operationId": "Batches_Process",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "batch_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "process_batch_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ProcessBatchRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/carriers": {
"get": {
"tags": [
"Carriers"
],
"operationId": "Carriers_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/CarrierListResponse"
},
"examples": {
"application/json": {
"carriers": [
{
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"account_number": "SS-123",
"requires_funded_amount": true,
"balance": 80.55,
"nickname": "My Stamps",
"friendly_name": null,
"primary": true,
"has_multi_package_supporting_services": false,
"supports_label_messages": false,
"services": null,
"packages": null,
"options": null
},
{
"carrier_id": "se-764",
"carrier_code": "ups",
"account_number": "987654-ups",
"requires_funded_amount": false,
"balance": 0.0,
"nickname": "UPS-Wholesale",
"friendly_name": null,
"primary": true,
"has_multi_package_supporting_services": false,
"supports_label_messages": false,
"services": null,
"packages": null,
"options": null
}
]
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/carriers/{carrier_id}/services": {
"get": {
"tags": [
"Carriers"
],
"operationId": "Carriers_ListServices",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/CarrierListServicesResponse"
},
"examples": {
"application/json": {
"services": [
{
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"service_code": "usps_first_class_mail",
"name": "USPS First Class Mail",
"domestic": true,
"international": false,
"is_multi_package_supported": false
},
{
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"service_code": "usps_media_mail",
"name": "USPS Media Mail",
"domestic": true,
"international": false,
"is_multi_package_supported": false
},
{
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"service_code": "usps_priority_mail",
"name": "USPS Priority Mail",
"domestic": true,
"international": false,
"is_multi_package_supported": false
},
{
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"service_code": "usps_priority_mail_express",
"name": "USPS Priority Mail Express",
"domestic": true,
"international": false,
"is_multi_package_supported": false
},
{
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"service_code": "usps_first_class_mail_international",
"name": "USPS First Class Mail Intl",
"domestic": false,
"international": true,
"is_multi_package_supported": false
},
{
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"service_code": "usps_priority_mail_international",
"name": "USPS Priority Mail Intl",
"domestic": false,
"international": true,
"is_multi_package_supported": false
}
]
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/carriers/{carrier_id}": {
"get": {
"tags": [
"Carriers"
],
"operationId": "Carriers_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Carrier"
},
"examples": {
"application/json": {
"carrier_id": "se-761",
"carrier_code": "stamps_com",
"account_number": "SS-123",
"requires_funded_amount": true,
"balance": 80.55,
"nickname": "My Stamps",
"friendly_name": null,
"primary": true,
"has_multi_package_supporting_services": false,
"supports_label_messages": false,
"services": null,
"packages": null,
"options": null
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/carriers/{carrier_id}/packages": {
"get": {
"tags": [
"Carriers"
],
"operationId": "Carriers_ListPackages",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/CarrierListPackagesResponse"
},
"examples": {
"application/json": {
"packages": [
{
"package_id": "se-100",
"package_code": "flat_rate_envelope",
"name": "Flat Rate Envelope",
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"description": "USPS flat rate envelope. A special cardboard envelope provided by the USPS that clearly indicates \"Flat Rate\""
},
{
"package_id": "se-101",
"package_code": "flat_rate_padded_envelope",
"name": "Flat Rate Padded Envelope",
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"description": "Flat Rate Padded Envelope"
},
{
"package_id": "se-102",
"package_code": "large_package",
"name": "Large Package (any side > 12\")",
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"description": "Large package. Longest side plus the distance around the thickest part is over 84\" and less than or equal to 108\"."
},
{
"package_id": "se-103",
"package_code": "small_flat_rate_box",
"name": "Small Flat Rate Box",
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"description": "Small Flat Rate Box"
},
{
"package_id": "se-104",
"package_code": "medium_flat_rate_box",
"name": "Medium Flat Rate Box",
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"description": "USPS flat rate box. A special 11\" x 8 1/2\" x 5 1/2\" or 14\" x 3.5\" x 12\" USPS box that clearly indicates \"Flat Rate Box\""
}
]
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/carriers/{carrier_id}/options": {
"get": {
"tags": [
"Carriers"
],
"operationId": "Carriers_GetOptions",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/CarrierListOptionsResponse"
},
"examples": {
"application/json": {
"options": [
{
"name": "bill-duties-to-sender",
"default_value": null,
"description": null
},
{
"name": "dry-ice",
"default_value": null,
"description": null
},
{
"name": "sat-delivery",
"default_value": null,
"description": null
},
{
"name": "freight-class",
"default_value": null,
"description": null
},
{
"name": "requires-additional-handling",
"default_value": null,
"description": null
}
]
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/carriers/{carrier_id}/add_funds": {
"put": {
"tags": [
"Carriers"
],
"operationId": "Carriers_AddFunds",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "amount_to_add",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MoneyDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/BalanceResponse"
},
"examples": {
"application/json": {
"balance": {
"currency": 0,
"amount": 100.0
}
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/dhl_express": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "DHLExpressAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DHLExpressAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/dhl_express/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "DHLExpressAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/dhl_express/{carrier_id}/settings": {
"get": {
"tags": [
"Carrier Accounts"
],
"operationId": "DHLExpressAccountCarrier_GetSettings",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/UPSAccountSettingsDTO"
}
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"put": {
"tags": [
"Carrier Accounts"
],
"operationId": "DHLExpressAccountCarrier_UpdateSettings",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "settings",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DHLExpressAccountSettingsDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/endicia": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "EndiciaAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/EndiciaAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/endicia/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "EndiciaAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/environment/whoami": {
"get": {
"tags": [
"Environment"
],
"operationId": "Environment_Whoami",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/environment/webhooks": {
"get": {
"tags": [
"Environment"
],
"operationId": "Environment_Webhooks",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WebhookResponse"
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"post": {
"tags": [
"Environment"
],
"operationId": "Environment_CreateWebhook",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "create_webhook_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateWebhookRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/WebhookResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"409": {
"description": "Conflict"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/environment/webhooks/{webhook_id}": {
"get": {
"tags": [
"Environment"
],
"operationId": "Environment_GetWebhookById",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/WebhookResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"put": {
"tags": [
"Environment"
],
"operationId": "Environment_UpdateWebhook",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "update_webhook_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateWebhookRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"delete": {
"tags": [
"Environment"
],
"operationId": "Environment_DeleteWebhook",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "webhook_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "NotFound"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/fedex": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "FedExAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FedExAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/fedex/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "FedExAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/fedex/{carrier_id}/settings": {
"get": {
"tags": [
"Carrier Accounts"
],
"operationId": "FedExAccountCarrier_GetSettings",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/UPSAccountSettingsDTO"
}
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"put": {
"tags": [
"Carrier Accounts"
],
"operationId": "FedExAccountCarrier_UpdateSettings",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "settings",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FedExAccountSettingsDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/firstmile": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "FirstMileAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/FirstMileAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/firstmile/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "FirstMileAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/globegistics": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "GlobegisticsAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GlobegisticsAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/globegistics/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "GlobegisticsAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/imex": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "ImexAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ImexAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/imex/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "ImexAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/insurance/shipsurance/add_funds": {
"patch": {
"tags": [
"Insurance"
],
"operationId": "Insurance_AddFunds",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "cost",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MoneyDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/MoneyDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors.",
"schema": {
"$ref": "#/definitions/ApiErrorResponseDTO"
}
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/insurance/shipsurance/balance": {
"get": {
"tags": [
"Insurance"
],
"operationId": "Insurance_GetBalance",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/MoneyDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors.",
"schema": {
"$ref": "#/definitions/ApiErrorResponseDTO"
}
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/labels/{label_id}": {
"get": {
"tags": [
"Labels"
],
"operationId": "Labels_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "label_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Label"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/labels": {
"get": {
"tags": [
"Labels"
],
"operationId": "Labels_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "batch_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "label_status",
"in": "query",
"required": false,
"type": "string",
"enum": [
"processing",
"completed",
"error",
"voided"
]
},
{
"name": "carrier_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "service_code",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "tracking_number",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "warehouse_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "created_at_start",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "created_at_end",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page_size",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sort_dir",
"in": "query",
"required": false,
"type": "string",
"enum": [
"asc",
"desc"
]
},
{
"name": "sort_by",
"in": "query",
"required": false,
"type": "string",
"enum": [
"modified_at",
"created_at"
]
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ListLabelResponse"
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
},
"post": {
"tags": [
"Labels"
],
"operationId": "Labels_PurchaseLabel",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PurchaseLabelRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The requested object creation was a success.",
"schema": {
"$ref": "#/definitions/Label"
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/labels/rates/{rate_id}": {
"post": {
"tags": [
"Labels"
],
"operationId": "Labels_PurchaseLabelWithRate",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "rate_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PurchaseLabelWithoutShipmentRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The requested object creation was a success.",
"schema": {
"$ref": "#/definitions/Label"
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/labels/shipment/{shipment_id}": {
"post": {
"tags": [
"Labels"
],
"operationId": "Labels_PurchaseLabelWithShipment",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PurchaseLabelWithoutShipmentRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The requested object creation was a success.",
"schema": {
"$ref": "#/definitions/Label"
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/labels/{label_id}/void": {
"put": {
"tags": [
"Labels"
],
"operationId": "Labels_VoidLabel",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "label_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/VoidLabelResponse"
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/labels/{label_id}/track": {
"get": {
"tags": [
"Labels"
],
"operationId": "Labels_Track",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "label_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/TrackingInformation"
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/manifests": {
"get": {
"tags": [
"Manifests"
],
"operationId": "Manifests_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "warehouse_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "ship_date_start",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "ship_date_end",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "created_at_start",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "created_at_end",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "carrier_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page_size",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ListManifestsResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"post": {
"tags": [
"Manifests"
],
"operationId": "Manifests_Create",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateManifestRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ManifestResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/manifests/{manifest_id}": {
"get": {
"tags": [
"Manifests"
],
"operationId": "Manifests_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "manifest_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ManifestResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/newgistics": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "NewgisticsAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/NewgisticsAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/newgistics/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "NewgisticsAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/newgistics/{carrier_id}/settings": {
"put": {
"tags": [
"Carrier Accounts"
],
"operationId": "NewgisticsAccountCarrier_UpdateSettings",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "settings",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/NewgisticsAccountSettingsDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/ontrac": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "OnTracAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/OnTracAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/ontrac/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "OnTracAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/packages/{package_id}": {
"get": {
"tags": [
"Packages"
],
"operationId": "Packages_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "package_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Package"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"put": {
"tags": [
"Packages"
],
"operationId": "Packages_Update",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "package_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "package",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Package"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"delete": {
"tags": [
"Packages"
],
"operationId": "Packages_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "package_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/packages": {
"get": {
"tags": [
"Packages"
],
"operationId": "Packages_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/PackagesListResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"post": {
"tags": [
"Packages"
],
"operationId": "Packages_Create",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "package",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Package"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Package"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/rates": {
"post": {
"tags": [
"Rates"
],
"operationId": "Rates_RateShipment",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RateShipmentRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/RateShipmentResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/rates/bulk": {
"post": {
"tags": [
"Rates"
],
"operationId": "Rates_RateShipmentsAsync",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RateShipmentsRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/RateResponseAsync"
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/rates/{rate_id}": {
"get": {
"tags": [
"Rates"
],
"operationId": "Rates_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "rate_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Rate"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/rates/estimate": {
"post": {
"tags": [
"Rates"
],
"operationId": "Rates_Estimate",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "estimate_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RateEstimateRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Rate"
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/rr_donnelley": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "RrDonnelleyAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RrDonnelleyAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/rr_donnelley/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "RrDonnelleyAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/shipments/{shipment_id}/errors": {
"get": {
"tags": [
"Shipments"
],
"operationId": "Shipments_ListErrors",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pagesize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ShipmentResponseErrors"
},
"examples": {
"application/json": {
"errors": [
{
"error": "",
"shipment_id": "se-12345",
"external_shipment_id": "key-12345"
}
],
"links": {
"first": {},
"last": {},
"prev": {},
"next": {}
}
}
}
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/shipments/{shipment_id}": {
"get": {
"tags": [
"Shipments"
],
"operationId": "Shipments_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Shipment"
},
"examples": {
"application/json": {
"shipment_id": "se-1000",
"carrier_id": "",
"service_code": "",
"external_shipment_id": "key-1000",
"ship_date": null,
"created_at": "2018-03-29T16:42:33.1366461Z",
"modified_at": "2018-03-29T16:42:33.1376502Z",
"shipment_status": 0,
"ship_to": {
"name": "Mickey and Minnie Mouse",
"phone": "+1 (714) 781-4565",
"company_name": "The Walt Disney Company",
"address_line1": "500 South Buena Visa Street",
"address_line2": null,
"address_line3": null,
"city_locality": "Burbank",
"state_province": "CA",
"postal_code": "91521",
"country_code": "US",
"address_residential_indicator": 2
},
"ship_from": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"warehouse_id": null,
"return_to": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"confirmation": 0,
"customs": {
"contents": 2,
"customs_items": [],
"non_delivery": 0
},
"advanced_options": {
"bill_to_account": "billingAccount",
"bill_to_country_code": "US",
"bill_to_party": 1,
"bill_to_postal_code": "12345",
"contains_alcohol": true,
"delivered_duty_paid": false,
"non_machinable": true,
"saturday_delivery": true,
"use_ups_ground_freight_pricing": false,
"freight_class": "50",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null
},
"insurance_provider": 0,
"tags": [
{
"name": "first tag"
},
{
"name": "Pre-Order"
},
{
"name": "PRIORITY"
}
],
"packages": [
{
"package_code": null,
"weight": {
"value": 1.0,
"unit": 1
},
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"insured_value": {
"currency": 0,
"amount": 3.0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
}
}
],
"total_weight": {
"value": 1.0,
"unit": 1
}
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"put": {
"tags": [
"Shipments"
],
"operationId": "Shipments_UpdateShipment",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "shipment",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AddressValidatingShipment"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/CreateShipmentResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/shipments/external_shipment_id/{external_shipment_id}": {
"get": {
"tags": [
"Shipments"
],
"operationId": "Shipments_GetByExternalId",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "external_shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/Shipment"
},
"examples": {
"application/json": {
"shipment_id": "se-1000",
"carrier_id": "",
"service_code": "",
"external_shipment_id": "key-1000",
"ship_date": null,
"created_at": "2018-03-29T16:42:33.1796473Z",
"modified_at": "2018-03-29T16:42:33.1796473Z",
"shipment_status": 0,
"ship_to": {
"name": "Mickey and Minnie Mouse",
"phone": "+1 (714) 781-4565",
"company_name": "The Walt Disney Company",
"address_line1": "500 South Buena Visa Street",
"address_line2": null,
"address_line3": null,
"city_locality": "Burbank",
"state_province": "CA",
"postal_code": "91521",
"country_code": "US",
"address_residential_indicator": 2
},
"ship_from": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"warehouse_id": null,
"return_to": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"confirmation": 0,
"customs": {
"contents": 2,
"customs_items": [],
"non_delivery": 0
},
"advanced_options": {
"bill_to_account": "billingAccount",
"bill_to_country_code": "US",
"bill_to_party": 1,
"bill_to_postal_code": "12345",
"contains_alcohol": true,
"delivered_duty_paid": false,
"non_machinable": true,
"saturday_delivery": true,
"use_ups_ground_freight_pricing": false,
"freight_class": "50",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null
},
"insurance_provider": 0,
"tags": [
{
"name": "first tag"
},
{
"name": "Pre-Order"
},
{
"name": "PRIORITY"
}
],
"packages": [
{
"package_code": null,
"weight": {
"value": 1.0,
"unit": 1
},
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"insured_value": {
"currency": 0,
"amount": 3.0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
}
}
],
"total_weight": {
"value": 1.0,
"unit": 1
}
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/shipments": {
"get": {
"tags": [
"Shipments"
],
"operationId": "Shipments_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "batch_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "tag",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "shipment_status",
"in": "query",
"required": false,
"type": "string",
"enum": [
"pending",
"processing",
"label_purchased",
"cancelled"
]
},
{
"name": "modified_at_start",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "modified_at_end",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "created_at_start",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "created_at_end",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page_size",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sort_dir",
"in": "query",
"required": false,
"type": "string",
"enum": [
"asc",
"desc"
]
},
{
"name": "sort_by",
"in": "query",
"required": false,
"type": "string",
"enum": [
"modified_at",
"created_at"
]
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ListShipmentResponse"
},
"examples": {
"application/json": {
"shipments": [
{
"shipment_id": "se-1000",
"carrier_id": "",
"service_code": "",
"external_shipment_id": "key-1000",
"ship_date": null,
"created_at": "2018-03-29T16:42:33.4626497Z",
"modified_at": "2018-03-29T16:42:33.4626497Z",
"shipment_status": 0,
"ship_to": {
"name": "Mickey and Minnie Mouse",
"phone": "+1 (714) 781-4565",
"company_name": "The Walt Disney Company",
"address_line1": "500 South Buena Visa Street",
"address_line2": null,
"address_line3": null,
"city_locality": "Burbank",
"state_province": "CA",
"postal_code": "91521",
"country_code": "US",
"address_residential_indicator": 2
},
"ship_from": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"warehouse_id": null,
"return_to": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"confirmation": 0,
"customs": {
"contents": 2,
"customs_items": [],
"non_delivery": 0
},
"advanced_options": {
"bill_to_account": "billingAccount",
"bill_to_country_code": "US",
"bill_to_party": 1,
"bill_to_postal_code": "12345",
"contains_alcohol": true,
"delivered_duty_paid": false,
"non_machinable": true,
"saturday_delivery": true,
"use_ups_ground_freight_pricing": false,
"freight_class": "50",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null
},
"insurance_provider": 0,
"tags": [
{
"name": "first tag"
},
{
"name": "Pre-Order"
},
{
"name": "PRIORITY"
}
],
"packages": [
{
"package_code": null,
"weight": {
"value": 1.0,
"unit": 1
},
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"insured_value": {
"currency": 0,
"amount": 3.0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
}
}
],
"total_weight": {
"value": 1.0,
"unit": 1
}
},
{
"shipment_id": "se-1005",
"carrier_id": "",
"service_code": "",
"external_shipment_id": "key-1005",
"ship_date": null,
"created_at": "2018-03-29T16:42:33.4626497Z",
"modified_at": "2018-03-29T16:42:33.4626497Z",
"shipment_status": 0,
"ship_to": {
"name": "Mickey and Minnie Mouse",
"phone": "+1 (714) 781-4565",
"company_name": "The Walt Disney Company",
"address_line1": "500 South Buena Visa Street",
"address_line2": null,
"address_line3": null,
"city_locality": "Burbank",
"state_province": "CA",
"postal_code": "91521",
"country_code": "US",
"address_residential_indicator": 2
},
"ship_from": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"warehouse_id": null,
"return_to": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"confirmation": 0,
"customs": {
"contents": 2,
"customs_items": [],
"non_delivery": 0
},
"advanced_options": {
"bill_to_account": "billingAccount",
"bill_to_country_code": "US",
"bill_to_party": 1,
"bill_to_postal_code": "12345",
"contains_alcohol": true,
"delivered_duty_paid": false,
"non_machinable": true,
"saturday_delivery": true,
"use_ups_ground_freight_pricing": false,
"freight_class": "50",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null
},
"insurance_provider": 1,
"tags": [
{
"name": "first tag"
},
{
"name": "Pre-Order"
},
{
"name": "PRIORITY"
}
],
"packages": [
{
"package_code": null,
"weight": {
"value": 1.0,
"unit": 1
},
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"insured_value": {
"currency": 0,
"amount": 3.0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
}
}
],
"total_weight": {
"value": 1.0,
"unit": 1
}
}
],
"total": 2,
"page": 1,
"pages": 1,
"links": {
"first": {
"href": "http://localhost/v1/shipments?shipment_status=pending&sort_dir=desc&sort_by=created_at&page=1"
},
"last": {
"href": "http://localhost/v1/shipments?shipment_status=pending&sort_dir=desc&sort_by=created_at&page=1"
},
"prev": {
"href": ""
},
"next": {
"href": ""
}
}
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"post": {
"tags": [
"Shipments"
],
"operationId": "Shipments_CreateShipments",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipments_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateShipmentsRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"201": {
"description": "The requested object creation was a success.",
"schema": {
"$ref": "#/definitions/CreateShipmentsResponse"
},
"examples": {
"application/json": {
"has_errors": false,
"shipments": [
{
"errors": null,
"address_validation": {
"status": 1,
"original_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"matched_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"messages": []
},
"shipment_id": "se-12345",
"carrier_id": "",
"service_code": "",
"external_shipment_id": "key-1000",
"ship_date": null,
"created_at": "2018-03-29T16:42:33.2136493Z",
"modified_at": "2018-03-29T16:42:33.2136493Z",
"shipment_status": 0,
"ship_to": {
"name": "Mickey and Minnie Mouse",
"phone": "+1 (714) 781-4565",
"company_name": "The Walt Disney Company",
"address_line1": "500 South Buena Visa Street",
"address_line2": null,
"address_line3": null,
"city_locality": "Burbank",
"state_province": "CA",
"postal_code": "91521",
"country_code": "US",
"address_residential_indicator": 2
},
"ship_from": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"warehouse_id": null,
"return_to": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"confirmation": 0,
"customs": {
"contents": 2,
"customs_items": [],
"non_delivery": 0
},
"advanced_options": {
"bill_to_account": "billingAccount",
"bill_to_country_code": "US",
"bill_to_party": 1,
"bill_to_postal_code": "12345",
"contains_alcohol": true,
"delivered_duty_paid": false,
"non_machinable": true,
"saturday_delivery": true,
"use_ups_ground_freight_pricing": false,
"freight_class": "50",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null
},
"insurance_provider": 0,
"tags": [
{
"name": "first tag"
},
{
"name": "Pre-Order"
},
{
"name": "PRIORITY"
}
],
"packages": [
{
"package_code": null,
"weight": {
"value": 1.0,
"unit": 1
},
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"insured_value": {
"currency": 0,
"amount": 3.0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
}
}
],
"total_weight": {
"value": 1.0,
"unit": 1
}
},
{
"errors": null,
"address_validation": {
"status": 1,
"original_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"matched_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"messages": []
},
"shipment_id": "se-23456",
"carrier_id": "",
"service_code": "",
"external_shipment_id": "key-1005",
"ship_date": null,
"created_at": "2018-03-29T16:42:33.2146466Z",
"modified_at": "2018-03-29T16:42:33.2146466Z",
"shipment_status": 0,
"ship_to": {
"name": "Mickey and Minnie Mouse",
"phone": "+1 (714) 781-4565",
"company_name": "The Walt Disney Company",
"address_line1": "500 South Buena Visa Street",
"address_line2": null,
"address_line3": null,
"city_locality": "Burbank",
"state_province": "CA",
"postal_code": "91521",
"country_code": "US",
"address_residential_indicator": 2
},
"ship_from": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"warehouse_id": null,
"return_to": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"confirmation": 0,
"customs": {
"contents": 2,
"customs_items": [],
"non_delivery": 0
},
"advanced_options": {
"bill_to_account": "billingAccount",
"bill_to_country_code": "US",
"bill_to_party": 1,
"bill_to_postal_code": "12345",
"contains_alcohol": true,
"delivered_duty_paid": false,
"non_machinable": true,
"saturday_delivery": true,
"use_ups_ground_freight_pricing": false,
"freight_class": "50",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null
},
"insurance_provider": 1,
"tags": [
{
"name": "first tag"
},
{
"name": "Pre-Order"
},
{
"name": "PRIORITY"
}
],
"packages": [
{
"package_code": null,
"weight": {
"value": 1.0,
"unit": 1
},
"dimensions": {
"unit": 0,
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"insured_value": {
"currency": 0,
"amount": 3.0
},
"label_messages": {
"reference1": null,
"reference2": null,
"reference3": null
}
}
],
"total_weight": {
"value": 1.0,
"unit": 1
}
}
]
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/shipments/{shipment_id}/tags/{tag}": {
"post": {
"tags": [
"Shipments"
],
"operationId": "Shipments_AddTag",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "tag",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"201": {
"description": "The requested object creation was a success.",
"schema": {
"$ref": "#/definitions/ShipmentAddTagResponse"
},
"examples": {
"application/json": {
"shipment_id": "se-12345",
"tag": {
"name": "International"
}
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"delete": {
"tags": [
"Shipments"
],
"operationId": "Shipments_RemoveTag",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "tag",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/shipments/{shipment_id}/rates": {
"get": {
"tags": [
"Shipments"
],
"operationId": "Shipments_GetRatesForShipment",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "created_at_start",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/RateResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/shipments/{shipment_id}/cancel": {
"put": {
"tags": [
"Shipments"
],
"operationId": "Shipments_Cancel",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "shipment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/stamps_com": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "StampsAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StampsAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/stamps_com/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "StampsAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/stamps_com/{carrier_id}/request_account_url": {
"put": {
"tags": [
"Carrier Accounts"
],
"operationId": "StampsAccountCarrier_GetAccountUrl",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "stamps_account_urls_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StampsAccountUrlsRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/StampsAccountUrlsResponse"
}
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/tags": {
"get": {
"tags": [
"Tags"
],
"operationId": "Tags_ListTags",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ListTagResponse"
},
"examples": {
"application/json": {
"tags": [
{
"name": "first tag"
},
{
"name": "Pre-Order"
},
{
"name": "PRIORITY"
}
]
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/tags/{tag_name}/{new_name}": {
"put": {
"tags": [
"Tags"
],
"operationId": "Tags_UpdateTag",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "tag_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "new_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/tags/{tag_name}": {
"post": {
"tags": [
"Tags"
],
"operationId": "Tags_AddTag",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "tag_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/TagResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"delete": {
"tags": [
"Tags"
],
"operationId": "Tags_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "tag_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ListTagResponse"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/tracking": {
"get": {
"tags": [
"Tracking"
],
"operationId": "Tracking_Track",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_code",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "tracking_number",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/TrackingInformation"
},
"examples": {
"application/json": {
"tracking_number": "1Z932R800392060079",
"status_code": "AC",
"status_description": "Accepted",
"carrier_status_code": "M",
"carrier_status_description": "BILLING INFORMATION RECEIVED",
"ship_date": "2016-12-12T00:00:00Z",
"estimated_delivery_date": "2016-12-18T00:00:00Z",
"actual_delivery_date": null,
"exception_description": null,
"events": null
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/tracking/start": {
"post": {
"tags": [
"Tracking"
],
"operationId": "Tracking_StartTracking",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_code",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "tracking_number",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/tracking/stop": {
"post": {
"tags": [
"Tracking"
],
"operationId": "Tracking_StopTracking",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_code",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "tracking_number",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "BadRequest"
},
"404": {
"description": "NotFound"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/ups": {
"post": {
"tags": [
"Carrier Accounts"
],
"operationId": "UPSAccountCarrier_ConnectAccount",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UPSAccountInformationDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/ConnectAccountResponseDTO"
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/ups/{carrier_id}": {
"delete": {
"tags": [
"Carrier Accounts"
],
"operationId": "UPSAccountCarrier_DisconnectAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/connections/carriers/ups/{carrier_id}/settings": {
"get": {
"tags": [
"Carrier Accounts"
],
"operationId": "UPSAccountCarrier_GetSettings",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/UPSAccountSettingsDTO"
}
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"put": {
"tags": [
"Carrier Accounts"
],
"operationId": "UPSAccountCarrier_UpdateSettings",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "carrier_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "settings",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UPSAccountSettingsDTO"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/warehouses/{warehouse_id}": {
"get": {
"tags": [
"Warehouses"
],
"operationId": "Warehouses_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "warehouse_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/WarehouseDTO"
},
"examples": {
"application/json": {
"warehouse_id": "se-12345",
"name": "Home Garage",
"created_at": "2017-01-01T00:00:00Z",
"origin_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"return_address": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
}
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"put": {
"tags": [
"Warehouses"
],
"operationId": "Warehouses_Update",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "warehouse_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WarehouseRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"delete": {
"tags": [
"Warehouses"
],
"operationId": "Warehouses_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "warehouse_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"204": {
"description": "The request was a success."
},
"400": {
"description": "BadRequest"
},
"500": {
"description": "InternalServerError"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/warehouses": {
"get": {
"tags": [
"Warehouses"
],
"operationId": "Warehouses_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/WarehouseListDTO"
},
"examples": {
"application/json": {
"warehouses": [
{
"warehouse_id": "se-12345",
"name": "Home Garage",
"created_at": "2017-01-01T00:00:00Z",
"origin_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"return_address": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
}
},
{
"warehouse_id": "se-54321",
"name": "HQ",
"created_at": "2016-05-15T00:00:00Z",
"origin_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"return_address": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
}
}
]
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
},
"post": {
"tags": [
"Warehouses"
],
"operationId": "Warehouses_Create",
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WarehouseRequest"
}
},
{
"name": "api-key",
"in": "header",
"description": "API Key",
"required": true,
"type": "string",
"format": "string",
"default": "jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY"
}
],
"responses": {
"200": {
"description": "The request was a success.",
"schema": {
"$ref": "#/definitions/WarehouseDTO"
},
"examples": {
"application/json": {
"warehouse_id": "se-12345",
"name": "Home Garage",
"created_at": "2017-01-01T00:00:00Z",
"origin_address": {
"name": "The President",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
},
"return_address": {
"name": "Returns Department",
"phone": "512-485-4282",
"company_name": "ShipStation",
"address_line1": "3800 N Lamar Blvd #220",
"address_line2": null,
"address_line3": null,
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"address_residential_indicator": 2
}
}
}
},
"400": {
"description": "Bad Request: The request contained errors."
},
"404": {
"description": "The requested object was not found."
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api-key": []
}
]
}
},
"/v1/addresses/recognize": {
"put": {
"summary": "Identifies address-related entities (name, line1, line2, city, postal code, etc.) in unstructured text\n",
"tags": [
"NLP"
],
"operationId": "NLP_recognizeAddress",
"security": [
{
"api-key": []
}
],
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RecognizeAddressRequestDTO"
}
}
],
"responses": {
"200": {
"description": "Returns a list of the entities that were recognized, a confidence score, and a ShipEngine Address DTO populated with the recognized entity values\n",
"schema": {
"type": "object",
"properties": {
"score": {
"format": "double",
"minimum": 0,
"type": "number",
"description": "A confidence score between zero and one that indicates how certain the API is that it understood the text",
"maximum": 1
},
"address": {
"$ref": "#/definitions/AddressDTO"
},
"entities": {
"minItems": 0,
"items": {
"$ref": "#/definitions/RecognizedEntity"
},
"type": "array",
"description": "An array containing all of the entities that were recognized."
}
}
}
}
}
}
},
"/v1/shipments/recognize": {
"put": {
"summary": "Identifies shipment-related entities (names, address parts, package dimensions, weight, insurance options, etc.) in unstructured text\n",
"tags": [
"NLP"
],
"operationId": "NLP_recognizeShipment",
"security": [
{
"api-key": []
}
],
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RecognizeShipmentRequestDTO"
}
}
],
"responses": {
"200": {
"description": "Returns a list of the entities that were recognized, a confidence score, and a ShipEngine Shipment DTO populated with the recognized entity values\n",
"schema": {
"type": "object",
"properties": {
"score": {
"format": "double",
"minimum": 0,
"type": "number",
"description": "A confidence score between zero and one that indicates how certain the API is that it understood the text",
"maximum": 1
},
"shipment": {
"$ref": "#/definitions/Shipment"
},
"entities": {
"minItems": 0,
"items": {
"$ref": "#/definitions/RecognizedEntity"
},
"type": "array",
"description": "An array containing all of the entities that were recognized."
}
}
}
}
}
}
}
},
"definitions": {
"AccessWorldwideAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"ConnectAccountResponseDTO": {
"type": "object",
"properties": {
"carrier_id": {
"type": "string"
}
}
},
"AddressDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": "string"
},
"company_name": {
"type": "string"
},
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"address_line3": {
"type": "string"
},
"city_locality": {
"type": "string"
},
"state_province": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"country_code": {
"type": "string"
},
"address_residential_indicator": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string"
}
},
"example": [
{
"name": "The President",
"phone": "512-485-4282",
"companyName": "ShipStation",
"addressLine1": "3800 N Lamar Blvd #220",
"cityLocality": "Austin",
"stateProvince": "TX",
"postalCode": "78756",
"countryCode": "US",
"addressResidentialIndicator": "no"
},
{
"name": "The President",
"phone": "512-485-4282",
"companyName": "ShipStation",
"addressLine1": "3800 N Lamar Blvd #220",
"cityLocality": "Austin",
"stateProvince": "TX",
"postalCode": "78756",
"countryCode": "US",
"addressResidentialIndicator": "no"
}
]
},
"AddressValidationResponseDTO": {
"type": "object",
"properties": {
"status": {
"enum": [
"unverified",
"verified",
"warning",
"error"
],
"type": "string"
},
"original_address": {
"$ref": "#/definitions/AddressDTO"
},
"matched_address": {
"$ref": "#/definitions/AddressDTO"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/definitions/ResponseMessageDTO"
}
},
"native_matched_parsed_address": {
"type": "object"
},
"output_notes": {
"type": "string"
}
}
},
"ResponseMessageDTO": {
"type": "object",
"properties": {
"code": {
"enum": [
"a1000",
"a1001",
"a1002",
"a1003",
"a1004",
"a1005",
"a1006",
"r1000",
"r1001",
"r1002",
"r1003"
],
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"enum": [
"error",
"warning",
"info"
],
"type": "string"
}
}
},
"ApiErrorResponseDTO": {
"type": "object",
"properties": {
"request_id": {
"format": "uuid",
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiErrorDTO"
}
}
}
},
"ApiErrorDTO": {
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"AmazonAccountInformationRequest": {
"type": "object",
"properties": {
"store_name": {
"type": "string"
},
"merchant_seller_id": {
"type": "string"
},
"product_identifier": {
"enum": [
"sku",
"asin"
],
"type": "string"
},
"mws_auth_token": {
"type": "string"
}
}
},
"ConnectMarketplaceResponseDTO": {
"type": "object",
"properties": {
"store_id": {
"format": "uuid",
"type": "string"
}
}
},
"ApcAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"AsendiaAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"account_number": {
"type": "string"
},
"ftp_username": {
"type": "string"
},
"ftp_password": {
"type": "string"
}
}
},
"BatchResponseErrors": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/BatchResponseError"
}
},
"links": {
"$ref": "#/definitions/PaginationLinkDTO"
}
}
},
"BatchResponseError": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"shipment_id": {
"type": "string"
}
}
},
"PaginationLinkDTO": {
"type": "object",
"properties": {
"first": {
"$ref": "#/definitions/LinkDTO"
},
"last": {
"$ref": "#/definitions/LinkDTO"
},
"prev": {
"$ref": "#/definitions/LinkDTO"
},
"next": {
"$ref": "#/definitions/LinkDTO"
},
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"LinkDTO": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"ListBatchResponse": {
"type": "object",
"properties": {
"batches": {
"type": "array",
"items": {
"$ref": "#/definitions/Batch"
}
},
"total": {
"format": "int64",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"pages": {
"format": "int32",
"type": "integer"
},
"links": {
"$ref": "#/definitions/PaginationLinkDTO"
}
}
},
"Batch": {
"type": "object",
"properties": {
"label_layout": {
"type": "string"
},
"label_format": {
"enum": [
"pdf",
"zpl",
"png"
],
"type": "string"
},
"batch_id": {
"type": "string"
},
"external_batch_id": {
"type": "string"
},
"batch_notes": {
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"processed_at": {
"format": "date-time",
"type": "string"
},
"errors": {
"format": "int32",
"type": "integer"
},
"warnings": {
"format": "int32",
"type": "integer"
},
"completed": {
"format": "int32",
"type": "integer"
},
"forms": {
"format": "int32",
"type": "integer"
},
"count": {
"format": "int32",
"type": "integer"
},
"batch_shipments_url": {
"$ref": "#/definitions/LinkDTO"
},
"batch_labels_url": {
"$ref": "#/definitions/LinkDTO"
},
"batch_errors_url": {
"$ref": "#/definitions/LinkDTO"
},
"label_download": {
"$ref": "#/definitions/LinkDTO"
},
"form_download": {
"$ref": "#/definitions/LinkDTO"
},
"status": {
"enum": [
"open",
"queued",
"processing",
"completed",
"completed_with_errors",
"archived",
"notifying",
"invalid"
],
"type": "string"
}
}
},
"CreateBatchRequest": {
"type": "object",
"properties": {
"external_batch_id": {
"type": "string"
},
"batch_notes": {
"type": "string"
},
"shipment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"rate_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ModifyBatchRequest": {
"type": "object",
"properties": {
"shipment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"rate_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProcessBatchRequest": {
"type": "object",
"properties": {
"ship_date": {
"format": "date-time",
"type": "string"
},
"label_layout": {
"type": "string"
},
"label_format": {
"enum": [
"pdf",
"zpl",
"png"
],
"type": "string"
}
}
},
"CarrierListResponse": {
"type": "object",
"properties": {
"carriers": {
"type": "array",
"items": {
"$ref": "#/definitions/Carrier"
}
}
}
},
"Carrier": {
"type": "object",
"properties": {
"carrier_id": {
"type": "string"
},
"carrier_code": {
"type": "string"
},
"account_number": {
"type": "string"
},
"requires_funded_amount": {
"type": "boolean"
},
"balance": {
"format": "double",
"type": "number"
},
"nickname": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"has_multi_package_supporting_services": {
"type": "boolean"
},
"supports_label_messages": {
"type": "boolean"
},
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/Service"
}
},
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/Package"
}
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/CarrierAdvancedOption"
}
}
}
},
"Service": {
"type": "object",
"properties": {
"carrier_id": {
"type": "string"
},
"carrier_code": {
"type": "string"
},
"service_code": {
"type": "string"
},
"name": {
"type": "string"
},
"domestic": {
"type": "boolean"
},
"international": {
"type": "boolean"
},
"is_multi_package_supported": {
"type": "boolean"
}
}
},
"Package": {
"required": [
"name"
],
"type": "object",
"properties": {
"package_id": {
"type": "string"
},
"package_code": {
"type": "string"
},
"name": {
"type": "string"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"description": {
"type": "string"
}
}
},
"CarrierAdvancedOption": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"default_value": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"Dimensions": {
"type": "object",
"properties": {
"unit": {
"enum": [
"inch",
"centimeter"
],
"type": "string"
},
"length": {
"format": "double",
"type": "number"
},
"width": {
"format": "double",
"type": "number"
},
"height": {
"format": "double",
"type": "number"
}
}
},
"CarrierListServicesResponse": {
"type": "object",
"properties": {
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/Service"
}
}
}
},
"CarrierListPackagesResponse": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/Package"
}
}
}
},
"CarrierListOptionsResponse": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/CarrierAdvancedOption"
}
}
}
},
"MoneyDTO": {
"type": "object",
"properties": {
"currency": {
"enum": [
"uSD",
"cAD",
"aUD",
"gBP",
"eUR"
],
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
}
}
},
"BalanceResponse": {
"type": "object",
"properties": {
"balance": {
"$ref": "#/definitions/MoneyDTO"
}
}
},
"ChannelAdvisorAccountInformationRequest": {
"type": "object",
"properties": {
"store_name": {
"type": "string"
},
"profile_id": {
"format": "int32",
"type": "integer"
},
"product_identifier": {
"enum": [
"clientOrderNumber",
"channelAdvisorOrderNumber"
],
"type": "string"
}
}
},
"DHLExpressAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"account_number": {
"type": "string"
}
}
},
"DHLExpressAccountSettingsDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"should_hide_account_number_on_archive_doc": {
"type": "boolean"
},
"is_primary_account": {
"type": "boolean"
}
}
},
"UPSAccountSettingsDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"is_primary_account": {
"type": "boolean"
},
"pickup_type": {
"enum": [
"dailyPickup",
"occasionalPickup",
"customerCounter"
],
"type": "string"
},
"use_carbon_neutral_shipping_program": {
"type": "boolean"
},
"use_ground_freight_pricing": {
"type": "boolean"
},
"use_consolidation_services": {
"type": "boolean"
},
"use_order_number_on_mail_innovations_labels": {
"type": "boolean"
},
"mail_innovations_endorsement": {
"enum": [
"none",
"return_service_requested",
"forwarding_service_requested",
"address_service_requested",
"change_service_requested",
"leave_if_no_response"
],
"type": "string"
},
"mail_innovations_cost_center": {
"type": "string"
},
"use_negotiated_rates": {
"type": "boolean"
},
"account_postal_code": {
"type": "string"
},
"invoice": {
"$ref": "#/definitions/UPSInvoiceDTO"
}
}
},
"UPSInvoiceDTO": {
"type": "object",
"properties": {
"invoice_date": {
"format": "date-time",
"type": "string"
},
"invoice_number": {
"type": "string"
},
"control_id": {
"type": "string"
},
"invoice_amount": {
"format": "double",
"type": "number"
}
}
},
"EbayAccessTokenRequest": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"store_name": {
"type": "string"
},
"access_token": {
"type": "string"
},
"private_application_id": {
"type": "string"
}
}
},
"EndiciaAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"account": {
"type": "string"
},
"passphrase": {
"type": "string"
}
}
},
"WebhookResponse": {
"type": "object",
"properties": {
"webhook_id": {
"type": "string"
},
"url": {
"type": "string"
},
"event": {
"type": "string"
}
}
},
"CreateWebhookRequest": {
"type": "object",
"properties": {
"event": {
"enum": [
"rate",
"track",
"batch",
"storeRefreshComplete"
],
"type": "string"
},
"url": {
"type": "string"
}
}
},
"UpdateWebhookRequest": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
},
"EtsyAccessTokenRequest": {
"type": "object",
"properties": {
"store_name": {
"type": "string"
},
"access_token": {
"type": "string"
},
"access_token_secret": {
"type": "string"
},
"shop_id": {
"format": "int32",
"type": "integer"
},
"private_application_id": {
"type": "string"
}
}
},
"FedExAccountInformationDTO": {
"type": "object",
"properties": {
"account_number": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"city": {
"type": "string"
},
"company": {
"type": "string"
},
"country_code": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"phone": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"state": {
"type": "string"
},
"nickname": {
"type": "string"
},
"agree_to_eula": {
"type": "boolean"
},
"meter_number": {
"type": "string"
}
}
},
"FedExAccountSettingsDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"pickup_type": {
"enum": [
"none",
"regular_pickup",
"request_courier",
"drop_box",
"business_service_center",
"station"
],
"type": "string"
},
"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"
},
"smart_post_endorsement": {
"enum": [
"none",
"return_service_requested",
"forwarding_service_requested",
"address_service_requested",
"change_service_requested",
"leave_if_no_response"
],
"type": "string"
},
"is_primary_account": {
"type": "boolean"
}
}
},
"FirstMileAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"mailer_id": {
"type": "string"
},
"profile_name": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"GlobegisticsAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"ImexAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"Label": {
"type": "object",
"properties": {
"label_id": {
"type": "string"
},
"status": {
"enum": [
"processing",
"completed",
"error",
"voided"
],
"type": "string"
},
"shipment_id": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"shipment_cost": {
"$ref": "#/definitions/MoneyDTO"
},
"insurance_cost": {
"$ref": "#/definitions/MoneyDTO"
},
"tracking_number": {
"type": "string"
},
"is_return_label": {
"type": "boolean"
},
"rma_number": {
"type": "string"
},
"is_international": {
"type": "boolean"
},
"batch_id": {
"type": "string"
},
"carrier_id": {
"type": "string"
},
"service_code": {
"type": "string"
},
"package_code": {
"type": "string"
},
"voided": {
"type": "boolean"
},
"voided_at": {
"format": "date-time",
"type": "string"
},
"label_format": {
"enum": [
"pdf",
"zpl",
"png"
],
"type": "string"
},
"label_layout": {
"type": "string"
},
"trackable": {
"type": "boolean"
},
"carrier_code": {
"type": "string"
},
"tracking_status": {
"enum": [
"unknown",
"in_transit",
"error",
"delivered"
],
"type": "string"
},
"label_download": {
"$ref": "#/definitions/LinkDTO"
},
"form_download": {
"$ref": "#/definitions/LinkDTO"
},
"insurance_claim": {
"$ref": "#/definitions/LinkDTO"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/LabelPackage"
}
}
}
},
"LabelPackage": {
"type": "object",
"properties": {
"package_code": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insured_value": {
"$ref": "#/definitions/MoneyDTO"
},
"tracking_number": {
"type": "string"
},
"label_messages": {
"$ref": "#/definitions/LabelMessages"
}
}
},
"Weight": {
"type": "object",
"properties": {
"value": {
"format": "double",
"type": "number"
},
"unit": {
"enum": [
"pound",
"ounce",
"gram",
"kilogram"
],
"type": "string"
}
}
},
"LabelMessages": {
"type": "object",
"properties": {
"reference1": {
"type": "string"
},
"reference2": {
"type": "string"
},
"reference3": {
"type": "string"
}
}
},
"ListLabelResponse": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/Label"
}
},
"total": {
"format": "int64",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"pages": {
"format": "int32",
"type": "integer"
},
"links": {
"$ref": "#/definitions/PaginationLinkDTO"
}
}
},
"PurchaseLabelRequest": {
"type": "object",
"properties": {
"shipment": {
"$ref": "#/definitions/Shipment"
},
"is_return_label": {
"type": "boolean"
},
"rma_number": {
"type": "string"
},
"test_label": {
"type": "boolean"
},
"validate_address": {
"enum": [
"noValidation",
"validateOnly",
"validateAndClean"
],
"type": "string"
},
"label_layout": {
"type": "string"
},
"label_format": {
"enum": [
"pdf",
"zpl",
"png"
],
"type": "string"
}
}
},
"Shipment": {
"type": "object",
"properties": {
"shipment_id": {
"type": "string"
},
"carrier_id": {
"type": "string"
},
"service_code": {
"type": "string"
},
"external_shipment_id": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"modified_at": {
"format": "date-time",
"type": "string"
},
"shipment_status": {
"enum": [
"pending",
"processing",
"label_purchased",
"cancelled"
],
"type": "string"
},
"ship_to": {
"$ref": "#/definitions/AddressDTO"
},
"ship_from": {
"$ref": "#/definitions/AddressDTO"
},
"warehouse_id": {
"type": "string"
},
"return_to": {
"$ref": "#/definitions/AddressDTO"
},
"confirmation": {
"enum": [
"none",
"delivery",
"signature",
"adult_signature",
"direct_signature"
],
"type": "string"
},
"customs": {
"$ref": "#/definitions/InternationalOptions"
},
"advanced_options": {
"$ref": "#/definitions/AdvancedOptions"
},
"insurance_provider": {
"enum": [
"none",
"shipsurance",
"carrier"
],
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/TagResponse"
}
},
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentPackage"
}
},
"total_weight": {
"$ref": "#/definitions/Weight",
"readOnly": true
}
}
},
"InternationalOptions": {
"type": "object",
"properties": {
"contents": {
"enum": [
"merchandise",
"documents",
"gift",
"returned_goods",
"sample"
],
"type": "string"
},
"customs_items": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomsItem"
}
},
"non_delivery": {
"enum": [
"return_to_sender",
"treat_as_abandoned"
],
"type": "string"
}
}
},
"AdvancedOptions": {
"type": "object",
"properties": {
"bill_to_account": {
"type": "string"
},
"bill_to_country_code": {
"type": "string"
},
"bill_to_party": {
"enum": [
"recipient",
"third_party"
],
"type": "string"
},
"bill_to_postal_code": {
"type": "string"
},
"contains_alcohol": {
"type": "boolean"
},
"delivered_duty_paid": {
"type": "boolean"
},
"non_machinable": {
"type": "boolean"
},
"saturday_delivery": {
"type": "boolean"
},
"use_ups_ground_freight_pricing": {
"type": "boolean"
},
"freight_class": {
"type": "string"
},
"custom_field1": {
"type": "string"
},
"custom_field2": {
"type": "string"
},
"custom_field3": {
"type": "string"
}
}
},
"TagResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"ShipmentPackage": {
"type": "object",
"properties": {
"package_code": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insured_value": {
"$ref": "#/definitions/MoneyDTO"
},
"label_messages": {
"$ref": "#/definitions/LabelMessages"
}
}
},
"CustomsItem": {
"type": "object",
"properties": {
"customs_item_id": {
"type": "string"
},
"description": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"value": {
"format": "double",
"type": "number"
},
"harmonized_tariff_code": {
"type": "string"
},
"country_of_origin": {
"type": "string"
}
}
},
"PurchaseLabelWithoutShipmentRequest": {
"type": "object",
"properties": {
"test_label": {
"type": "boolean"
},
"validate_address": {
"enum": [
"noValidation",
"validateOnly",
"validateAndClean"
],
"type": "string"
},
"label_layout": {
"type": "string"
},
"label_format": {
"enum": [
"pdf",
"zpl",
"png"
],
"type": "string"
}
}
},
"VoidLabelResponse": {
"type": "object",
"properties": {
"approved": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
},
"TrackingInformation": {
"type": "object",
"properties": {
"tracking_number": {
"type": "string"
},
"status_code": {
"type": "string"
},
"status_description": {
"type": "string"
},
"carrier_status_code": {
"type": "string"
},
"carrier_status_description": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"estimated_delivery_date": {
"format": "date-time",
"type": "string"
},
"actual_delivery_date": {
"format": "date-time",
"type": "string"
},
"exception_description": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"$ref": "#/definitions/track_event"
}
}
}
},
"track_event": {
"type": "object",
"properties": {
"occurred_at": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"city_locality": {
"type": "string"
},
"state_province": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"country_code": {
"type": "string"
},
"company_name": {
"type": "string"
},
"signer": {
"type": "string"
}
}
},
"MagentoAccountInformationRequest": {
"type": "object",
"properties": {
"store_name": {
"type": "string"
},
"store_url": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"settings": {
"$ref": "#/definitions/MagentoAccountSettingsRequest"
}
}
},
"MagentoAccountSettingsRequest": {
"type": "object",
"properties": {
"unpaid_status": {
"type": "array",
"items": {
"type": "string"
}
},
"paid_status": {
"type": "array",
"items": {
"type": "string"
}
},
"shipped_status": {
"type": "array",
"items": {
"type": "string"
}
},
"cancelled_status": {
"type": "array",
"items": {
"type": "string"
}
},
"hold_status": {
"type": "array",
"items": {
"type": "string"
}
},
"warehouse_location": {
"type": "array",
"items": {
"type": "string"
}
},
"capture_payment": {
"enum": [
"when_order_is_shipped",
"when_order_is_placed"
],
"type": "string"
}
}
},
"CreateManifestRequest": {
"type": "object",
"properties": {
"carrier_id": {
"type": "string"
},
"excluded_label_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"warehouse_id": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
}
}
},
"ManifestResponse": {
"type": "object",
"properties": {
"manifest_id": {
"type": "string"
},
"form_id": {
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"shipments": {
"format": "int32",
"type": "integer"
},
"warehouse_id": {
"type": "string"
},
"submission_id": {
"type": "string"
},
"carrier_id": {
"type": "string"
},
"manifest_download": {
"$ref": "#/definitions/LinkDTO"
}
}
},
"ListManifestsRequest": {
"type": "object",
"properties": {
"warehouse_id": {
"type": "string"
},
"ship_date_start": {
"format": "date-time",
"type": "string"
},
"ship_date_end": {
"format": "date-time",
"type": "string"
},
"created_at_start": {
"format": "date-time",
"type": "string"
},
"created_at_end": {
"format": "date-time",
"type": "string"
},
"carrier_id": {
"type": "string"
},
"page": {
"format": "int32",
"type": "integer"
},
"page_size": {
"format": "int32",
"type": "integer"
}
}
},
"ListManifestsResponse": {
"type": "object",
"properties": {
"manifests": {
"type": "array",
"items": {
"$ref": "#/definitions/ManifestResponse"
}
},
"total": {
"format": "int64",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"pages": {
"format": "int32",
"type": "integer"
},
"links": {
"$ref": "#/definitions/PaginationLinkDTO"
}
}
},
"NewgisticsAccountInformationDTO": {
"type": "object",
"properties": {
"merchant_id": {
"format": "int32",
"type": "integer"
},
"mailer_id": {
"format": "int32",
"type": "integer"
},
"induction_site": {
"type": "string"
},
"nickname": {
"type": "string"
}
}
},
"NewgisticsAccountSettingsDTO": {
"type": "object",
"properties": {
"include_barcode_with_order_number": {
"type": "boolean"
},
"receive_email_on_manifest_processing": {
"type": "boolean"
}
}
},
"OnTracAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"account_number": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"PackagesListResponse": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/Package"
}
}
}
},
"RateShipmentRequest": {
"type": "object",
"properties": {
"shipment_id": {
"type": "string"
},
"shipment": {
"$ref": "#/definitions/AddressValidatingShipment"
},
"rate_options": {
"$ref": "#/definitions/RateRequest"
}
}
},
"AddressValidatingShipment": {
"type": "object",
"properties": {
"validate_address": {
"enum": [
"noValidation",
"validateOnly",
"validateAndClean"
],
"type": "string"
},
"shipment_id": {
"type": "string"
},
"carrier_id": {
"type": "string"
},
"service_code": {
"type": "string"
},
"external_shipment_id": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"modified_at": {
"format": "date-time",
"type": "string"
},
"shipment_status": {
"enum": [
"pending",
"processing",
"label_purchased",
"cancelled"
],
"type": "string"
},
"ship_to": {
"$ref": "#/definitions/AddressDTO"
},
"ship_from": {
"$ref": "#/definitions/AddressDTO"
},
"warehouse_id": {
"type": "string"
},
"return_to": {
"$ref": "#/definitions/AddressDTO"
},
"confirmation": {
"enum": [
"none",
"delivery",
"signature",
"adult_signature",
"direct_signature"
],
"type": "string"
},
"customs": {
"$ref": "#/definitions/InternationalOptions"
},
"advanced_options": {
"$ref": "#/definitions/AdvancedOptions"
},
"insurance_provider": {
"enum": [
"none",
"shipsurance",
"carrier"
],
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/TagResponse"
}
},
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentPackage"
}
},
"total_weight": {
"$ref": "#/definitions/Weight",
"readOnly": true
}
}
},
"RateRequest": {
"type": "object",
"properties": {
"carrier_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RateShipmentResponse": {
"type": "object",
"properties": {
"rate_response": {
"$ref": "#/definitions/RateResponse"
},
"shipment_id": {
"type": "string"
},
"carrier_id": {
"type": "string"
},
"service_code": {
"type": "string"
},
"external_shipment_id": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"modified_at": {
"format": "date-time",
"type": "string"
},
"shipment_status": {
"enum": [
"pending",
"processing",
"label_purchased",
"cancelled"
],
"type": "string"
},
"ship_to": {
"$ref": "#/definitions/AddressDTO"
},
"ship_from": {
"$ref": "#/definitions/AddressDTO"
},
"warehouse_id": {
"type": "string"
},
"return_to": {
"$ref": "#/definitions/AddressDTO"
},
"confirmation": {
"enum": [
"none",
"delivery",
"signature",
"adult_signature",
"direct_signature"
],
"type": "string"
},
"customs": {
"$ref": "#/definitions/InternationalOptions"
},
"advanced_options": {
"$ref": "#/definitions/AdvancedOptions"
},
"insurance_provider": {
"enum": [
"none",
"shipsurance",
"carrier"
],
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/TagResponse"
}
},
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentPackage"
}
},
"total_weight": {
"$ref": "#/definitions/Weight",
"readOnly": true
}
}
},
"RateResponse": {
"type": "object",
"properties": {
"rates": {
"type": "array",
"items": {
"$ref": "#/definitions/Rate"
}
},
"invalid_rates": {
"type": "array",
"items": {
"$ref": "#/definitions/Rate"
}
},
"rate_request_id": {
"type": "string"
},
"shipment_id": {
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"status": {
"enum": [
"working",
"completed",
"partial",
"error"
],
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/ProviderError"
}
}
}
},
"Rate": {
"type": "object",
"properties": {
"rate_id": {
"type": "string"
},
"rate_type": {
"enum": [
"check",
"shipment"
],
"type": "string"
},
"carrier_id": {
"type": "string"
},
"shipping_amount": {
"$ref": "#/definitions/MoneyDTO"
},
"insurance_amount": {
"$ref": "#/definitions/MoneyDTO"
},
"confirmation_amount": {
"$ref": "#/definitions/MoneyDTO"
},
"other_amount": {
"$ref": "#/definitions/MoneyDTO"
},
"zone": {
"format": "int32",
"type": "integer"
},
"package_type": {
"type": "string"
},
"delivery_days": {
"format": "int32",
"type": "integer"
},
"guaranteed_service": {
"type": "boolean"
},
"estimated_delivery_date": {
"format": "date-time",
"type": "string"
},
"carrier_delivery_days": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"negotiated_rate": {
"type": "boolean"
},
"service_type": {
"type": "string"
},
"service_code": {
"type": "string"
},
"trackable": {
"type": "boolean"
},
"carrier_code": {
"type": "string"
},
"carrier_nickname": {
"type": "string"
},
"carrier_friendly_name": {
"type": "string"
},
"validation_status": {
"enum": [
"valid",
"invalid",
"has_warnings",
"unknown"
],
"type": "string"
},
"warning_messages": {
"type": "array",
"items": {
"type": "string"
}
},
"error_messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProviderError": {
"type": "object",
"properties": {
"carrier_id": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"RateShipmentsRequest": {
"type": "object",
"properties": {
"shipment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"rate_options": {
"$ref": "#/definitions/RateRequest"
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/definitions/AddressValidatingShipment"
}
}
}
},
"RateResponseAsync": {
"type": "object",
"properties": {
"rate_request_id": {
"type": "string"
},
"shipment_id": {
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"status": {
"enum": [
"working",
"completed",
"partial",
"error"
],
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/ProviderError"
}
}
}
},
"RateEstimateRequest": {
"type": "object",
"properties": {
"carrier_id": {
"type": "string"
},
"carrier_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"from_country_code": {
"type": "string"
},
"from_postal_code": {
"type": "string"
},
"to_country_code": {
"type": "string"
},
"to_postal_code": {
"type": "string"
},
"to_city_locality": {
"type": "string"
},
"to_state_province": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"confirmation": {
"enum": [
"none",
"delivery",
"signature",
"adult_signature",
"direct_signature"
],
"type": "string"
},
"address_residential_indicator": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
}
}
},
"RrDonnelleyAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"ShipmentResponseErrors": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentResponseError"
}
},
"links": {
"$ref": "#/definitions/PaginationLinkDTO"
}
}
},
"ShipmentResponseError": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"shipment_id": {
"type": "string"
},
"external_shipment_id": {
"type": "string"
}
}
},
"CreateShipmentResponse": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"address_validation": {
"$ref": "#/definitions/AddressValidationResponseDTO"
},
"shipment_id": {
"type": "string"
},
"carrier_id": {
"type": "string"
},
"service_code": {
"type": "string"
},
"external_shipment_id": {
"type": "string"
},
"ship_date": {
"format": "date-time",
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"modified_at": {
"format": "date-time",
"type": "string"
},
"shipment_status": {
"enum": [
"pending",
"processing",
"label_purchased",
"cancelled"
],
"type": "string"
},
"ship_to": {
"$ref": "#/definitions/AddressDTO"
},
"ship_from": {
"$ref": "#/definitions/AddressDTO"
},
"warehouse_id": {
"type": "string"
},
"return_to": {
"$ref": "#/definitions/AddressDTO"
},
"confirmation": {
"enum": [
"none",
"delivery",
"signature",
"adult_signature",
"direct_signature"
],
"type": "string"
},
"customs": {
"$ref": "#/definitions/InternationalOptions"
},
"advanced_options": {
"$ref": "#/definitions/AdvancedOptions"
},
"insurance_provider": {
"enum": [
"none",
"shipsurance",
"carrier"
],
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/TagResponse"
}
},
"packages": {
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentPackage"
}
},
"total_weight": {
"$ref": "#/definitions/Weight",
"readOnly": true
}
}
},
"CreateShipmentsRequest": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/definitions/AddressValidatingShipment"
}
}
},
"example": {
"shipments": [
{
"rateOptions": {
"carrierIds": [
"761",
"764"
]
},
"validateAddress": "validate_only",
"shipTo": {
"name": "Mickey and Minnie Mouse",
"phone": "+1 (714) 781-4565",
"companyName": "The Walt Disney Company",
"addressLine1": "500 South Buena Visa Street",
"cityLocality": "Burbank",
"stateProvince": "CA",
"postalCode": "91521",
"countryCode": "US",
"addressResidentialIndicator": "no"
},
"warehouseId": "se-123",
"confirmation": "none",
"customs": {
"contents": "gift",
"customsItems": [],
"nonDelivery": "return_to_sender"
},
"advancedOptions": {
"billToAccount": "billingAccount",
"billToCountryCode": "US",
"billToParty": "recipient",
"billToPostalCode": "12345",
"containsAlcohol": true,
"deliveredDutyPaid": false,
"nonMachinable": true,
"saturdayDelivery": true,
"useUPSGroundFreightPricing": false,
"freightClass": "50"
},
"insuranceProvider": "shipsurance",
"packages": [
{
"weight": {
"value": 1.0,
"unit": "ounce"
},
"dimensions": {
"unit": "inch",
"length": 1.0,
"width": 2.0,
"height": 3.3
},
"insuredValue": {
"currency": "usd",
"amount": 3.0
},
"labelMessages": {}
}
],
"totalWeight": {
"value": 1.0,
"unit": "ounce"
}
}
]
}
},
"CreateShipmentsResponse": {
"type": "object",
"properties": {
"has_errors": {
"type": "boolean"
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/definitions/CreateShipmentResponse"
}
}
}
},
"ListShipmentResponse": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/definitions/Shipment"
}
},
"total": {
"format": "int64",
"type": "integer"
},
"page": {
"format": "int32",
"type": "integer"
},
"pages": {
"format": "int32",
"type": "integer"
},
"links": {
"$ref": "#/definitions/PaginationLinkDTO"
}
}
},
"ShipmentAddTagResponse": {
"type": "object",
"properties": {
"shipment_id": {
"type": "string"
},
"tag": {
"$ref": "#/definitions/TagResponse"
}
}
},
"ShopifyAccessTokenRequest": {
"type": "object",
"properties": {
"store_name": {
"type": "string"
},
"store_url": {
"type": "string"
},
"access_token": {
"type": "string"
},
"private_application_id": {
"type": "string"
}
}
},
"StampsAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"StampsAccountUrlsRequest": {
"type": "object",
"properties": {
"url_types": {
"type": "array",
"items": {
"enum": [
"accountSettings",
"reportBalances",
"manifestForm",
"paymentMethods"
],
"type": "string"
}
}
}
},
"StampsAccountUrlsResponse": {
"type": "object",
"properties": {
"urls": {
"type": "array",
"items": {
"$ref": "#/definitions/StampsAccountUrlResponse"
}
}
}
},
"StampsAccountUrlResponse": {
"type": "object",
"properties": {
"url_type": {
"enum": [
"accountSettings",
"reportBalances",
"manifestForm",
"paymentMethods"
],
"type": "string"
},
"url": {
"type": "string"
}
}
},
"ListTagResponse": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/TagResponse"
}
}
}
},
"UPSAccountInformationDTO": {
"type": "object",
"properties": {
"nickname": {
"type": "string"
},
"account_number": {
"type": "string"
},
"account_country_code": {
"type": "string"
},
"account_postal_code": {
"type": "string"
},
"title": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"company": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"country_code": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"invoice": {
"$ref": "#/definitions/UPSInvoiceDTO"
},
"agree_to_technology_agreement": {
"type": "boolean"
}
}
},
"WarehouseDTO": {
"type": "object",
"properties": {
"warehouse_id": {
"type": "string"
},
"name": {
"type": "string"
},
"created_at": {
"format": "date-time",
"type": "string"
},
"origin_address": {
"$ref": "#/definitions/AddressDTO"
},
"return_address": {
"$ref": "#/definitions/AddressDTO"
}
}
},
"WarehouseRequest": {
"type": "object",
"properties": {
"warehouse_id": {
"type": "string"
},
"name": {
"type": "string"
},
"origin_address": {
"$ref": "#/definitions/AddressDTO"
},
"return_address": {
"$ref": "#/definitions/AddressDTO"
}
},
"example": {
"name": "Home Garage",
"originAddress": {
"name": "The President",
"phone": "512-485-4282",
"companyName": "ShipStation",
"addressLine1": "3800 N Lamar Blvd #220",
"cityLocality": "Austin",
"stateProvince": "TX",
"postalCode": "78756",
"countryCode": "US",
"addressResidentialIndicator": "no"
},
"returnAddress": {
"name": "Returns Department",
"phone": "512-485-4282",
"companyName": "ShipStation",
"addressLine1": "3800 N Lamar Blvd #220",
"cityLocality": "Austin",
"stateProvince": "TX",
"postalCode": "78756",
"countryCode": "US",
"addressResidentialIndicator": "no"
}
}
},
"WarehouseListDTO": {
"type": "object",
"properties": {
"warehouses": {
"type": "array",
"items": {
"$ref": "#/definitions/WarehouseDTO"
}
}
}
},
"RecognizeAddressRequestDTO": {
"type": "object",
"description": "The only required field is \"text\", which is the unstructured text to be parsed. The client can optionally also provide a ShipEngine Address DTO containing already-known values.\n",
"required": [
"text"
],
"additionalProperties": false,
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "The unstructured text that contains address-related entities"
},
"address": {
"$ref": "#/definitions/AddressDTO"
}
}
},
"RecognizeShipmentRequestDTO": {
"type": "object",
"description": "The only required field is \"text\", which is the unstructured text to be parsed. The client can optionally also provide a ShipEngine Shipment DTO containing already-known values.\n",
"required": [
"text"
],
"additionalProperties": false,
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "The unstructured text that contains address-related entities"
},
"shipment": {
"$ref": "#/definitions/Shipment"
}
}
},
"RecognizedEntity": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"minLength": 1,
"type": "string",
"description": "The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.)",
"maxLength": 100
},
"score": {
"format": "double",
"minimum": 0,
"type": "number",
"description": "A confidence score between zero and one that indicates how certain the API is that this entity is correct",
"maximum": 1
},
"text": {
"minLength": 1,
"type": "string",
"description": "The substring from the original text that was recognized as this entity"
},
"start_index": {
"minimum": 0,
"type": "number",
"description": "The index of the first character of this entity withing the original text",
"format": "integer"
},
"end_index": {
"minimum": 0,
"type": "number",
"description": "The index of the last character of this entity withing the original text",
"format": "integer"
},
"result": {
"type": "object",
"description": "The result object will be different for each entity type. Most entity results will have a \"value\" property, 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 \"dalas\" was recognized as a \"city\" entity, then the value might be normalized to have proper capitalization and correct the misspelling of \"Dallas\". Some entities will have other information in addition to, or instead of a \"value\" property. For example, a \"dimensions\" entity will have separate properties for \"length\", \"width\", \"height\", and \"unit\"."
}
}
}
},
"securityDefinitions": {
"api-key": {
"type": "apiKey",
"description": "API Key Authentication",
"name": "api-key",
"in": "header"
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment