Shipping Query URL

After the user selects their address in the Akifast, a request is sent to the merchant to inquire about the shipping options that will deliver to that address. The URL to which the request will be sent is determined by the query_shipping_option_url parameter sent when the payment session is created by the merchant.

Akifast sends a POST request to the merchant's specified query_shipping_option_url with the parameters listed below.

Query Parameters

Parameter	Type	Description
order_id	string	Order number on the merchant side.
session_token	string	Payment session key obtained by the merchant.
basket_id	string	Basket identifier.
shipping_address.name	string	Name of the address holder.
shipping_address.surname	string	Surname of the address holder.
shipping_address.phone_number	string	Phone number of the address holder.
shipping_address.postal_code	string	Postal code of the address.
shipping_address.notes	string	Additional notes about the address.
shipping_address.company_name	string	Company name if the address is a corporate one.
shipping_address.address_title	string	Description of the address.
shipping_address.tax_no	string	Tax number for a corporate address.
shipping_address.tax_office	string	Tax office for a corporate address.
shipping_address.is_default	boolean	Indicator for the default address.
shipping_address.line	string	Address information.
shipping_address.address_type	string	Address type (CUSTOMER, RETAIL_STORE).
shipping_address.country.name	string	Country name.
shipping_address.country.code	string	Country code.
shipping_address.city.name	string	City name.
shipping_address.city.code	string	City code.
shipping_address.town.name	string	Town name.
shipping_address.town.code	string	Town code.
shipping_address.district.name	string	District name.
shipping_address.status	string	Status of the address.
shipping_address.hash_data	string	Unique hash code for the address.
billing_address.name	string	Name of the billing address.
billing_address.surname	string	Surname of the billing address.
billing_address.phone_number	string	Phone number of the billing address.
billing_address.postal_code	string	Postal code of the billing address.
billing_address.notes	string	Additional notes about the billing address.
billing_address.company_name	string	Company name if the billing address is a corporate one.
billing_address.address_title	string	Description of the billing address.
billing_address.tax_no	string	Tax number for a corporate billing address.
billing_address.tax_office	string	Tax office for a corporate billing address.
billing_address.is_default	boolean	Indicator for the default billing address.
billing_address.line	string	Billing address information.
billing_address.address_type	string	Billing address type (CUSTOMER, RETAIL_STORE).
billing_address.country.name	string	Billing country name.
billing_address.country.code	string	Billing country code.
billing_address.city.name	string	Billing city name.
billing_address.city.code	string	Billing city code.
billing_address.town.name	string	Billing town name.
billing_address.town.code	string	Billing town code.
billing_address.district.name	string	Billing district name.
billing_address.status	string	Status of the billing address.
billing_address.hash_data	string	Unique hash code for the billing address.
conversation_id	string	Private conversation identifier.

Example Request

{
   "order_id":"8mMk171XX44919465",
   "session_token":"3a78d9f7-d8af-40XX-ae70-1daacaf802a9",
   "basket_id":"17108XX919465",
   "shipping_address":{
      "name":"t2",
      "surname":"c2",
      "phone_number":"+905XXXXXXXXX",
      "postal_code":"",
      "notes":null,
      "company_name":"",
      "address_title":"sample title",
      "tax_no":"",
      "tax_office":"",
      "is_default":true,
      "line":"test",
      "address_type":"CUSTOMER",
      "country":{
         "name":"Türkiye",
         "code":"TR"
      },
      "city":{
         "name":"İSTANBUL",
         "code":"ISTANBUL"
      },
      "town":{
         "name":"BAKIRKÖY",
         "code":"ISTANBUL_BAKIRKOY"
      },
      "district":{
         "name":"OSMANİYE MAH",
         "code":"89069292"
      },
      "status":"ACTIVE",
      "hash_data":"ACC2D0D134ABDC210C55AB6BC96E5XXB4B7A7CA899131EE182313C94DBA1DC43",
      "phone":{
         "country_phone_code":"+90",
         "national_phone_number":"5XXXXXXXXX"
      }
   },
   "billing_address":{
      "name":"t2",
      "surname":"c2",
      "phone_number":"+905XXXXXXXXX",
      "postal_code":"",
      "notes":null,
      "company_name":"",
      "address_title":"sample title",
      "tax_no":"",
      "tax_office":"",
      "is_default":true,
      "line":"test",
      "address_type":"CUSTOMER",
      "country":{
         "name":"Türkiye",
         "code":"TR"
      },
      "city":{
         "name":"İSTANBUL",
         "code":"ISTANBUL"
      },
      "town":{
         "name":"BAKIRKÖY",
         "code":"ISTANBUL_BAKIRKOY"
      },
      "district":{
         "name":"OSMANİYE MAH",
         "code":"89069292"
      },
      "status":"ACTIVE",
      "hash_data":"ACC2D0D134ABDC210C55AB6BC96E5XXB4B7A7CA899131EE182313C94DBA1DC43",
      "phone":{
         "country_phone_code":"+90",
         "national_phone_number":"5XXXXXXXXX"
      }
   },
   "conversation_id":"42XX231"

Response Parameters

Return Value	Type	Description
count	string	Number of shipping options.
shipping_options[0].description	string	Description of the shipping option.
shipping_options[0].logo_url	string	URL of the image representing the shipping company.
shipping_options[0].name	string	Name of the shipping company.
shipping_options[0].key	string	Akinon key of the shipping company.
shipping_options[0].shipping_amount	number	Shipping cost.

Example Response

{
   "count":2,
   "shipping_options":[
      {
         "description":"Hafta içi ve Cumartesi 15:00'e kadar verilen siparişler, aynı gün içinde 23:00'e kadar teslim edilir. 15:00'den sonra, Pazar günleri ve resmi tatil günlerinde verilen siparişler ise takip eden ilk iş günü saat 23:00'e kadar teslim edilir.",
         "logo_url":"https://samplelogourl",
         "name":"Sample Cargo-1",
         "key":"12",
         "shipping_amount":9.9
      },
      {
         "description":"Siparişin 2-4 iş günü içerisinde kargoya verilecektir.",
         "logo_url":"https://samplelogourl",
         "name":"Sample Cargo-2",
         "key":"14",
         "shipping_amount":19.9
      }
   ]
}