![](\"https://lafasta.sa.com/wp-content/uploads/2021/04/cropped-1.png\")
\n\nLafasta offers developers a wide range of RESTful APIs. For new development, Lafasta strongly encourages the use of our RESTful APIs. A key benefit of REST is that it uses less bandwidth and supports
multiple formats including plain text, XML, HTML, and JSON.
This is Lafasta API v4. This API is for everyone and for the merchants who wants to ship from multiple or unlimited shipping locations and pickup points.
\n* New endpoint will be added here soon.
* For API authentication please follow the same process in API v3 here
* For API v4 lookups (keys and City, Orders status Lists), download them from here (Note that this file is dynamically generated so the data inside is always up to date)
Click the name of the 'Example Request' (SUCCESS) to expand the reset of request/response examples and get an empty request body template.
\nThis API offers two actions, the action can be selected by setting the request header 'lafasta-shipping-action'. Please check the example named 'CALCULATE SHIPPING COST - SUCCESS' for better understanding.
\n'lafasta-shipping-action' header's value list:
\nhttps://c.lafasta.sa.com
Username: test_account_9 Password: 123456789#
Used to create shipping or fulfillment requests and returns an AWB label.
\nRequest body data model description
\n'Party' data type
\n'Address' data type
\n'Contact' data type
\n'Details' data type
\n'Money' data type
\n'Product' data type
\n'Notification' data type
\n'LafastaService' data type
\n","urlObject":{"path":["API","V4","Shipment"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[{"id":"1b9beef8-408d-48bd-9fe1-8ea09f886539","name":"CREATE SHIPMENT - SUCCESS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"APICallerId\": \"{{apicallerid}}\",\r\n \"Reference1\": \"\",\r\n \"Notes\": \"Breakable item inside please take care\",\r\n \"Shipper\":{\r\n \"Address\":{\r\n \"Line1\": \"X apartments, A1 block, apt #14\",\r\n \"Line2\": \"Abu Jafar Al Mansur Street\",\r\n \"Line3\": \"Ashuhada District, Gurnada, 13241\",\r\n \"City\": \"1\",\r\n \"Country\": \"SA\",\r\n \"Longitude\": \"24.7943169\",\r\n \"Latitude\": \"46.7798573\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"Ahmed Mustafa\",\r\n \"NationalId\": \"1234567899\",\r\n \"PhoneNumber\": \"0546281000\",\r\n \"CompanyName\": \"ْX Trades\",\r\n \"CompanyPhoneNumber\": \"0546281222\"\r\n }\r\n },\r\n \"Consignee\":{\r\n \"Address\":{\r\n \"Line1\": \"مبنى 124\",\r\n \"Line2\": \"شارع المنتزه\",\r\n \"Line3\": \"\",\r\n \"City\": \"2\",\r\n \"Country\": \"السعودية\",\r\n \"Longitude\": \"\",\r\n \"Latitude\": \"\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"Mohammed Mohammed\",\r\n \"NationalId\": \"\",\r\n \"PhoneNumber\": \"0541581257\",\r\n \"CompanyName\": \"\",\r\n \"CompanyPhoneNumber\": \"\"\r\n }\r\n },\r\n \"Details\":{\r\n \"ProductType\": \"PRODUCT\",\r\n \"COD\": {\r\n \"Currency\": \"SAR\",\r\n \"Value\": \"299.9\"\r\n },\r\n \"ProductValue\":{\r\n \"Currency\": \"SAR\",\r\n \"Value\": \"150\"\r\n },\r\n \"AdditionalServices\": [ \"PACKAGING\", \"ExpressShippingService\", \"PrintShippingLabelService\", \"ColdTransportation\" ]\r\n },\r\n \"Products\": [\r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseurl}}/API/V4/Shipment"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 05 Oct 2022 01:50:08 GMT"},{"key":"Content-Length","value":"182"}],"cookie":[],"responseTime":null,"body":"{\n \"awb\": 100509570,\n \"reference1\": null,\n \"labelUrl\": \"https://c.lafasta.sa.com/Content/Files/ShippingLabelsCache/53f64fdc-cc9e-4507-84ec-dc5043027955.pdf\",\n \"success\": true,\n \"notifications\": []\n}"},{"id":"25f0d977-9b8e-40b1-92eb-f1dbc8642c6c","name":"CREATE SHIPMENT - ERROR","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"APICallerId\": \"{{apicallerid}}\",\r\n \"Reference1\": \"1006975\",\r\n \"Notes\": \"Breakable item inside please take care\",\r\n \"Shipper\":{\r\n \"Address\":{\r\n \"Line1\": \"X apartments, A1 block, apt #14\",\r\n \"Line2\": \"Abu Jafar Al Mansur Street\",\r\n \"Line3\": \"Ashuhada District, Gurnada, 13241\",\r\n \"City\": \"Riyadh\",\r\n \"Country\": \"SA\",\r\n \"Longitude\": \"24.7943169\",\r\n \"Latitude\": \"46.7798573\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"Ahmed Mustafa\",\r\n \"NationalId\": \"1080506215\",\r\n \"PhoneNumber\": \"0546281000\",\r\n \"CompanyName\": \"ْX Trades\",\r\n \"CompanyPhoneNumber\": \"0546281222\"\r\n }\r\n },\r\n \"Consignee\":{\r\n \"Address\":{\r\n \"Line1\": \"مبنى 124\",\r\n \"Line2\": \"شارع المنتزه\",\r\n \"Line3\": \"\",\r\n \"City\": \"جدة\",\r\n \"Country\": \"السعودية\",\r\n \"Longitude\": \"\",\r\n \"Latitude\": \"\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"محمد عمر\",\r\n \"NationalId\": \"\",\r\n \"PhoneNumber\": \"0541581257\",\r\n \"CompanyName\": \"\",\r\n \"CompanyPhoneNumber\": \"\"\r\n }\r\n },\r\n \"Details\":{\r\n \"ProductType\": \"PRODUCT\",\r\n \"COD\": {\r\n \"Currency\": \"SAR\",\r\n \"Value\": \"299.9\"\r\n },\r\n \"ProductValue\":{\r\n \"Currency\": \"SAR\",\r\n \"Value\": \"150\"\r\n },\r\n \"AdditionalServices\": [ \"PACKAGING\", \"ExpressShippingService\", \"PrintShippingLabelService\", \"ColdTransportation\" ]\r\n },\r\n \"Products\": [\r\n {\r\n \"SKU\": \"iphone-xs-redS\",\r\n \"Quantity\": \"1\"\r\n },\r\n {\r\n \"SKU\": \"iphone-xs-cover-green\",\r\n \"Quantity\": \"1\"\r\n },\r\n {\r\n \"SKU\": \"iphone-xs-cover-green\",\r\n \"Quantity\": \"1\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseurl}}/API/V4/Shipment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUXVpY2tQcm9qZWN0LW1hc3RlclxRdWlja1Byb2plY3RcQVBJXFY0XFNoaXBtZW50?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sun, 25 Sep 2022 17:33:05 GMT"},{"key":"Content-Length","value":"119"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"notifications\": [\n {\n \"code\": \"E032\",\n \"message\": \"Invalid product SKU 'iphone-xs-redS' in Products[0].SKU\"\n }\n ]\n}"},{"id":"a431cd4d-3d07-4329-9f7f-32e1e8b49fa9","name":"EMPTY JSON TEMPLATE","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"APICallerId\": \"\",\r\n \"Reference1\": \"\",\r\n \"Notes\": \"\",\r\n \"Shipper\":{\r\n \"Address\":{\r\n \"Line1\": \"\",\r\n \"Line2\": \"\",\r\n \"Line3\": \"\",\r\n \"City\": \"\",\r\n \"Country\": \"\",\r\n \"Longitude\": \"\",\r\n \"Latitude\": \"\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"\",\r\n \"NationalId\": \"\",\r\n \"PhoneNumber\": \"\",\r\n \"CompanyName\": \"\",\r\n \"CompanyPhoneNumber\": \"\"\r\n }\r\n },\r\n \"Consignee\":{\r\n \"Address\":{\r\n \"Line1\": \"\",\r\n \"Line2\": \"\",\r\n \"Line3\": \"\",\r\n \"City\": \"\",\r\n \"Country\": \"\",\r\n \"Longitude\": \"\",\r\n \"Latitude\": \"\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"\",\r\n \"NationalId\": \"\",\r\n \"PhoneNumber\": \"\",\r\n \"CompanyName\": \"\",\r\n \"CompanyPhoneNumber\": \"\"\r\n }\r\n },\r\n \"Details\":{\r\n \"ProductType\": \"\",\r\n \"COD\": {\r\n \"Currency\": \"\",\r\n \"Value\": \"\"\r\n },\r\n \"ProductValue\":{\r\n \"Currency\": \"\",\r\n \"Value\": \"\"\r\n },\r\n \"AdditionalServices\": []\r\n },\r\n \"Products\": [\r\n {\r\n \"SKU\": \"\",\r\n \"Quantity\": \"\"\r\n }\r\n ]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseurl}}/API/V4/Shipment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUXVpY2tQcm9qZWN0LW1hc3RlclxRdWlja1Byb2plY3RcQVBJXFY0XFNoaXBtZW50?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sun, 25 Sep 2022 17:33:28 GMT"},{"key":"Content-Length","value":"225"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"notifications\": [\n {\n \"code\": \"E026\",\n \"message\": \"Request deserialization error\"\n },\n {\n \"code\": \"E026\",\n \"message\": \"Error converting value {null} to type 'System.Decimal'. Path 'Details.COD.Value', line 45, position 23.\"\n }\n ]\n}"},{"id":"8a423133-0c48-4bcd-859d-be8b03d5c075","name":"CALCULATE SHIPPING COST - SUCCESS","originalRequest":{"method":"POST","header":[{"key":"lafasta-shipping-action","value":"CalcShippingCost","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"APICallerId\": \"{{apicallerid}}\",\r\n \"Reference1\": \"\",\r\n \"Notes\": \"Breakable item inside please take care\",\r\n \"Shipper\":{\r\n \"Address\":{\r\n \"Line1\": \"X apartments, A1 block, apt #14\",\r\n \"Line2\": \"Abu Jafar Al Mansur Street\",\r\n \"Line3\": \"Ashuhada District, Gurnada, 13241\",\r\n \"City\": \"1\",\r\n \"Country\": \"SA\",\r\n \"Longitude\": \"24.7943169\",\r\n \"Latitude\": \"46.7798573\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"Ahmed Mustafa\",\r\n \"NationalId\": \"1234567899\",\r\n \"PhoneNumber\": \"0546281000\",\r\n \"CompanyName\": \"ْX Trades\",\r\n \"CompanyPhoneNumber\": \"0546281222\"\r\n }\r\n },\r\n \"Consignee\":{\r\n \"Address\":{\r\n \"Line1\": \"مبنى 124\",\r\n \"Line2\": \"شارع المنتزه\",\r\n \"Line3\": \"\",\r\n \"City\": \"1\",\r\n \"Country\": \"السعودية\",\r\n \"Longitude\": \"\",\r\n \"Latitude\": \"\"\r\n },\r\n \"Contact\":{\r\n \"Name\": \"Mohammed Mohammed\",\r\n \"NationalId\": \"\",\r\n \"PhoneNumber\": \"0541581257\",\r\n \"CompanyName\": \"\",\r\n \"CompanyPhoneNumber\": \"\"\r\n }\r\n },\r\n \"Details\":{\r\n \"ProductType\": \"PRODUCT\",\r\n \"COD\": {\r\n \"Currency\": \"SAR\",\r\n \"Value\": \"299.9\"\r\n },\r\n \"ProductValue\":{\r\n \"Currency\": \"SAR\",\r\n \"Value\": \"150\"\r\n },\r\n \"AdditionalServices\": [ \"PACKAGING\", \"ExpressShippingService\", \"PrintShippingLabelService\", \"ColdTransportation\" ]\r\n },\r\n \"Products\": [\r\n\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseurl}}/API/V4/Shipment"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUXVpY2tQcm9qZWN0LW1hc3RlclxRdWlja1Byb2plY3RcQVBJXFY0XFNoaXBtZW50?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sun, 29 Jan 2023 10:00:34 GMT"},{"key":"Content-Length","value":"947"}],"cookie":[],"responseTime":null,"body":"{\n \"reference1\": \"\",\n \"totalShippingCost\": {\n \"currency\": \"SAR\",\n \"value\": 48\n },\n \"servicesUsed\": [\n {\n \"id\": 6,\n \"nameAr\": \"التغليف\",\n \"nameEn\": \"Packaging\",\n \"cost\": {\n \"currency\": \"SAR\",\n \"value\": 2\n }\n },\n {\n \"id\": 13,\n \"nameAr\": \"خدمة التوصيل السريع طيَّااااااارة\",\n \"nameEn\": \"Express shipping service\",\n \"cost\": {\n \"currency\": \"SAR\",\n \"value\": 7\n }\n },\n {\n \"id\": 14,\n \"nameAr\": \"خدمة طباعة البوليصة\",\n \"nameEn\": \"Print shipping label service\",\n \"cost\": {\n \"currency\": \"SAR\",\n \"value\": 2\n }\n },\n {\n \"id\": 16,\n \"nameAr\": \"نقل مبرد\",\n \"nameEn\": \"Cold transportation\",\n \"cost\": {\n \"currency\": \"SAR\",\n \"value\": 15\n }\n },\n {\n \"id\": 4,\n \"nameAr\": \"الدفع عند الاستلام داخل تغطية لافاستا\",\n \"nameEn\": null,\n \"cost\": {\n \"currency\": \"SAR\",\n \"value\": 2\n }\n },\n {\n \"id\": 21,\n \"nameAr\": \"خدمة التوصيل\",\n \"nameEn\": \"Shipping within the same city within Lafasta served cities\",\n \"cost\": {\n \"currency\": \"SAR\",\n \"value\": 20\n }\n }\n ],\n \"success\": true,\n \"notifications\": []\n}"}],"_postman_id":"7e18f086-6e14-48d4-9621-0ccf7a8e7058"}]}