--- title: Retrieve all fulfilments for an account slug: docs/demo/retrieve-all-fulfilments-for-an-account description: Learn how to make a successful GET request to a specific API endpoint using the curl command with this helpful code example. Discover the essential headers needed to handle and exchange JSON data effectively. Boost your API integration skills today! docTags: createdAt: 2022-03-21T20:12:45.000Z --- { "id": "8lXl7Q-EJim807ynQ57Mv", "data": { "url": "https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments", "name": "Retrieve all fulfilments for an account", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "accountReference", "type": "string", "description": "Reference for the account to return fulfilments for" } ], "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": "array", "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 {\n \"fulfilmentReference\": \"0010L2OAM759Z9I9O2\",\n \"dateCreated\": \"2021-09-21T05:33:18.3072745\",\n \"dateLastUpdated\": \"2021-09-21T05:33:18.3072745\",\n \"cartReference\": \"0010KMO46Q7K53F561\",\n \"fulfilmentDate\": \"2021-09-21T05:33:18.3072745\",\n \"supplierNotificationDate\": \"2021-09-21T05:33:18.3072745\",\n \"expectedDeliveryDate\": \"2021-09-21T05:33:18.3072745\",\n \"status\": \"Pending\",\n \"type\": \"Physical\",\n \"subscriptionReference\": \"0010SIRJOBXCFK5VC2\",\n \"paymentInstructionReference\": \"0010OFF17RELDSL6Y0\",\n \"addressReference\": \"0010SIRFRGXCFK5VC7\",\n \"paymentReference\": \"0010BIRJOBCXEK5VC2\",\n \"fulfilmentItems\": [\n {\n \"description\": \"Fulfilment line item description.\",\n \"quantity\": 5,\n \"productReference\": \"0010B8KMGPVNXHJ9S3\",\n \"customFulfilmentLineItemParameters\": {\n \"ParameterName\": \"Value\"\n }\n }\n ],\n \"customFulfilmentParameters\": {\n \"ParameterName\": \"Value\"\n }\n }\n]" }, { "schema": [ { "kind": "optional", "type": "array", "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": "204", "description": "No Content", "jsonExample": "" }, { "isExpanded": true, "statusCode": "401", "description": "• API Authentication Failure: Invalid Authentication Type/Credentials Provided", "jsonExample": "" }, { "isExpanded": true, "statusCode": "404", "description": "• Account cannot be found", "jsonExample": "" } ], "contentType": "application/json", "description": "This endpoint will allow the retrieval of all fulfilments that have been generated for a specific account on the eSuite platform.", "examples": { "languages": [ { "id": "zx2N1YX5Q5SYhEhSEXcA3", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments \\\n --header 'accept: application/json' \\\n --header 'x-version: string'" }, { "id": "bWXCfyo9m2CDOcChZbCO3", "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\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "q3a4IveWfGka42wQNQYd4", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments\")\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": "g9fHmhR6ca6SgK9vPbcMh", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/accounts/{accountReference}/fulfilments\"\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": "zx2N1YX5Q5SYhEhSEXcA3" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "[\n {\n \"fulfilmentReference\": \"0010L2OAM759Z9I9O2\",\n \"dateCreated\": \"2021-09-21T05:33:18.3072745\",\n \"dateLastUpdated\": \"2021-09-21T05:33:18.3072745\",\n \"cartReference\": \"0010KMO46Q7K53F561\",\n \"fulfilmentDate\": \"2021-09-21T05:33:18.3072745\",\n \"supplierNotificationDate\": \"2021-09-21T05:33:18.3072745\",\n \"expectedDeliveryDate\": \"2021-09-21T05:33:18.3072745\",\n \"status\": \"Pending\",\n \"type\": \"Physical\",\n \"subscriptionReference\": \"0010SIRJOBXCFK5VC2\",\n \"paymentInstructionReference\": \"0010OFF17RELDSL6Y0\",\n \"addressReference\": \"0010SIRFRGXCFK5VC7\",\n \"paymentReference\": \"0010BIRJOBCXEK5VC2\",\n \"fulfilmentItems\": [\n {\n \"description\": \"Fulfilment line item description.\",\n \"quantity\": 5,\n \"productReference\": \"0010B8KMGPVNXHJ9S3\",\n \"customFulfilmentLineItemParameters\": {\n \"ParameterName\": \"Value\"\n }\n }\n ],\n \"customFulfilmentParameters\": {\n \"ParameterName\": \"Value\"\n }\n }\n]" }, { "id": "response-1-204", "language": "204", "code": "// No Content\n[\n {\n \"fulfilmentReference\": \"\",\n \"dateCreated\": \"2021-09-21T05:33:17.9791453\",\n \"dateLastUpdated\": \"2021-09-21T05:33:17.9791453\",\n \"cartReference\": \"\",\n \"fulfilmentDate\": \"2021-09-21T05:33:17.9791453\",\n \"supplierNotificationDate\": \"2021-09-21T05:33:17.9791453\",\n \"expectedDeliveryDate\": \"2021-09-21T05:33:17.9791453\",\n \"status\": \"\",\n \"type\": \"\",\n \"subscriptionReference\": \"\",\n \"paymentInstructionReference\": \"\",\n \"addressReference\": \"\",\n \"paymentReference\": \"\",\n \"fulfilmentItems\": [\n {\n \"description\": \"\",\n \"quantity\": \"\",\n \"productReference\": \"\",\n \"customFulfilmentLineItemParameters\": {}\n }\n ],\n \"customFulfilmentParameters\": {}\n }\n]" }, { "id": "response-2-401", "language": "401", "code": "// • API Authentication Failure: Invalid Authentication Type/Credentials Provided\n" }, { "id": "response-3-404", "language": "404", "code": "// • Account cannot be found\n" } ], "selectedLanguageId": "response-0-200" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }