--- title: Get Shipping Carrier by ID slug: api-documentation/MggH-get-shipping-carrier-by-id docTags: createdAt: 2026-08-27T17:08:07.245Z --- { "id": "DYSpJ2uTnNAEa4PUdXpZX", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/shipping-carrier/list", "servers": [ { "url": "https://api.upstartcommerce.com/v1/shipping-carrier/list" } ], "name": "Get Shipping Carrier by ID", "description": "

This endpoint returns a set of shipping carriers based on the ids passed in.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "contentType": "application/json", "request": { "pathParameters": [], "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." }, { "kind": "optional", "name": "x-upstart-site", "type": "string", "description": "Unique identifier for the site." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "array", "description": "The request must provide an array of shipping carrier ids to list.", "schema": [], "itemType": "string", "customType": "string[]", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "LoggedIn", "name": "LoggedIn", "kind": "optional", "type": "http", "description": "The presence of this token indicates that the user is a known consumer that has previously logged into the platform.", "scheme": "bearer" }, { "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": "AnonymousAuth", "name": "AnonymousAuth", "kind": "optional", "type": "http", "description": "This is the most basic authentication. The minimum requirement for access is a token representing the user as an anonymous client.", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-shipping carriers returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "ShippingCarrier[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the shipping carrier. This will be assigned unless it is provided.", "example": "usps" }, { "name": "name", "kind": "required", "type": "string", "description": "Carrier name", "example": "USPS" }, { "name": "siteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "trackingUrl", "kind": "optional", "type": "string", "description": "

Tracking URL. If defined, tracking is supported for given carrier. Placeholder for trackingNumber {{trackingNumber}}

", "example": "https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels={{trackingNumber}}" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Account number for carrier." } ], "modelRef": "#/components/schemas/ShippingCarrier", "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 } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "kEtHB4DMru-XOsV7um1g_", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/shipping-carrier/list \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "EXQVTKvENSD7ohUdlodIP", "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: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/shipping-carrier/list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "wpD8_uIOh1qBaQ7BYy4R_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/shipping-carrier/list\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.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": "9daO78BddJVBi5v6n8qfA", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/shipping-carrier/list\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "kEtHB4DMru-XOsV7um1g_" }, "results": { "languages": [ { "id": "UenkFWgMq09RtW4IqSOno", "language": "200", "code": "// Success-shipping carriers returned.\n[\n {\n \"id\": \"usps\",\n \"name\": \"USPS\",\n \"siteIds\": [\n \"\"\n ],\n \"description\": \"\",\n \"trackingUrl\": \"https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels={{trackingNumber}}\",\n \"accountNumber\": \"\"\n }\n]" }, { "id": "J4CbTZnQQSXqSFv4f2AYK", "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}" } ], "selectedLanguageId": "UenkFWgMq09RtW4IqSOno" } }, "children": [ { "text": "" } ] }