API reference · General and lookups

Get order line statuses

Returns the current status codes of the order lines you specify.

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

Only OrderDetailId is read from each item of OrderDetails; other fields are ignored.

Only lines that belong to your stores are returned. IDs that are not found or belong to another account are skipped without an error. The response order is not guaranteed.

There is no list length limit in code. Use GetIntegrationOrderListingStatus for the meaning of OrderStatus values. A line without a status has an empty OrderStatus.

Request fields

Field	Type	Description
`ApiCode` required	string	Session code returned by `DoLogin`.
`OrderDetails` required	object[]	Order lines to query. At least one item is required.
OrderDetails[]. `OrderDetailId` required	integer	Order line ID (`OrderDetailId` from order responses).

Response fields (Response)

Field	Type	Description
`OrderId`	integer	StockMount order ID.
`OrderDetailId`	integer	Order line ID.
`StoreId`	integer	ID of the store the line belongs to.
`OrderStatus`	string	Current status code of the line. Can be empty.

Error codes for this endpoint

Code	When
`00003`	`OrderDetails` is missing or empty. `ErrorMessage`: `OrderDetails`.
`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",
  "OrderDetails": [
    {
      "OrderDetailId": 9876543
    },
    {
      "OrderDetailId": 9876544
    }
  ]
}

curl -X POST 'https://out.stockmount.com/api/Integration/GetOrderDetailStatus' \
  -H 'Content-Type: application/json' \
  -d '{
  "ApiCode": "API_CODE",
  "OrderDetails": [
    {
      "OrderDetailId": 9876543
    },
    {
      "OrderDetailId": 9876544
    }
  ]
}'

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

using var http = new HttpClient();
var json = """
{
  "ApiCode": "API_CODE",
  "OrderDetails": [
    {
      "OrderDetailId": 9876543
    },
    {
      "OrderDetailId": 9876544
    }
  ]
}
""";

var response = await http.PostAsync(
    "https://out.stockmount.com/api/Integration/GetOrderDetailStatus",
    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",
  "OrderDetails": [
    {
      "OrderDetailId": 9876543
    },
    {
      "OrderDetailId": 9876544
    }
  ]
}
JSON;

$ch = curl_init('https://out.stockmount.com/api/Integration/GetOrderDetailStatus');
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",
    "OrderDetails": [
        {
            "OrderDetailId": 9876543
        },
        {
            "OrderDetailId": 9876544
        }
    ]
}

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

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

const payload = {
  "ApiCode": "API_CODE",
  "OrderDetails": [
    {
      "OrderDetailId": 9876543
    },
    {
      "OrderDetailId": 9876544
    }
  ]
};

const response = await fetch("https://out.stockmount.com/api/Integration/GetOrderDetailStatus", {
  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": [
    {
      "OrderId": 4567890,
      "OrderDetailId": 9876543,
      "StoreId": 1234,
      "OrderStatus": "Shipped"
    },
    {
      "OrderId": 4567890,
      "OrderDetailId": 9876544,
      "StoreId": 1234,
      "OrderStatus": "Created"
    }
  ]
}

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}}",
  "OrderDetails": [
    {
      "OrderDetailId": 9876543
    },
    {
      "OrderDetailId": 9876544
    }
  ]
}