API reference · General and lookups

List order status codes

Returns the order status codes used by integrations and stores, with their descriptions.

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

The result comes in groups. Each group has IntegrationId, StoreId and a ListingStatuses list. In an integration-wide list StoreId is 0; in a store-specific list it is the store's ID.

If you send StoreId, only that store's statuses are returned and IntegrationId is ignored. For marketplaces with a fixed status set you get the marketplace's list; for e-commerce sites that define their own statuses you get the store's own list.

If you send only IntegrationId, that integration's statuses are returned. If you send neither, statuses of all integrations and stores you use are returned. Integration-wide groups come first, then store groups. An integration-wide group can also repeat store-specific statuses of the same integration.

Code is the status value that appears on order lines (e.g. OrderStatus in GetOrderDetailStatus). Description is always in Turkish. If Erp is 1, orders in this status are eligible for ERP/accounting transfer.

A StoreId that is not in your account returns 10001. An unknown IntegrationId is not an error; it returns an empty list. There is no paging.

Request fields

Field	Type	Description
`ApiCode` required	string	Session code returned by `DoLogin`.
`IntegrationId`	integer	Optional. Returns only this integration's statuses. Ignored when `StoreId` is set.
`StoreId`	integer	Optional. Returns only this store's statuses (`StoreId` from `GetStores`).

Response fields (Response)

Field	Type	Description
`IntegrationId`	integer	Integration ID.
`StoreId`	integer	Store ID. 0 for an integration-wide list.
`ListingStatuses`	object[]	Statuses in this group.
ListingStatuses[]. `Code`	string	Status code.
ListingStatuses[]. `Description`	string	Turkish description of the status.
ListingStatuses[]. `Erp`	integer	1: orders in this status are eligible for ERP/accounting transfer. 0: not eligible. `0` No ERP transfer `1` Eligible for ERP transfer

Error codes for this endpoint

Code	When
`10001`	`StoreId` is not a store in your account (`ErrorMessage`: `Invalid store.`).
`99999`	An unexpected server-side error occurred (e.g. a database error). On this endpoint `ErrorMessage` is usually empty.

For session errors (00001, 00006) and every other code see error codes.

Related endpoints

Example request

{
  "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);
}

Example response

{
  "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
        }
      ]
    }
  ]
}

Try it

The request goes straight from your browser to out.stockmount.com. The ApiCode is not stored by this site; it is kept only while this tab is open.

Get an ApiCode before sending requests.

Body (JSON)

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