API reference · General and lookups

List shipment companies

Returns the shipment companies accepted by the marketplaces, with their codes.

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

When you send shipment information (SetOrderShipmentInformation), put the Code value from this list in the ShipmentCompany field.

If you send IntegrationId, only that integration's companies are returned. If omitted or 0, companies of all integrations are returned; that list is long.

The list contains the integration's general companies plus companies defined only for your stores. It is sorted by Name. There is no paging.

Request fields

Field	Type	Description
`ApiCode` required	string	Session code returned by `DoLogin`.
`IntegrationId`	integer	Optional. ID of the integration whose shipment companies you want (`IntegrationId` from `GetStores`). If omitted or 0, all are returned.

Response fields (Response)

Field	Type	Description
`IntegrationShipmentId`	integer	StockMount ID of the shipment company entry.
`IntegrationId`	integer	ID of the integration the company belongs to.
`Code`	string	Shipment company code on the marketplace. Send it as `ShipmentCompany` in `SetOrderShipmentInformation`.
`Name`	string	Shipment company name.
`ShortName`	string	Short name. Can be empty.

Error codes for this endpoint

Code	When
`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",
  "IntegrationId": 2
}

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

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

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

var response = await http.PostAsync(
    "https://out.stockmount.com/api/Integration/GetIntegrationShipmentCompanies",
    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",
  "IntegrationId": 2
}
JSON;

$ch = curl_init('https://out.stockmount.com/api/Integration/GetIntegrationShipmentCompanies');
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",
    "IntegrationId": 2
}

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

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

const payload = {
  "ApiCode": "API_CODE",
  "IntegrationId": 2
};

const response = await fetch("https://out.stockmount.com/api/Integration/GetIntegrationShipmentCompanies", {
  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": [
    {
      "IntegrationShipmentId": 57,
      "IntegrationId": 2,
      "Code": "345",
      "Name": "Aras Kargo",
      "ShortName": "Aras"
    },
    {
      "IntegrationShipmentId": 61,
      "IntegrationId": 2,
      "Code": "349",
      "Name": "Yurtiçi Kargo",
      "ShortName": "Yurtiçi"
    }
  ]
}

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}}",
  "IntegrationId": 2
}