",
"description": "Unique identifier for the shipment that needs to be transitioned.",
"format": "uuid"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
},
{
"kind": "required",
"name": "x-upstart-tenant",
"type": "string",
"description": "Tenant identifier associated with the site this call is for."
}
],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "NoChannelPortalAccess",
"name": "NoChannelPortalAccess",
"kind": "optional",
"type": "http",
"description": "This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.
",
"scheme": "bearer"
},
{
"id": "ApiKeyAccess",
"name": "X-Upstart-Api-Key",
"kind": "optional",
"type": "apiKey",
"description": "Api key based authorization.",
"in": "header"
},
{
"id": "SessionIdAccess",
"name": "X-Upstart-Session-Id",
"kind": "optional",
"type": "apiKey",
"description": "Session based authorization. This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.
",
"in": "header"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Success-shipping rates returned.
",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ShipmentAlternativeRatesResponse",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "",
"format": "uuid"
},
{
"name": "shipmentRates",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/OrderShipmentRatesResponse",
"customType": "OrderShipmentRatesResponse[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "",
"format": "uuid"
},
{
"name": "shippingMethodId",
"kind": "required",
"type": "string",
"description": "",
"format": "uuid"
},
{
"name": "shippingMethodName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "shippingMethodTaxCode",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "trackingNumber",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "addressFrom",
"kind": "optional",
"type": "object",
"description": "Standardized format for global addresses.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "street1",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "street2",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "county",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "stateOrRegion",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "country",
"kind": "required",
"type": "string",
"description": "Defaults to US.",
"minLength": 2,
"maxLength": 2
},
{
"name": "postalCode",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "poBox",
"kind": "required",
"type": "boolean",
"description": "",
"default": false
},
{
"name": "name",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Name",
"customType": "Name",
"schema": [
{
"name": "first",
"kind": "required",
"type": "string",
"description": "The first name of the individual being addressed.",
"example": "John"
},
{
"name": "last",
"kind": "required",
"type": "string",
"description": "The last name of the individual being addressed.",
"example": "Smith"
},
{
"name": "middleInitial",
"kind": "optional",
"type": "string",
"description": "The middle initial of the individual being addressed.",
"example": "D."
},
{
"name": "salutation",
"kind": "optional",
"type": "string",
"description": "The salutation of the individual being addressed.",
"example": "Capt."
},
{
"name": "suffix",
"kind": "optional",
"type": "string",
"description": "The optional suffix of the individual being addressed.",
"example": "Sr."
}
]
},
{
"name": "businessName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "phoneNumber",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "locationFromId",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "addressTo",
"kind": "optional",
"type": "object",
"description": "Standardized format for global addresses.",
"modelRef": "#/components/schemas/Address",
"customType": "Address",
"schema": [
{
"name": "street1",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "street2",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "county",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "stateOrRegion",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "country",
"kind": "required",
"type": "string",
"description": "Defaults to US.",
"minLength": 2,
"maxLength": 2
},
{
"name": "postalCode",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "poBox",
"kind": "required",
"type": "boolean",
"description": "",
"default": false
},
{
"name": "name",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Name",
"customType": "Name",
"schema": [
{
"name": "first",
"kind": "required",
"type": "string",
"description": "The first name of the individual being addressed.",
"example": "John"
},
{
"name": "last",
"kind": "required",
"type": "string",
"description": "The last name of the individual being addressed.",
"example": "Smith"
},
{
"name": "middleInitial",
"kind": "optional",
"type": "string",
"description": "The middle initial of the individual being addressed.",
"example": "D."
},
{
"name": "salutation",
"kind": "optional",
"type": "string",
"description": "The salutation of the individual being addressed.",
"example": "Capt."
},
{
"name": "suffix",
"kind": "optional",
"type": "string",
"description": "The optional suffix of the individual being addressed.",
"example": "Sr."
}
]
},
{
"name": "businessName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "phoneNumber",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "locationToId",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "shippingToDistance",
"kind": "optional",
"type": "object",
"description": "This defines a generic distance.",
"modelRef": "#/components/schemas/Distance",
"customType": "Distance",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"description": "The numeric portion of the distance.",
"example": 157.75,
"format": "double"
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "An enumeration of the supported distance measurements.",
"modelRef": "#/components/schemas/DistanceUnits",
"customType": "DistanceUnits",
"schema": []
}
]
},
{
"name": "rateServiceCode",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "rateVariants",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ShippingRate",
"customType": "ShippingRate[]",
"schema": [
{
"name": "rateId",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "carrierId",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "pricing",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ShippingRatePricing",
"customType": "ShippingRatePricing",
"schema": [
{
"name": "shipping",
"kind": "required",
"type": "number",
"description": ""
},
{
"name": "insurance",
"kind": "optional",
"type": "number",
"description": ""
},
{
"name": "confirmation",
"kind": "optional",
"type": "number",
"description": ""
},
{
"name": "other",
"kind": "optional",
"type": "number",
"description": ""
},
{
"name": "fee",
"kind": "optional",
"type": "number",
"description": ""
}
]
},
{
"name": "packageType",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "deliveryDays",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "estimatedDeliveryDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "carrierDeliveryDates",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "shipDate",
"kind": "optional",
"type": "string",
"description": "",
"format": "date-time"
},
{
"name": "serviceType",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "serviceCode",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "carrierCode",
"kind": "required",
"type": "string",
"description": ""
}
]
},
{
"name": "packages",
"kind": "required",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ShippingPackage",
"customType": "ShippingPackage[]",
"schema": [
{
"name": "dimensions",
"kind": "optional",
"type": "object",
"description": "This is a common definition of a dimension.",
"modelRef": "#/components/schemas/Dimensions",
"customType": "Dimensions",
"schema": [
{
"name": "width",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "length",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "height",
"kind": "required",
"type": "number",
"description": "",
"example": 18.5,
"format": "double"
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "",
"enum": [
"cm",
"m",
"in",
"mm"
]
}
]
},
{
"name": "insuredValue",
"kind": "optional",
"type": "number",
"description": ""
},
{
"name": "packageCode",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "weight",
"kind": "required",
"type": "object",
"description": "Defines a common structure for representing weights.",
"modelRef": "#/components/schemas/Weight",
"customType": "Weight",
"schema": [
{
"name": "value",
"kind": "required",
"type": "number",
"description": "",
"format": "double",
"minimum": 0
},
{
"name": "unit",
"kind": "required",
"type": "string",
"description": "Unit of measurement.",
"enum": [
"g",
"kg",
"lb"
]
}
]
},
{
"name": "trackingNumber",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "errors",
"kind": "required",
"type": "array",
"description": "Describes an error that needs to be corrected prior to any state-change in the order.
",
"modelRef": "#/components/schemas/ErrorMessage",
"customType": "ErrorMessage[]",
"schema": [
{
"name": "code",
"kind": "required",
"type": "string",
"description": "A code that represents a specific type of error."
},
{
"name": "detail",
"kind": "optional",
"type": "string",
"description": "A detailed trace of the issue."
},
{
"name": "level",
"kind": "required",
"type": "string",
"description": "Level of the issue.",
"enum": [
"ERROR",
"INFO",
"WARNING"
]
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": "A message indicating what caused the error to be included. THIS IS NOT INTENDED TO BE DISPLAYED TO A USER.\nIf you choose to do so, you are welcome to - but this is mostly intended to allow a developer to diagnose an issue.
"
}
]
}
]
},
{
"name": "errors",
"kind": "required",
"type": "array",
"description": "Describes an error that needs to be corrected prior to any state-change in the order.
",
"modelRef": "#/components/schemas/ErrorMessage",
"customType": "ErrorMessage[]",
"schema": [
{
"name": "code",
"kind": "required",
"type": "string",
"description": "A code that represents a specific type of error."
},
{
"name": "detail",
"kind": "optional",
"type": "string",
"description": "A detailed trace of the issue."
},
{
"name": "level",
"kind": "required",
"type": "string",
"description": "Level of the issue.",
"enum": [
"ERROR",
"INFO",
"WARNING"
]
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": "A message indicating what caused the error to be included. THIS IS NOT INTENDED TO BE DISPLAYED TO A USER.\nIf you choose to do so, you are welcome to - but this is mostly intended to allow a developer to diagnose an issue.
"
}
]
}
],
"modelRef": "#/components/schemas/ShipmentAlternativeRatesResponse",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "The requested resource was not found in the NoChannel system.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "name",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "code",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "required",
"type": "string",
"description": ""
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "kQC_gPhaQhIxj79ApMWKJ",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/order/{orderId}/shipments/{shipmentId}/rates \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'"
},
{
"id": "IcWm9EZMQmxbR9R2Rwe_c",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/order/{orderId}/shipments/{shipmentId}/rates\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "xdAkDOk0bAMS9QpeQE4bm",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/{orderId}/shipments/{shipmentId}/rates\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "DBBZ4OXnGVD9pQXE8175c",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/{orderId}/shipments/{shipmentId}/rates\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "kQC_gPhaQhIxj79ApMWKJ"
},
"results": {
"languages": [
{
"id": "25JEBrnh-27BsOGT2xlc-",
"language": "200",
"code": "// Success-shipping rates returned.\n{\n \"id\": \"\",\n \"shipmentRates\": [\n {\n \"id\": \"\",\n \"shippingMethodId\": \"\",\n \"shippingMethodName\": \"\",\n \"shippingMethodTaxCode\": \"\",\n \"trackingNumber\": \"\",\n \"addressFrom\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateOrRegion\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"poBox\": false,\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\",\n \"middleInitial\": \"D.\",\n \"salutation\": \"Capt.\",\n \"suffix\": \"Sr.\"\n },\n \"businessName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"locationFromId\": \"\",\n \"addressTo\": {\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateOrRegion\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"poBox\": false,\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\",\n \"middleInitial\": \"D.\",\n \"salutation\": \"Capt.\",\n \"suffix\": \"Sr.\"\n },\n \"businessName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"locationToId\": \"\",\n \"shippingToDistance\": {\n \"value\": 157.75,\n \"unit\": \"\"\n },\n \"rateServiceCode\": \"\",\n \"rateVariants\": [\n {\n \"rateId\": \"\",\n \"carrierId\": \"\",\n \"pricing\": {\n \"shipping\": 0,\n \"insurance\": 0,\n \"confirmation\": 0,\n \"other\": 0,\n \"fee\": 0\n },\n \"packageType\": \"\",\n \"deliveryDays\": \"\",\n \"estimatedDeliveryDate\": \"\",\n \"carrierDeliveryDates\": \"\",\n \"shipDate\": \"\",\n \"serviceType\": \"\",\n \"serviceCode\": \"\",\n \"carrierCode\": \"\"\n }\n ],\n \"packages\": [\n {\n \"dimensions\": {\n \"width\": 18.5,\n \"length\": 18.5,\n \"height\": 18.5,\n \"unit\": \"\"\n },\n \"insuredValue\": 0,\n \"packageCode\": \"\",\n \"weight\": {\n \"value\": \"\",\n \"unit\": \"\"\n },\n \"trackingNumber\": \"\"\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"level\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ],\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"level\": \"\",\n \"message\": \"\"\n }\n ]\n}"
},
{
"id": "Xp-FvwMDTP1-glPKZTEHW",
"language": "401",
"code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
},
{
"id": "7m5G9L-56yjD1J7sUTOoE",
"language": "404",
"code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}"
}
],
"selectedLanguageId": "25JEBrnh-27BsOGT2xlc-"
}
},
"children": [
{
"text": ""
}
]
}