--- title: Fetch Order Shipments Processes slug: api-documentation/fetch-order-shipments-processes docTags: createdAt: 2026-08-27T16:57:40.129Z --- { "id": "rDmRW0oP0K-skWwGA0pOF", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.upstartcommerce.com/v1/order/{orderId}/shipments/process", "servers": [ { "url": "https://api.upstartcommerce.com/v1/order/{orderId}/shipments/process" } ], "name": "Fetch Order Shipments Processes", "description": "

This endpoint enables administrators to retrieve processes for a particular order shipments.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "orderId", "type": "string", "description": "The parameterized order id in the URI.", "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-order shipments processes returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "OrderShipmentProcessDef[]", "schema": [ { "name": "shipmentId", "kind": "required", "type": "string", "description": "Unique identifier for the order shipment id.", "format": "uuid" }, { "name": "processStates", "kind": "required", "type": "array", "description": "Definitions for shipment process states.", "modelRef": "#/components/schemas/StateDef", "customType": "StateDef[]", "schema": [ { "name": "state", "kind": "required", "type": "string", "description": "" }, { "name": "transitions", "kind": "required", "type": "array", "description": "Transitions definitions to next states.", "modelRef": "#/components/schemas/StateTransitionDef", "customType": "StateTransitionDef[]", "schema": [ { "name": "toState", "kind": "required", "type": "string", "description": "" }, { "name": "transitionAction", "kind": "optional", "type": "string", "description": "

Action/operation for transition to this state.

" }, { "name": "deprecated", "kind": "optional", "type": "boolean", "description": "Deprecation for state transition." } ] }, { "name": "inStateActions", "kind": "required", "type": "array", "description": "

Actions/operations, which may be executed in this state.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "deprecated", "kind": "optional", "type": "boolean", "description": "Deprecation for state." } ] } ], "modelRef": "#/components/schemas/OrderShipmentProcessDef", "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": "DX21OezziwJhwlL8MtGW6", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/order/{orderId}/shipments/process \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "_Jk4W1mAdRtHghfAK6HuD", "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/process\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "wFIakHQr6RueFGEoRWQTy", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/{orderId}/shipments/process\")\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": "XpeVKJEH8HVS_DhqqT6dr", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/{orderId}/shipments/process\"\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": "DX21OezziwJhwlL8MtGW6" }, "results": { "languages": [ { "id": "jJ4jpCN77a7Rx6D-cjfBM", "language": "200", "code": "// Success-order shipments processes returned.\n[\n {\n \"shipmentId\": \"\",\n \"processStates\": [\n {\n \"state\": \"\",\n \"transitions\": [\n {\n \"toState\": \"\",\n \"transitionAction\": \"\",\n \"deprecated\": false\n }\n ],\n \"inStateActions\": [\n \"\"\n ],\n \"deprecated\": false\n }\n ]\n }\n]" }, { "id": "NZd_tDSN45vSY1JfLV2Yu", "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": "bevQtAPRtZyKsp3ZC4ayX", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "jJ4jpCN77a7Rx6D-cjfBM" } }, "children": [ { "text": "" } ] }