API referansı · Genel ve listeler

Sipariş durum kodlarını listele

Entegrasyonların ve mağazaların kullandığı sipariş durumu kodlarını açıklamalarıyla döndürür.

POST https://out.stockmount.com/api/Integration/GetIntegrationOrderListingStatus

Sonuç gruplar halinde gelir. Her grupta IntegrationId, StoreId ve ListingStatuses listesi bulunur. Entegrasyonun genel listesinde StoreId 0'dır; mağazaya özel listede mağazanın kimliğidir.

StoreId gönderirseniz yalnızca o mağazanın durumları döner ve IntegrationId yok sayılır. Durumları sabit olan pazaryerlerinde pazaryerinin listesi, kendi durumlarını tanımlayan e-ticaret sitelerinde mağazanın kendi listesi gelir.

Yalnızca IntegrationId gönderirseniz o entegrasyonun durumları döner. İkisini de göndermezseniz kullandığınız tüm entegrasyonların ve mağazaların durumları döner. Genel gruplar önce, mağaza grupları sonra gelir. Bir entegrasyonun genel grubu, aynı entegrasyonun mağazaya özel durumlarını da tekrar içerebilir.

Code, sipariş satırlarında görünen durum değeridir (ör. GetOrderDetailStatus yanıtındaki OrderStatus). Description her zaman Türkçedir. Erp değeri 1 ise bu durumdaki siparişler ERP/muhasebe aktarımına uygundur.

Hesabınıza ait olmayan bir StoreId 10001 döndürür. Bilinmeyen bir IntegrationId hata vermez, boş liste döner. Sayfalama yoktur.

İstek alanları

Alan	Tip	Açıklama
`ApiCode` zorunlu	string	`DoLogin` yanıtından aldığınız oturum kodu.
`IntegrationId`	integer	İsteğe bağlı. Yalnızca bu entegrasyonun durumlarını döndürür. `StoreId` doluysa yok sayılır.
`StoreId`	integer	İsteğe bağlı. Yalnızca bu mağazanın durumlarını döndürür (`GetStores` yanıtındaki `StoreId`).

Yanıt alanları (Response)

Alan	Tip	Açıklama
`IntegrationId`	integer	Entegrasyon kimliği.
`StoreId`	integer	Mağaza kimliği. Entegrasyonun genel listesinde 0'dır.
`ListingStatuses`	object[]	Bu gruptaki durumlar.
ListingStatuses[]. `Code`	string	Durum kodu.
ListingStatuses[]. `Description`	string	Durumun Türkçe açıklaması.
ListingStatuses[]. `Erp`	integer	1: bu durumdaki siparişler ERP/muhasebe aktarımına uygundur. 0: uygun değildir. `0` ERP aktarımı yok `1` ERP aktarımına uygun

Bu servisin hata kodları

Kod	Ne zaman
`10001`	`StoreId` hesabınıza ait bir mağaza değil (`ErrorMessage`: `Invalid store.`).
`99999`	Sunucu tarafında beklenmeyen bir hata oluştu (ör. veritabanı hatası). Bu uç noktada `ErrorMessage` çoğunlukla boş gelir.

Oturum hataları (00001, 00006) ve tüm kodlar için hata kodları.

İlgili servisler

Örnek istek

{
  "ApiCode": "API_CODE",
  "StoreId": 1234
}

curl -X POST 'https://out.stockmount.com/api/Integration/GetIntegrationOrderListingStatus' \
  -H 'Content-Type: application/json' \
  -d '{
  "ApiCode": "API_CODE",
  "StoreId": 1234
}'

using System.Net.Http;
using System.Text;

using var http = new HttpClient();
var json = """
{
  "ApiCode": "API_CODE",
  "StoreId": 1234
}
""";

var response = await http.PostAsync(
    "https://out.stockmount.com/api/Integration/GetIntegrationOrderListingStatus",
    new StringContent(json, Encoding.UTF8, "application/json"));

var result = await response.Content.ReadAsStringAsync();
// Result == false ise ErrorCode ve ErrorMessage alanlarına bakın.
Console.WriteLine(result);

<?php
$body = <<<'JSON'
{
  "ApiCode": "API_CODE",
  "StoreId": 1234
}
JSON;

$ch = curl_init('https://out.stockmount.com/api/Integration/GetIntegrationOrderListingStatus');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_RETURNTRANSFER => true,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

if (!$result['Result']) {
    echo $result['ErrorCode'] . ' ' . $result['ErrorMessage'];
}

import requests

payload = {
    "ApiCode": "API_CODE",
    "StoreId": 1234
}

response = requests.post("https://out.stockmount.com/api/Integration/GetIntegrationOrderListingStatus", json=payload, timeout=60)
result = response.json()

if not result["Result"]:
    print(result["ErrorCode"], result["ErrorMessage"])

const payload = {
  "ApiCode": "API_CODE",
  "StoreId": 1234
};

const response = await fetch("https://out.stockmount.com/api/Integration/GetIntegrationOrderListingStatus", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
const result = await response.json();

if (!result.Result) {
  console.error(result.ErrorCode, result.ErrorMessage);
}

Örnek yanıt

{
  "Result": true,
  "Response": [
    {
      "IntegrationId": 14,
      "StoreId": 1234,
      "ListingStatuses": [
        {
          "Code": "Created",
          "Description": "Yeni Sipariş",
          "Erp": 1
        },
        {
          "Code": "Shipped",
          "Description": "Kargoya Verildi",
          "Erp": 1
        },
        {
          "Code": "Cancelled",
          "Description": "İptal Edildi",
          "Erp": 0
        }
      ]
    }
  ]
}

Deneyin

İstek tarayıcınızdan doğrudan out.stockmount.com adresine gider. ApiCode bu sitede saklanmaz; yalnızca bu sekme açıkken tutulur.

İstek göndermek için önce ApiCode alın.

Gövde (JSON)

{
  "ApiCode": "{{apiCode}}",
  "StoreId": 1234
}