Mağazaya ait kayıtlı kargo şablonlarını yönetmek için kullanılır.
Teslimat Şablonu Listeleme
Belirtilen mağazaya ait kayıtlı tüm teslimat şablonlarını listelemek için kullanılır.
Örnekler
Curl ile istek atmak için bu örnek kullanılabilir.
curl -X GET \ 'https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}?access_token={ACCESS_TOKEN}' \ -H 'cache-control: no-cache'
PHP ile istek atmak için bu örnek kullanılabilir. Örnekte Curl kullanılmaktadır.
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}?access_token={ACCESS_TOKEN}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => array( "cache-control: no-cache" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python ile istek atmak için bu örnek kullanılabilir. Bu örnekte Python'un requests kütüphanesi kullanılır ama http.client gibi kütüphane kullanılabilir
import requests url = "https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}" querystring = {"access_token":"{ACCESS_TOKEN}"} headers = { 'cache-control': "no-cache" } response = requests.request("GET", url, headers=headers, params=querystring) print(response.text)
Node.js ile istek atmak için bu örnek kullanılabilir. Örnekte request kullanılmaktadır.
var request = require('request'); var options = { method: 'GET', url: 'https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}', qs: { access_token: '{ACCESS_TOKEN}' }, headers: { 'cache-control': 'no-cache', }, }; request(options, (error, response, body) => { if (error) throw new Error(error); console.log(body); });
Javascipt ile istek atmak için bu örnek kullanılabilir. Örnekte xhr kullanılmakdır. Not: Bilgi amaçlıdır. Javascipt ile yazılan bu kod'ta Kullanıcı access token'a erişebildiğinden, kullanmanızı önermiyoruz.
var data = null; var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener('readystatechange', function () { if (this.readyState === 4) { console.log(this.responseText); } }); xhr.open('GET', 'https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}?access_token={ACCESS_TOKEN}'); xhr.setRequestHeader('cache-control', 'no-cache'); xhr.send(data);
C Sharp ile istek atmak için bu örnek kullanılabilir. Bu örnekte RestSharp kullanılmaktadır.
var client = new RestClient("https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}?access_token={ACCESS_TOKEN}"); var request = new RestRequest(Method.GET); request.AddHeader("cache-control", "no-cache"); IRestResponse response = client.Execute(request);
Java ile istek atmak için bu örnek kullanılabilir. Örnekte Ok Http kullanılmaktadır.
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}?access_token={ACCESS_TOKEN}") .get() .addHeader("cache-control", "no-cache") .build(); Response response = client.newCall(request).execute();
Go ile istek atmak için bu örnek kullanılabilir. Örnekte net/http kullanılmaktadır.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.allesgo.com/v1.0/shipping-template/store/{STORE_ID}?access_token={ACCESS_TOKEN}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("cache-control", "no-cache") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
API Referansı
Request query strings
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
limit | Limit | Integer | false | 20 | Limit (max: 50). | |
page | Sayfa | Integer | false | 1 | Ürünler sayfa sayısına göre listelenir. | |
ids | Id'ler | ObjectId | false | Mağazaya ait teslimat şablonlarını ID numarasına göre filtreleyebilirsiniz. Birden fazla ID ile arama yapılacaksa aralara virgül koymayı unutmayın. | ||
search | Anahtar Kelime | String | false | Teslimat şablonlarını ismine göre filtreleyebilirsiniz. |
Request URL parameters
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
storeId | Mağaza ID'si | ObjectId | true | Mağaza ID'si |
Sunucudan dönecek cevabın örneği.
{
"data": {
"total": "Integer",
"result": [
{
"id": "ObjectId",
"template_name": "String",
"all_country": "Boolean",
"free_shipping": "Boolean",
"shipping_note": "String",
"shipping_time": "Integer",
"suitable_cities": "Array|undefined",
"use_contractred_company": "Boolean",
"shipping_with_together": "Boolean",
"shipping_companies": "Array",
"return_companies": "Array",
"sender_address": "Address",
"return_address": "Address",
"common_address": "Boolean",
"created_at": "Date"
}
]
}
}
Yeni Teslimat Şablonu Kaydetme
Belirtilen mağaza için yeni bir teslimat şablonu oluşturmak için kullanır.
Örnekler
Curl ile istek atmak için bu örnek kullanılabilir.
curl -X POST \ 'https://api.allesgo.com/v1.0/shipping-template/create/store/{STORE_ID}?access_token={ACCESS_TOKEN}' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{"template_name":"{TEMPLATE_NAME}","free_shipping":"{FREE_SHIPPING}","shipping_note":"{SHIPPING_NOTE}","sender_address":"{SENDER_ADDRESS}","return_address":"{RETURN_ADDRESS}","shipping_time":"{SHIPPING_TIME}","all_country":"{ALL_COUNTRY}","suitable_cities":"{SUITABLE_CITIES}","use_contractred_company":"{USE_CONTRACTED_COMPANY}","common_address":"{COMMON_ADDRESS}","conditional_shipping":"{CONDITIONAL_SHIPPING}","min_price":"{MIN_PRICE}","shipping_with_together":"{SHIPPING_WITH_TOGETHER}","shipping_companies":"{SHIPPING_COMPANIES}","return_companies":"{RETURN_COMPANIES}"}'
PHP ile istek atmak için bu örnek kullanılabilir. Örnekte Curl kullanılmaktadır.
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.allesgo.com/v1.0/shipping-template/create/store/{STORE_ID}?access_token={ACCESS_TOKEN}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => array ( 'template_name' => '{TEMPLATE_NAME}', 'free_shipping' => '{FREE_SHIPPING}', 'shipping_note' => '{SHIPPING_NOTE}', 'sender_address' => '{SENDER_ADDRESS}', 'return_address' => '{RETURN_ADDRESS}', 'shipping_time' => '{SHIPPING_TIME}', 'all_country' => '{ALL_COUNTRY}', 'suitable_cities' => '{SUITABLE_CITIES}', 'use_contractred_company' => '{USE_CONTRACTED_COMPANY}', 'common_address' => '{COMMON_ADDRESS}', 'conditional_shipping' => '{CONDITIONAL_SHIPPING}', 'min_price' => '{MIN_PRICE}', 'shipping_with_together' => '{SHIPPING_WITH_TOGETHER}', 'shipping_companies' => '{SHIPPING_COMPANIES}', 'return_companies' => '{RETURN_COMPANIES}', ), CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "cache-control: no-cache" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python ile istek atmak için bu örnek kullanılabilir. Bu örnekte Python'un requests kütüphanesi kullanılır ama http.client gibi kütüphane kullanılabilir
import requests url = "https://api.allesgo.com/v1.0/shipping-template/create/store/{{STORE_ID}}" querystring = {"access_token":"{{ACCESS_TOKEN}}"} payload = { "template_name":"{{TEMPLATE_NAME}}", "free_shipping":"{{FREE_SHIPPING}}", "shipping_note":"{{SHIPPING_NOTE}}", "sender_address":"{{SENDER_ADDRESS}}", "return_address":"{RETURN_ADDRESS}", "shipping_time":"{{SHIPPING_TIME}}", "all_country":"{{ALL_COUNTRY}}", "suitable_cities":"{{SUITABLE_CITIES}}", "use_contractred_company":"{{USE_CONTRACTED_COMPANY}}", "common_address":"{{COMMON_ADDRESS}}", "conditional_shipping":"{{CONDITIONAL_SHIPPING}}", "min_price":"{{MIN_PRICE}}", "shipping_with_together":"{{SHIPPING_WITH_TOGETHER}}", "shipping_companies":"{{SHIPPING_COMPANIES}}", "return_companies":"{{RETURN_COMPANIES}}" } headers = { 'Content-Type': "application/json", 'cache-control': "no-cache", } response = requests.request("POST", url, data=payload, headers=headers, params=querystring) print(response.text)
Node.js ile istek atmak için bu örnek kullanılabilir. Örnekte request kullanılmaktadır.
var request = require('request'); var options = { method: 'POST', url: 'https://api.allesgo.com/v1.0/shipping-template/create/store/{STORE_ID}', qs: { access_token: '{ACCESS_TOKEN}' }, headers: { 'cache-control': 'no-cache', 'Content-Type': 'application/json', }, body: { template_name: '{TEMPLATE_NAME}', free_shipping: '{FREE_SHIPPING}', shipping_note: '{SHIPPING_NOTE}', sender_address: '{SENDER_ADDRESS}', return_address: '{RETURN_ADDRESS}', shipping_time: '{SHIPPING_TIME}', all_country: '{ALL_COUNTRY}', suitable_cities: '{SUITABLE_CITIES}', use_contractred_company: '{USE_CONTRACTED_COMPANY}', common_address: '{COMMON_ADDRESS}', conditional_shipping: '{CONDITIONAL_SHIPPING}', min_price: '{MIN_PRICE}', shipping_with_together: '{SHIPPING_WITH_TOGETHER}', shipping_companies: '{SHIPPING_COMPANIES}', return_companies: '{RETURN_COMPANIES}', }, json: true, }; request(options, (error, response, body) => { if (error) throw new Error(error); console.log(body); });
Javascipt ile istek atmak için bu örnek kullanılabilir. Örnekte xhr kullanılmakdır. Not: Bilgi amaçlıdır. Javascipt ile yazılan bu kod'ta Kullanıcı access token'a erişebildiğinden, kullanmanızı önermiyoruz.
var data = JSON.stringify({ template_name: '{TEMPLATE_NAME}', free_shipping: '{FREE_SHIPPING}', shipping_note: '{SHIPPING_NOTE}', sender_address: '{SENDER_ADDRESS}', return_address: '{RETURN_ADDRESS}', shipping_time: '{SHIPPING_TIME}', all_country: '{ALL_COUNTRY}', suitable_cities: '{SUITABLE_CITIES}', use_contractred_company: '{USE_CONTRACTED_COMPANY}', common_address: '{COMMON_ADDRESS}', conditional_shipping: '{CONDITIONAL_SHIPPING}', min_price: '{MIN_PRICE}', shipping_with_together: '{SHIPPING_WITH_TOGETHER}', shipping_companies: '{SHIPPING_COMPANIES}', return_companies: '{RETURN_COMPANIES}', }); var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener('readystatechange', function () { if (this.readyState === 4) { console.log(this.responseText); } }); xhr.open('POST', 'https://api.allesgo.com/v1.0/shipping-template/create/store/{STORE_ID}?access_token={ACCESS_TOKEN}'); xhr.setRequestHeader('Content-Type', 'application/json'); xhr.setRequestHeader('cache-control', 'no-cache'); xhr.send(data);
C Sharp ile istek atmak için bu örnek kullanılabilir. Bu örnekte RestSharp kullanılmaktadır.
var client = new RestClient("https://api.allesgo.com/v1.0/shipping-template/create/store/{STORE_ID}?access_token={ACCESS_TOKEN}"); var request = new RestRequest(Method.POST); request.AddHeader("cache-control", "no-cache"); request.AddHeader("Content-Type", "application/json"); var body = new { template_name = "{TEMPLATE_NAME}", free_shipping = "{FREE_SHIPPING}", shipping_note = "{SHIPPING_NOTE}", sender_address = "{SENDER_ADDRESS}", return_address = "{RETURN_ADDRESS}", shipping_time = "{SHIPPING_TIME}", all_country = "{ALL_COUNTRY}", suitable_cities = "{SUITABLE_CITIES}", use_contractred_company = "{USE_CONTRACTED_COMPANY}", common_address = "{COMMON_ADDRESS}", conditional_shipping = "{CONDITIONAL_SHIPPING}", min_price = "{MIN_PRICE}", shipping_with_together = "{SHIPPING_WITH_TOGETHER}", shipping_companies = "{SHIPPING_COMPANIES}", return_companies = "{RETURN_COMPANIES}" }; request.AddJsonBody(body); IRestResponse response = client.Execute(request);
Java ile istek atmak için bu örnek kullanılabilir. Örnekte Ok Http kullanılmaktadır.
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"template_name\":\"{TEMPLATE_NAME}\",\"free_shipping\":\"{FREE_SHIPPING}\",\"shipping_note\":\"{SHIPPING_NOTE}\",\"sender_address\":\"{SENDER_ADDRESS}\",\"return_address\":\"{RETURN_ADDRESS}\",\"shipping_time\":\"{SHIPPING_TIME}\",\"all_country\":\"{ALL_COUNTRY}\",\"suitable_cities\":\"{SUITABLE_CITIES}\",\"use_contractred_company\":\"{USE_CONTRACTED_COMPANY}\",\"common_address\":\"{COMMON_ADDRESS}\",\"conditional_shipping\":\"{CONDITIONAL_SHIPPING}\",\"min_price\":\"{MIN_PRICE}\",\"shipping_with_together\":\"{SHIPPING_WITH_TOGETHER}\",\"shipping_companies\":\"{SHIPPING_COMPANIES}\",\"return_companies\":\"{RETURN_COMPANIES}\"}"); Request request = new Request.Builder() .url("https://api.allesgo.com/v1.0/shipping-template/create/store/{STORE_ID}?access_token={ACCESS_TOKEN}") .post(body) .addHeader("Content-Type", "application/json") .addHeader("cache-control", "no-cache") .build(); Response response = client.newCall(request).execute();
Go ile istek atmak için bu örnek kullanılabilir. Örnekte net/http kullanılmaktadır.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.allesgo.com/v1.0/shipping-template/create/store/{STORE_ID}?access_token={ACCESS_TOKEN}" payload := strings.NewReader("{\"template_name\":\"{TEMPLATE_NAME}\",\"free_shipping\":\"{FREE_SHIPPING}\",\"shipping_note\":\"{SHIPPING_NOTE}\",\"sender_address\":\"{SENDER_ADDRESS}\",\"return_address\":\"{RETURN_ADDRESS}\",\"shipping_time\":\"{SHIPPING_TIME}\",\"all_country\":\"{ALL_COUNTRY}\",\"suitable_cities\":\"{SUITABLE_CITIES}\",\"use_contractred_company\":\"{USE_CONTRACTED_COMPANY}\",\"common_address\":\"{COMMON_ADDRESS}\",\"conditional_shipping\":\"{CONDITIONAL_SHIPPING}\",\"min_price\":\"{MIN_PRICE}\",\"shipping_with_together\":\"{SHIPPING_WITH_TOGETHER}\",\"shipping_companies\":\"{SHIPPING_COMPANIES}\",\"return_companies\":\"{RETURN_COMPANIES}\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") req.Header.Add("cache-control", "no-cache") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
API Referansı
Request URL parameters
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
storeId | Mağaza ID'si | ObjectId | true | Mağaza ID'si |
POST Request Payload
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
template_name | Teslimat Şablonu Adı | String | true | Teslimat Şablonu Adı | ||
free_shipping | Ücretsiz Kargo | Boolean | false | true | Oluşturulan teslimat şablonundaki gönderim seçeneğinin Ücretsiz Kargo olarak belirlenmesi için kullanılır. | |
shipping_note | Kargo Notu | String | false | Oluşturulan teslimat şablonuna kargo notu eklemek için kullanabilirsiniz. | ||
sender_address | Gönderim Adresi | ObjectId | true | Oluşturulan teslimat şablonundaki Gönderim Adresi'ni belirlemek için kullanılır. | ||
return_address | İade Adresi | ObjectId | false | Mağazanın sipariş gönderim adresi ile iade gönderim adresleri farklı olduğunda kullanılır. "common_adress" değeri "false" verildiğinde bu alan zorunludur | ||
shipping_time | Gönderim Süresi | Integer | true | Oluşturulan teslimat şablonundaki gönderim süresi'nin ne kadar olduğunu belirlemek için kullanılır. | ||
all_country | Tüm Şehirler | Boolean | true | true | Mağaza tüm Türkiye'ye ürün gönderimi sağlıyorsa kullanılır. | |
suitable_cities | Uygun Şehirler | Array |
false | true | Mağaza ürün gönderimini bazı şehirlere sağlıyorsa kullanılır. "all_country" değeri "false" olduğunda bu alan zorunludur. | |
use_contractred_company | Anlaşmalı Kargo Şirketi | Boolean | false | false | Gönderim allesgo.com anlaşmalı kargo şirketi ile yapıldığında kullanılır. | |
common_address | Ortak Adres | Boolean | false | true | Mağazanın gönderim ve iade adresleri aynı olduğunda kullanılır. | |
conditional_shipping | Şartlı Kargo | Boolean | false | false | Mağazanın teslimat şablonunda bulunan şartlı kargo seçeneğini aktif hale getirmek için kullanılır. | |
min_price | Minimum Fiyat | Number | false | Şartlı kargo seçeneğinin aktif olacağı alt tutarı belirlemek için kullanılır. | ||
shipping_with_together | Birlikte Gönderim | Boolean | false | false | Mağazanın teslimat şablonunda bulunan birlikte gönderim seçeneğini aktif hale getirmek için kullanılır. | |
shipping_companies | Kargo Şirketi | Array |
true | Mağazanın sipariş gönderiminde hangi kargo şirketlerini kullanabileceğini belirlemek için kullanılır. | ||
return_companies | İade Kargo Şirketi | Array |
true | Mağazanın iade gönderimler için hangi kargo şirketini kullanacağını belirlemek için kullanılır. |
Sunucudan dönecek cevabın örneği.
{
"data": {
"success": "Boolean"
}
}
Teslimat Şablonu Güncelleme
Belirtilen mağazaya ait teslimat şablonunu güncellemek için kullanır. Kayıtlı bir teslimat şablonunu güncellerken sadece değişikliğin yapılacağı alanların girilmesi yeterlidir.
Örnekler
Curl ile istek atmak için bu örnek kullanılabilir.
curl -X POST \ 'https://api.allesgo.com/v1.0/shipping-template/update/store/{STORE_ID}?access_token={ACCESS_TOKEN}' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{"shipping_template_id": "{SHIPPING_TEMPLATE_ID}","template_name":"{TEMPLATE_NAME}","free_shipping":"{FREE_SHIPPING}","shipping_note":"{SHIPPING_NOTE}","sender_address":"{SENDER_ADDRESS}","return_address":"{RETURN_ADDRESS}","shipping_time":"{SHIPPING_TIME}","all_country":"{ALL_COUNTRY}","suitable_cities":"{SUITABLE_CITIES}","use_contractred_company":"{USE_CONTRACTED_COMPANY}","common_address":"{COMMON_ADDRESS}","conditional_shipping":"{CONDITIONAL_SHIPPING}","min_price":"{MIN_PRICE}","shipping_with_together":"{SHIPPING_WITH_TOGETHER}","shipping_companies":"{SHIPPING_COMPANIES}","return_companies":"{RETURN_COMPANIES}"}'
PHP ile istek atmak için bu örnek kullanılabilir. Örnekte Curl kullanılmaktadır.
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.allesgo.com/v1.0/shipping-template/update/store/{STORE_ID}?access_token={ACCESS_TOKEN}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => array ( 'shipping_template_id' => '{SHIPPING_TEMPLATE_ID}', 'template_name' => '{TEMPLATE_NAME}', 'free_shipping' => '{FREE_SHIPPING}', 'shipping_note' => '{SHIPPING_NOTE}', 'sender_address' => '{SENDER_ADDRESS}', 'return_address' => '{RETURN_ADDRESS}', 'shipping_time' => '{SHIPPING_TIME}', 'all_country' => '{ALL_COUNTRY}', 'suitable_cities' => '{SUITABLE_CITIES}', 'use_contractred_company' => '{USE_CONTRACTED_COMPANY}', 'common_address' => '{COMMON_ADDRESS}', 'conditional_shipping' => '{CONDITIONAL_SHIPPING}', 'min_price' => '{MIN_PRICE}', 'shipping_with_together' => '{SHIPPING_WITH_TOGETHER}', 'shipping_companies' => '{SHIPPING_COMPANIES}', 'return_companies' => '{RETURN_COMPANIES}', ), CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "cache-control: no-cache" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python ile istek atmak için bu örnek kullanılabilir. Bu örnekte Python'un requests kütüphanesi kullanılır ama http.client gibi kütüphane kullanılabilir
import requests url = "https://api.allesgo.com/v1.0/shipping-template/update/store/{{STORE_ID}}" querystring = {"access_token":"{{ACCESS_TOKEN}}"} payload = { "shipping_template_id": "{{SHIPPING_TEMPLATE_ID}}", "template_name":"{{TEMPLATE_NAME}}", "free_shipping":"{{FREE_SHIPPING}}", "shipping_note":"{{SHIPPING_NOTE}}", "sender_address":"{{SENDER_ADDRESS}}", "return_address":"{{RETURN_ADDRESS}}", "shipping_time":"{{SHIPPING_TIME}}", "all_country":"{{ALL_COUNTRY}}", "suitable_cities":"{{SUITABLE_CITIES}}", "use_contractred_company":"{{USE_CONTRACTED_COMPANY}}", "common_address":"{{COMMON_ADDRESS}}", "conditional_shipping":"{{CONDITIONAL_SHIPPING}}", "min_price":"{{MIN_PRICE}}", "shipping_with_together":"{{SHIPPING_WITH_TOGETHER}}", "shipping_companies":"{{SHIPPING_COMPANIES}}", "return_companies":"{{RETURN_COMPANIES}}" } headers = { 'Content-Type': "application/json", 'cache-control': "no-cache", } response = requests.request("POST", url, data=payload, headers=headers, params=querystring) print(response.text)
Node.js ile istek atmak için bu örnek kullanılabilir. Örnekte request kullanılmaktadır.
var request = require('request'); var options = { method: 'POST', url: 'https://api.allesgo.com/v1.0/shipping-template/update/store/{STORE_ID}', qs: { access_token: '{ACCESS_TOKEN}' }, headers: { 'cache-control': 'no-cache', 'Content-Type': 'application/json', }, body: { shipping_template_id: '{SHIPPING_TEMPLATE_ID}', template_name: '{TEMPLATE_NAME}', free_shipping: '{FREE_SHIPPING}', shipping_note: '{SHIPPING_NOTE}', sender_address: '{SENDER_ADDRESS}', return_address: '{RETURN_ADDRESS}', shipping_time: '{SHIPPING_TIME}', all_country: '{ALL_COUNTRY}', suitable_cities: '{SUITABLE_CITIES}', use_contractred_company: '{USE_CONTRACTED_COMPANY}', common_address: '{COMMON_ADDRESS}', conditional_shipping: '{CONDITIONAL_SHIPPING}', min_price: '{MIN_PRICE}', shipping_with_together: '{SHIPPING_WITH_TOGETHER}', shipping_companies: '{SHIPPING_COMPANIES}', return_companies: '{RETURN_COMPANIES}', }, json: true, }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Javascipt ile istek atmak için bu örnek kullanılabilir. Örnekte xhr kullanılmakdır. Not: Bilgi amaçlıdır. Javascipt ile yazılan bu kod'ta Kullanıcı access token'a erişebildiğinden, kullanmanızı önermiyoruz.
var data = JSON.stringify({ shipping_template_id: '{SHIPPING_TEMPLATE_ID}', template_name: '{TEMPLATE_NAME}', free_shipping: '{FREE_SHIPPING}', shipping_note: '{SHIPPING_NOTE}', sender_address: '{SENDER_ADDRESS}', return_address: '{RETURN_ADDRESS}', shipping_time: '{SHIPPING_TIME}', all_country: '{ALL_COUNTRY}', suitable_cities: '{SUITABLE_CITIES}', use_contractred_company: '{USE_CONTRACTED_COMPANY}', common_address: '{COMMON_ADDRESS}', conditional_shipping: '{CONDITIONAL_SHIPPING}', min_price: '{MIN_PRICE}', shipping_with_together: '{SHIPPING_WITH_TOGETHER}', shipping_companies: '{SHIPPING_COMPANIES}', return_companies: '{RETURN_COMPANIES}', }); var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener('readystatechange', function () { if (this.readyState === 4) { console.log(this.responseText); } }); xhr.open('POST', 'https://api.allesgo.com/v1.0/shipping-template/update/store/{STORE_ID}?access_token={ACCESS_TOKEN}'); xhr.setRequestHeader('Content-Type', 'application/json'); xhr.setRequestHeader('cache-control', 'no-cache'); xhr.send(data);
C Sharp ile istek atmak için bu örnek kullanılabilir. Bu örnekte RestSharp kullanılmaktadır.
var client = new RestClient("https://api.allesgo.com/v1.0/shipping-template/update/store/{STORE_ID}?access_token={ACCESS_TOKEN}"); var request = new RestRequest(Method.POST); request.AddHeader("cache-control", "no-cache"); request.AddHeader("Content-Type", "application/json"); var body = new { shipping_template_id = "{SHIPPING_TEMPLATE_ID}", template_name = "{TEMPLATE_NAME}", free_shipping = "{FREE_SHIPPING}", shipping_note = "{SHIPPING_NOTE}", sender_address = "{SENDER_ADDRESS}", return_address = "{RETURN_ADDRESS}", shipping_time = "{SHIPPING_TIME}", all_country = "{ALL_COUNTRY}", suitable_cities = "{SUITABLE_CITIES}", use_contractred_company = "{USE_CONTRACTED_COMPANY}", common_address = "{COMMON_ADDRESS}", conditional_shipping = "{CONDITIONAL_SHIPPING}", min_price = "{MIN_PRICE}", shipping_with_together = "{SHIPPING_WITH_TOGETHER}", shipping_companies = "{SHIPPING_COMPANIES}", return_companies = "{RETURN_COMPANIES}" }; request.AddJsonBody(body); IRestResponse response = client.Execute(request);
Java ile istek atmak için bu örnek kullanılabilir. Örnekte Ok Http kullanılmaktadır.
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"shipping_template_id\": \"{SHIPPING_TEMPLATE_ID}\",\"template_name\":\"{TEMPLATE_NAME}\",\"free_shipping\":\"{FREE_SHIPPING}\",\"shipping_note\":\"{SHIPPING_NOTE}\",\"sender_address\":\"{SENDER_ADDRESS}\",\"return_address\":\"{RETURN_ADDRESS}\",\"shipping_time\":\"{SHIPPING_TIME}\",\"all_country\":\"{ALL_COUNTRY}\",\"suitable_cities\":\"{SUITABLE_CITIES}\",\"use_contractred_company\":\"{USE_CONTRACTED_COMPANY}\",\"common_address\":\"{COMMON_ADDRESS}\",\"conditional_shipping\":\"{CONDITIONAL_SHIPPING}\",\"min_price\":\"{MIN_PRICE}\",\"shipping_with_together\":\"{SHIPPING_WITH_TOGETHER}\",\"shipping_companies\":\"{SHIPPING_COMPANIES}\",\"return_companies\":\"{RETURN_COMPANIES}\"}"); Request request = new Request.Builder() .url("https://api.allesgo.com/v1.0/shipping-template/update/store/{STORE_ID}?access_token={ACCESS_TOKEN}") .post(body) .addHeader("Content-Type", "application/json") .addHeader("cache-control", "no-cache") .build(); Response response = client.newCall(request).execute();
Go ile istek atmak için bu örnek kullanılabilir. Örnekte net/http kullanılmaktadır.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.allesgo.com/v1.0/shipping-template/update/store/{STORE_ID}?access_token={ACCESS_TOKEN}" payload := strings.NewReader("{\"shipping_template_id\": \"{SHIPPING_TEMPLATE_ID}\",\"template_name\":\"{TEMPLATE_NAME}\",\"free_shipping\":\"{FREE_SHIPPING}\",\"shipping_note\":\"{SHIPPING_NOTE}\",\"sender_address\":\"{SENDER_ADDRESS}\",\"return_address\":\"{RETURN_ADDRESS}\",\"shipping_time\":\"{SHIPPING_TIME}\",\"all_country\":\"{ALL_COUNTRY}\",\"suitable_cities\":\"{SUITABLE_CITIES}\",\"use_contractred_company\":\"{USE_CONTRACTED_COMPANY}\",\"common_address\":\"{COMMON_ADDRESS}\",\"conditional_shipping\":\"{CONDITIONAL_SHIPPING}\",\"min_price\":\"{MIN_PRICE}\",\"shipping_with_together\":\"{SHIPPING_WITH_TOGETHER}\",\"shipping_companies\":\"{SHIPPING_COMPANIES}\",\"return_companies\":\"{RETURN_COMPANIES}\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") req.Header.Add("cache-control", "no-cache") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
API Referansı
Request URL parameters
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
storeId | Mağaza ID'si | ObjectId | true | Mağaza ID'si |
POST Request Payload
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
shipping_template_id | Teslimat Şablonu ID'si | ObjectId | true | ID numarasına göre teslimat şablonu güncellemek için kullanılır. | ||
template_name | Teslimat Şablonu Adı | String | false | Teslimat Şablonu Adı | ||
free_shipping | Ücretsiz Kargo | Boolean | false | true | Oluşturulan teslimat şablonundaki gönderim seçeneğinin Ücretsiz Kargo olarak belirlenmesi için kullanılır. | |
shipping_note | Kargo Notu | String | false | Oluşturulan teslimat şablonuna kargo notu eklemek için kullanabilirsiniz. | ||
sender_address | Gönderim Adresi | ObjectId | false | Oluşturulan teslimat şablonundaki Gönderim Adresi'ni belirlemek için kullanılır. | ||
return_address | İade Adresi | ObjectId | false | Mağazanın sipariş gönderim adresi ile iade gönderim adresleri farklı olduğunda kullanılır. "common_adress" değeri "false" verildiğinde bu alan zorunludur | ||
shipping_time | Gönderim Süresi | Integer | false | Oluşturulan teslimat şablonundaki gönderim süresi'nin ne kadar olduğunu belirlemek için kullanılır. | ||
all_country | Tüm Şehirler | Boolean | false | true | Mağaza tüm Türkiye'ye ürün gönderimi sağlıyorsa kullanılır. | |
suitable_cities | Uygun Şehirler | Array |
false | true | Mağaza ürün gönderimini bazı şehirlere sağlıyorsa kullanılır. "all_country" değeri "false" olduğunda bu alan zorunludur. | |
use_contractred_company | Anlaşmalı Şirketi Kullan | Boolean | false | false | Gönderim allesgo.com anlaşmalı kargo şirketi ile yapıldığında kullanılır. | |
common_address | Ortak Adres | Boolean | false | true | Mağazanın gönderim ve iade adresleri aynı olduğunda kullanılır. | |
conditional_shipping | Şartlı Kargo | Boolean | false | false | Mağazanın teslimat şablonunda bulunan şartlı kargo seçeneğini aktif hale getirmek için kullanılır. | |
min_price | Minimum Fiyat | Number | false | Şartlı kargo seçeneğinin aktif olacağı alt tutarı belirlemek için kullanılır. | ||
shipping_with_together | Birlikte Gönderim | Boolean | false | false | Mağazanın teslimat şablonunda bulunan birlikte gönderim seçeneğini aktif hale getirmek için kullanılır. | |
shipping_companies | Kargo Şirketi | Array |
false | Mağazanın sipariş gönderiminde hangi kargo şirketlerini kullanabileceğini belirlemek için kullanılır. | ||
return_companies | İade Kargo Şirketi | Array |
false | Mağazanın iade gönderimler için hangi kargo şirketini kullanacağını belirlemek için kullanılır. |
Sunucudan dönecek cevabın örneği.
{
"data": {
"success": "Boolean"
}
}
Gönderim Adresleri Listeleme
Belirtilen mağazaya ait teslimat şablonlarında bulunan gönderim adreslerinin tümünü listelemek için kullanılır.
Örnekler
Curl ile istek atmak için bu örnek kullanılabilir.
curl -X GET \ 'https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId?access_token={ACCESS_TOKEN}' \ -H 'Accept: application/json' \ -H 'Cache-Control: no-cache' \ -H 'Connection: keep-alive' \ -H 'Host: api.allesgo.com' \ -H 'cache-control: no-cache'
PHP ile istek atmak için bu örnek kullanılabilir. Örnekte Curl kullanılmaktadır.
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId?access_token={ACCESS_TOKEN}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => array( "Accept: application/json", "Cache-Control: no-cache", "Connection: keep-alive", "Host: api.allesgo.com", "cache-control: no-cache", ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python ile istek atmak için bu örnek kullanılabilir. Bu örnekte Python'un requests kütüphanesi kullanılır ama http.client gibi kütüphane kullanılabilir
import requests url = "https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId" querystring = {"access_token":"{{ACCESS_TOKEN}}"} headers = { 'Accept': "application/json", 'Cache-Control': "no-cache", 'Host': "api.allesgo.com", 'Connection': "keep-alive", 'cache-control': "no-cache" } response = requests.request("GET", url, headers=headers, params=querystring) print(response.text)
Node.js ile istek atmak için bu örnek kullanılabilir. Örnekte request kullanılmaktadır.
var request = require('request'); var options = { method: 'GET', url: 'https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId', qs: { access_token: '{ACCESS_TOKEN}' }, headers: { 'cache-control': 'no-cache', Connection: 'keep-alive', Host: 'api.allesgo.com', Accept: 'application/json', }, }; request(options, (error, response, body) => { if (error) throw new Error(error); console.log(body); });
Javascipt ile istek atmak için bu örnek kullanılabilir. Örnekte xhr kullanılmakdır. Not: Bilgi amaçlıdır. Javascipt ile yazılan bu kod'ta Kullanıcı access token'a erişebildiğinden, kullanmanızı önermiyoruz.
var data = null; var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener('readystatechange', function () { if (this.readyState === 4) { console.log(this.responseText); } }); xhr.open('GET', 'https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId?access_token={ACCESS_TOKEN}'); xhr.setRequestHeader('Accept', 'application/json'); xhr.setRequestHeader('Cache-Control', 'no-cache'); xhr.setRequestHeader('Host', 'api.allesgo.com'); xhr.setRequestHeader('Connection', 'keep-alive'); xhr.setRequestHeader('cache-control', 'no-cache'); xhr.send(data);
C Sharp ile istek atmak için bu örnek kullanılabilir. Bu örnekte RestSharp kullanılmaktadır.
var client = new RestClient("https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId?access_token={ACCESS_TOKEN}"); var request = new RestRequest(Method.GET); request.AddHeader("cache-control", "no-cache"); request.AddHeader("Connection", "keep-alive"); request.AddHeader("Host", "api.allesgo.com"); request.AddHeader("Cache-Control", "no-cache"); request.AddHeader("Accept", "application/json"); IRestResponse response = client.Execute(request);
Java ile istek atmak için bu örnek kullanılabilir. Örnekte Ok Http kullanılmaktadır.
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId?access_token={ACCESS_TOKEN}") .get() .addHeader("Accept", "application/json") .addHeader("Cache-Control", "no-cache") .addHeader("Host", "api.allesgo.com") .addHeader("Connection", "keep-alive") .addHeader("cache-control", "no-cache") .build(); Response response = client.newCall(request).execute();
Go ile istek atmak için bu örnek kullanılabilir. Örnekte net/http kullanılmaktadır.
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://api.allesgo.com/v1.0/shipping-template/address/store/:storeId?access_token={ACCESS_TOKEN}" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Accept", "*/*") req.Header.Add("Cache-Control", "no-cache") req.Header.Add("Host", "api.allesgo.com") req.Header.Add("Accept-Encoding", "gzip, deflate") req.Header.Add("Connection", "keep-alive") req.Header.Add("cache-control", "no-cache") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
API Referansı
Request URL parameters
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
storeId | Mağaza ID'si | ObjectId | true | Mağaza ID'si |
Sunucudan dönecek cevabın örneği.
{
"data": {
"total": "Integer",
"result": [
{
"id": "ObjectId",
"address_name": "String",
"address_text": "String",
"city": "String",
"county": "String",
"postal_code": "String",
"phone": "String"
}
]
}
}
Gönderim Adresi Kaydetme
Belirtilen mağazaya yeni bir gönderim adresi eklemek için kullanılır.
Örnekler
Curl ile istek atmak için bu örnek kullanılabilir.
curl -X POST \ https://api.allesgo.com/v1.0/shipping-template/address/create/store/{STORE_ID} \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{"address_name": "{ADDRESS_NAME}", "city": "{CITY}", "county": "{COUNTY}", "address_text": "{ADDRESS_TEXT}", "postal_code": "{POSTAL_CODE}", "phone": "{PHONE}"}'
PHP ile istek atmak için bu örnek kullanılabilir. Örnekte Curl kullanılmaktadır.
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.allesgo.com/v1.0/shipping-template/address/create/store/{STORE_ID}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => array( "address_name" => "{ADDRESS_NAME}", "city" => "{CITY}", "county" => "{COUNTY}", "address_text" => "{ADDRESS_TEXT}", "postal_code" => "{POSTAL_CODE}", "phone" => "{PHONE}", ), CURLOPT_HTTPHEADER => array( "cache-control: no-cache", ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python ile istek atmak için bu örnek kullanılabilir. Bu örnekte Python'un requests kütüphanesi kullanılır ama http.client gibi kütüphane kullanılabilir
import requests url = "https://api.allesgo.com/v1.0/shipping-template/address/create/store/{{STORE_ID}}" payload = { "address_name": "{{ADDRESS_NAME}}", "city": "{{CITY}}", "county": "{{COUNTY}}", "address_text": "{{ADDRESS_TEXT}}", "postal_code": "{{POSTAL_CODE}}", "phone": "{{PHONE}}" } headers = { 'Content-Type': "application/json", 'cache-control': "no-cache" } response = requests.request("POST", url, data=payload, headers=headers) print(response.text)
Node.js ile istek atmak için bu örnek kullanılabilir. Örnekte request kullanılmaktadır.
var request = require('request'); var options = { method: 'POST', url: 'https://api.allesgo.com/v1.0/shipping-template/address/create/store/{STORE_ID}', headers: { 'cache-control': 'no-cache', 'Content-Type': 'application/json', }, body: JSON.stringify({ address_name: '{ADDRESS_NAME}', city: '{CITY}', county: '{COUNTY}', address_text: '{ADDRESS_TEXT}', postal_code: '{POSTAL_CODE}', phone: '{PHONE}', }), }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
Javascipt ile istek atmak için bu örnek kullanılabilir. Örnekte xhr kullanılmakdır. Not: Bilgi amaçlıdır. Javascipt ile yazılan bu kod'ta Kullanıcı access token'a erişebildiğinden, kullanmanızı önermiyoruz.
var data = JSON.stringify({ address_name: '{ADDRESS_NAME}', city: '{CITY}', county: 'COUNTY', address_text: '{ADDRESS_TEXT}', postal_code: '{POSTAL_CODE}', phone: '{PHONE}', }); var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener('readystatechange', function () { if (this.readyState === 4) { console.log(this.responseText); } }); xhr.open('POST', 'https://api.allesgo.com/v1.0/shipping-template/address/create/store/{STORE_ID}'); xhr.setRequestHeader('Content-Type', 'application/json'); xhr.setRequestHeader('cache-control', 'no-cache'); xhr.send(data);
C Sharp ile istek atmak için bu örnek kullanılabilir. Bu örnekte RestSharp kullanılmaktadır.
var client = new RestClient("https://api.allesgo.com/v1.0/shipping-template/address/create/store/{STORE_ID}"); var request = new RestRequest(Method.POST); request.AddHeader("cache-control", "no-cache"); request.AddHeader("Content-Type", "application/json"); var body = new { address_name = "{ADDRESS_NAME}", city = "{CITY}", county = "{COUNTY}", address_text = "{ADDRESS_TEXT}", postal_code = "{POSTAL_CODE}", phone = "{PHONE}", }; request.AddJsonBody(body); IRestResponse response = client.Execute(request);
Java ile istek atmak için bu örnek kullanılabilir. Örnekte Ok Http kullanılmaktadır.
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = RequestBody.create(mediaType, "{\"address_name\": \"{ADDRESS_NAME}\", \"city\": \"{CITY}\", \"county\": \"{COUNTY}\", \"address_text\": \"{ADDRESS_TEXT}\", \"postal_code\": \"{POSTAL_CODE}\", \"phone\": \"{PHONE}\"}"); Request request = new Request.Builder() .url("https://api.allesgo.com/v1.0/shipping-template/address/create/store/{STORE_ID}") .post(body) .addHeader("Content-Type", "application/json") .addHeader("cache-control", "no-cache") .build(); Response response = client.newCall(request).execute();
Go ile istek atmak için bu örnek kullanılabilir. Örnekte net/http kullanılmaktadır.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.allesgo.com/v1.0/shipping-template/address/create/store/{STORE_ID}" payload := strings.NewReader("{\"address_name\": \"{ADDRESS_NAME}\", \"city\": \"{CITY}\", \"county\": \"{COUNTY}\", \"address_text\": \"{ADDRESS_TEXT}\", \"postal_code\": \"{POSTAL_CODE}\", \"phone\": \"{PHONE}\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") req.Header.Add("cache-control", "no-cache") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
API Referansı
Request URL parameters
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
storeId | Mağaza ID'si | ObjectId | true | Mağaza ID'si |
POST Request Payload
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
address_name | Adresin İsmi | String | true | Adresin İsmi | ||
city | Şehir | String | true | Şehir | ||
county | İlçenin İsmi | String | true | İlçe | ||
address_text | Açık Adres | String | true | Gönderim adresinin açık adres kısmına veri girmek için kullanılır. Girilen adres en az 10 en fazla 500 karakter olabilir. | ||
postal_code | Posta Kodu | String | true | Gönderim adresinin posta kodu kısmına veri girmek için kullanılır. | ||
phone | Telefon Numarası | String | true | Gönderim adresine ait telefon numarasını eklemek için kullanılır. Telefon numarası başına 0 yazmadan giriniz. |
Sunucudan dönecek cevabın örneği.
{
"data": {
"success": "Boolean"
}
}
Gönderim Adresi Güncelleme
Belirtilen mağazaya ait gönderim adresini güncellemek için kullanılır.
Örnekler
Curl ile istek atmak için bu örnek kullanılabilir.
curl -X POST \ 'https://api.allesgo.com/v1.0/shipping-template/address/update/store/{STORE_ID}' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{"address_name": "{ADDRESS_NAME}", "city": "{CITY}", "county": "{COUNTY}", "address_text": "{ADDRESS_TEXT}", "postal_code": "{POSTAL_CODE}", "phone": "{PHONE}"}'
PHP ile istek atmak için bu örnek kullanılabilir. Örnekte Curl kullanılmaktadır.
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://api.allesgo.com/v1.0/shipping-template/address/update/store/{STORE_ID}", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => array( "address_id" => "{ADDRESS_ID}", "address_name" => "{ADDRESS_NAME}", "city" => "{CITY}", "county" => "{COUNTY}", "address_text" => "{ADDRESS_TEXT}", "postal_code" => "{POSTAL_CODE}", "phone" => "{PHONE}", ), CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "cache-control: no-cache", ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
Python ile istek atmak için bu örnek kullanılabilir. Bu örnekte Python'un requests kütüphanesi kullanılır ama http.client gibi kütüphane kullanılabilir
import requests url = "https://api.allesgo.com/v1.0/shipping-template/address/store/update{{STORE_ID}}" payload = { "address_id": "{{ADDRESS_ID}}", "address_name": "{{ADDRESS_NAME}}", "city": "{{CITY}}", "county": "COUNTY", "address_text": "{{ADDRESS_TEXT}}", "postal_code": "{{POSTAL_CODE}}", "phone": "{{PHONE}}" } headers = { 'Content-Type': "application/json", 'cache-control': "no-cache" } response = requests.request("POST", url, data=payload, headers=headers) print(response.text)
Node.js ile istek atmak için bu örnek kullanılabilir. Örnekte request kullanılmaktadır.
var request = require('request'); var options = { method: 'POST', url: 'https://api.allesgo.com/v1.0/shipping-template/address/update/store/{STORE_ID}', headers: { 'cache-control': 'no-cache', 'Content-Type': 'application/json', }, body: { address_id: '{ADDRESS_ID}', address_name: '{ADDRESS_NAME}', city: '{CITY}', county: '{COUNTY}', address_text: '{ADDRESS_TEXT}', postal_code: '{POSTAL_CODE}', phone: '{PHONE}', }, json: true, }; request(options, (error, response, body) => { if (error) throw new Error(error); console.log(body); });
Javascipt ile istek atmak için bu örnek kullanılabilir. Örnekte xhr kullanılmakdır. Not: Bilgi amaçlıdır. Javascipt ile yazılan bu kod'ta Kullanıcı access token'a erişebildiğinden, kullanmanızı önermiyoruz.
var data = JSON.stringify({ address_id: '{ADDRESS_ID}', address_name: '{ADDRESS_NAME}', city: '{CITY}', county: '{COUNTY}', address_text: '{ADDRESS_TEXT}', postal_code: '{POSTAL_CODE}', phone: '{PHONE}', }); var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener('readystatechange', function () { if (this.readyState === 4) { console.log(this.responseText); } }); xhr.open('POST', 'https://api.allesgo.com/v1.0/shipping-template/address/update/store/{STORE_ID}'); xhr.setRequestHeader('Content-Type', 'application/json'); xhr.setRequestHeader('cache-control', 'no-cache'); xhr.send(data);
C Sharp ile istek atmak için bu örnek kullanılabilir. Bu örnekte RestSharp kullanılmaktadır.
var client = new RestClient("https://api.allesgo.com/v1.0/shipping-template/address/update/store/{STORE_ID}"); var request = new RestRequest(Method.POST); request.AddHeader("cache-control", "no-cache"); request.AddHeader("Content-Type", "application/json"); var body = new { address_id = '{ADDRESS_ID}', address_name = "{ADDRESS_NAME}", city = "{CITY}", county = "{COUNTY}", address_text = "{ADDRESS_TEXT}", postal_code = "{POSTAL_CODE}", phone = "{PHONE}", }; request.AddJsonBody(body); IRestResponse response = client.Execute(request);
Java ile istek atmak için bu örnek kullanılabilir. Örnekte Ok Http kullanılmaktadır.
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"address_name\": \"{ADDRESS_NAME}\", \"city\": \"{CITY}\", \"county\": \"{COUNTY}\", \"address_text\": \"{ADDRESS_TEXT}\", \"postal_code\": \"{POSTAL_CODE}\", \"phone\": \"{PHONE}\"}"); Request request = new Request.Builder() .url("https://api.allesgo.com/v1.0/shipping-template/address/update/store/{STORE_ID}") .post(body) .addHeader("Content-Type", "application/json") .addHeader("cache-control", "no-cache") .addHeader("Postman-Token", "8616119a-c310-428d-b1b2-0e68ce15c8e1") .build(); Response response = client.newCall(request).execute();
Go ile istek atmak için bu örnek kullanılabilir. Örnekte net/http kullanılmaktadır.
package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.allesgo.com/v1.0/shipping-template/address/update/store/{STORE_ID}" payload := strings.NewReader("{\"address_id\": \"{ADDRESS_ID}\", \"address_name\": \"{ADDRESS_NAME}\", \"city\": \"{CITY}\", \"county\": \"{COUNTY}\", \"address_text\": \"{ADDRESS_TEXT}\", \"postal_code\": \"{POSTAL_CODE}\", \"phone\": \"{PHONE}\"}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") req.Header.Add("cache-control", "no-cache") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
API Referansı
Request URL parameters
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
storeId | Mağaza ID'si | ObjectId | true | Mağaza ID'si |
POST Request Payload
Parametre | Türkçe | Tür | Zorunlu | Geçerli Değerler | Varsayılan | Açıklama |
---|---|---|---|---|---|---|
address_id | Adresin ID'si | ObjectId | true | Adresin ID'si | ||
address_name | Adresin İsmi | String | false | Adresin İsmi | ||
city | Şehir | String | false | Şehir | ||
county | İlçenin İsmi | String | false | İlçe | ||
address_text | Açık Adres | String | false | Gönderim adresinin açık adres kısmına veri girmek için kullanılır. Girilen adres en az 10 en fazla 500 karakter olabilir. | ||
postal_code | Posta Kodu | String | false | Gönderim adresinin posta kodu kısmına veri girmek için kullanılır. | ||
phone | Telefon Numarası | String | false | Gönderim adresine ait telefon numarasını eklemek için kullanılır. Telefon numarası başına 0 yazmadan giriniz. |
Sunucudan dönecek cevabın örneği.
{
"data": {
"success": "Boolean"
}
}