--- title: Retrieve a fulfilment for an account slug: docs/demo/retrieve-a-fulfilment-for-an-account description: Learn how to use the curl command to effortlessly make a GET request to any URL, with included headers for accepting and sending JSON data. This comprehensive code example will guide you through the process and help you optimize your web development skill docTags: createdAt: 2022-03-21T20:12:45.000Z --- { "id": "nz4UfCZxCclur7JTU9OoD", "data": { "url": "https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}", "name": "Retrieve a fulfilment for an account", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "accountReference", "type": "string", "description": "Reference for the account to return fulfilments for" }, { "kind": "required", "name": "fulfilmentReference", "type": "string", "description": "Reference for the fulfilment to return" } ], "queryParameters": [], "headerParameters": [ { "kind": "optional", "name": "X-TokenId", "type": "string", "description": "The eSuite Token Id" }, { "kind": "optional", "name": "X-SessionId", "type": "string", "description": "The eSuite Session Id" }, { "kind": "required", "name": "X-Version", "type": "string", "description": "The eSuite Version" }, { "kind": "optional", "name": "Origin", "type": "string", "description": "The eSuite Origin" } ], "bodyDataParameters": [], "formDataParameters": [] }, "responses": [ { "schema": [ { "kind": "optional", "type": { "type": "string", "example": "", "description": "The Fulfilment Type" }, "schema": [ { "kind": "optional", "name": "fulfilmentReference", "type": "string", "example": "", "description": "The Fulfilment reference" }, { "kind": "optional", "name": "dateCreated", "type": "string", "example": "2021-09-21T05:33:17.9791453", "description": "The Fulfilment date created" }, { "kind": "optional", "name": "dateLastUpdated", "type": "string", "example": "2021-09-21T05:33:17.9791453", "description": "The Fulfilment last updated" }, { "kind": "optional", "name": "cartReference", "type": "string", "example": "", "description": "The Fulfilment reference" }, { "kind": "optional", "name": "fulfilmentDate", "type": "string", "example": "2021-09-21T05:33:17.9791453", "description": "The issuing fulfilment date" }, { "kind": "optional", "name": "supplierNotificationDate", "type": "string", "example": "2021-09-21T05:33:17.9791453", "description": "The Supplier Notification date" }, { "kind": "optional", "name": "expectedDeliveryDate", "type": "string", "example": "2021-09-21T05:33:17.9791453", "description": "The Expected delivery date" }, { "kind": "optional", "name": "status", "type": "string", "example": "", "description": "The fulfilment Status" }, { "kind": "optional", "name": "type", "type": "string", "example": "", "description": "The Fulfilment Type" }, { "kind": "optional", "name": "subscriptionReference", "type": "string", "example": "", "description": "SubscriptionReference" }, { "kind": "optional", "name": "paymentInstructionReference", "type": "string", "example": "", "description": "PaymentInstructionReference" }, { "kind": "optional", "name": "addressReference", "type": "string", "example": "", "description": "AddressReference" }, { "kind": "optional", "name": "paymentReference", "type": "string", "example": "", "description": "PaymentReference" }, { "kind": "optional", "name": "fulfilmentItems", "type": "array", "schema": [ { "kind": "optional", "name": "description", "type": "string", "example": "", "description": "Description" }, { "kind": "optional", "name": "quantity", "type": "integer", "example": 0, "description": "Quantity" }, { "kind": "optional", "name": "productReference", "type": "string", "example": "", "description": "Product reference" }, { "kind": "optional", "name": "customFulfilmentLineItemParameters", "type": "object", "schema": [], "example": {}, "description": "Custom fulfilment line item parameters" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.FulfilmentLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.FulfilmentLineItem[]", "description": "FulfilmentItems" }, { "kind": "optional", "name": "customFulfilmentParameters", "type": "object", "schema": [], "example": {}, "description": "A key-value store to hold custom params for the fulfilment" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.Fulfilment", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.Fulfilment", "isExpanded": true, "description": "The dto to transfer Fulfilment data" } ], "isExpanded": true, "statusCode": "200", "description": "Ok", "jsonExample": "{\n \"fulfilmentReference\": \"0010LS7ZF3VE8OAOOP\",\n \"dateCreated\": \"2021-09-21T05:33:18.1353937\",\n \"dateLastUpdated\": \"2021-09-21T05:33:18.1353937\",\n \"cartReference\": \"0010KQB9L0FQHCZOOP\",\n \"fulfilmentDate\": \"2021-09-21T05:33:18.1353937\",\n \"supplierNotificationDate\": \"2021-09-21T05:33:18.1353937\",\n \"expectedDeliveryDate\": \"2021-09-22T05:33:18.1353937\",\n \"status\": \"Pending\",\n \"type\": \"Physical\",\n \"subscriptionReference\": \"0010SPG7K4O2A5UOOP\",\n \"paymentInstructionReference\": \"0010JP6UISY1ZR0OOP\",\n \"addressReference\": \"0010DPG7K4O2A5UOOP\",\n \"paymentReference\": \"0010OFA69SIHZW8OOP\",\n \"fulfilmentItems\": [\n {\n \"description\": \"Fulfilment line item description.\",\n \"quantity\": 5,\n \"productReference\": \"0010B6G7K4O2A5UOOP\",\n \"customFulfilmentLineItemParameters\": {\n \"ParameterName\": \"Value\"\n }\n }\n ],\n \"customFulfilmentParameters\": {\n \"ParameterName\": \"Value\"\n }\n}" }, { "isExpanded": true, "statusCode": "401", "description": "• API Authentication Failure: Invalid Authentication Type/Credentials Provided", "jsonExample": "" }, { "isExpanded": true, "statusCode": "404", "description": "• Account cannot be found\r\n
• fulfilment cannot be found", "jsonExample": "" } ], "contentType": "application/json", "description": "This endpoint will allow the retrieval of a fulfilment that has been generated for a specific account on the eSuite platform.", "examples": { "languages": [ { "id": "nu0xM_t2uDBXkti0oOyJs", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference} \\\n --header 'accept: application/json' \\\n --header 'x-version: string'" }, { "id": "3q-cq9gRq_KWKRUHttnZJ", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-version\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "cVIgJvh6Czz17Qe9Xy-0N", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}\")\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-version\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "3-TApdnC1PXsiZLSN_apv", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments/{fulfilmentReference}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-version': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "nu0xM_t2uDBXkti0oOyJs" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "{\n \"fulfilmentReference\": \"0010LS7ZF3VE8OAOOP\",\n \"dateCreated\": \"2021-09-21T05:33:18.1353937\",\n \"dateLastUpdated\": \"2021-09-21T05:33:18.1353937\",\n \"cartReference\": \"0010KQB9L0FQHCZOOP\",\n \"fulfilmentDate\": \"2021-09-21T05:33:18.1353937\",\n \"supplierNotificationDate\": \"2021-09-21T05:33:18.1353937\",\n \"expectedDeliveryDate\": \"2021-09-22T05:33:18.1353937\",\n \"status\": \"Pending\",\n \"type\": \"Physical\",\n \"subscriptionReference\": \"0010SPG7K4O2A5UOOP\",\n \"paymentInstructionReference\": \"0010JP6UISY1ZR0OOP\",\n \"addressReference\": \"0010DPG7K4O2A5UOOP\",\n \"paymentReference\": \"0010OFA69SIHZW8OOP\",\n \"fulfilmentItems\": [\n {\n \"description\": \"Fulfilment line item description.\",\n \"quantity\": 5,\n \"productReference\": \"0010B6G7K4O2A5UOOP\",\n \"customFulfilmentLineItemParameters\": {\n \"ParameterName\": \"Value\"\n }\n }\n ],\n \"customFulfilmentParameters\": {\n \"ParameterName\": \"Value\"\n }\n}" }, { "id": "response-1-401", "language": "401", "code": "// • API Authentication Failure: Invalid Authentication Type/Credentials Provided\n" }, { "id": "response-2-404", "language": "404", "code": "// • Account cannot be found\r\n • fulfilment cannot be found\n" } ], "selectedLanguageId": "response-0-200" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }