--- title: Update Shipment Rate slug: api-documentation/update-shipment-rate docTags: createdAt: 2026-08-27T16:53:32.339Z --- { "id": "f7Kk0deEaZ0Oh9nvKPWR4", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://api.upstartcommerce.com/v1/cart/{customerId}/cart/shipments/{shipmentId}/rate", "servers": [ { "url": "https://api.upstartcommerce.com/v1/cart/{customerId}/cart/shipments/{shipmentId}/rate" } ], "name": "Update Shipment Rate", "description": "This endpoint changes the rate selection on the given shipment to the indicated rate.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "customerId", "type": "string", "description": "Unique identifier representing the \"owner\" of the cart." }, { "kind": "required", "name": "shipmentId", "type": "string", "description": "Unique identifier of the cart shipment.", "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." }, { "kind": "required", "name": "x-upstart-site", "type": "string", "description": "The site identifier." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "string", "description": "The request must provide the service code to update a shipment rate.", "isExpanded": true } ], "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" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "202", "description": "

Success-the shipping rate was updated to the requested rate.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "string", "description": "", "format": "uuid", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "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": "rAAagrnJHbUA_7B8q9noq", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.upstartcommerce.com/v1/cart/{customerId}/cart/shipments/{shipmentId}/rate \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --header 'x-upstart-site: string' \\\n --data '{\"body\":\"string\"}'" }, { "id": "itiVKaAfg03DaRUI96_3d", "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\");\nmyHeaders.append(\"x-upstart-site\", \"string\");\n\nvar raw = JSON.stringify({\n \"body\": \"string\"\n});\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/cart/{customerId}/cart/shipments/{shipmentId}/rate\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "5e4O-kjsInBe14xxLHuJT", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/cart/{customerId}/cart/shipments/{shipmentId}/rate\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest[\"x-upstart-site\"] = \"string\"\nrequest.body = JSON.dump({\n \"body\": \"string\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "g_lujeasgBuEAYjvtsO_a", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/cart/{customerId}/cart/shipments/{shipmentId}/rate\"\n\npayload = json.dumps({\n \"body\": \"string\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string',\n 'x-upstart-site': 'string'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "rAAagrnJHbUA_7B8q9noq" }, "results": { "languages": [ { "id": "teh2H8D09NF1vHrKlowQV", "language": "202", "code": "// Success-the shipping rate was updated to the requested rate.\n\"\"" }, { "id": "bG6Tf63RHmxh5Rur_zG6e", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "LGbAoEEhHwq3qORkBglAS", "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": "QmS-Ikpe3sq5SOJGHXBM6", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "teh2H8D09NF1vHrKlowQV" } }, "children": [ { "text": "" } ] }