Order

Partial update of order

Only the properties supplied are updated; omitted properties are left unchanged. An externalId may only be held by one order. Supplying one that is already set on a different order returns 409 Conflict and leaves the order untouched.

PATCH/API/Order/{id}

Request Example

curl -X PATCH 'https://mgmtapi.geins.io/API/Order/{id}' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic [USER-CREDENTIALS-BASE64-ENCODED]' \
-H 'X-ApiKey: {MGMT_API_KEY}'\
-d '{
  "ExternalId": "string",
  "ParcelNumber": "string",
  "ExternalOrderStatus": 0,
  "ReturnParcelNumber": "string",
  "GoodsLabel": "string",
  "CustomerOrderNumber": "string"
}'

import axios from 'axios';

const config = {
  method: 'PATCH',
  url: 'https://mgmtapi.geins.io/API/Order/{id}',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
    'X-ApiKey': '{MGMT_API_KEY}'
  },
  data: {
  "ExternalId": "string",
  "ParcelNumber": "string",
  "ExternalOrderStatus": 0,
  "ReturnParcelNumber": "string",
  "GoodsLabel": "string",
  "CustomerOrderNumber": "string"
}
};

axios.request(config)
  .then(response => response.data)
  .catch(error => console.error(error));

fetch('https://mgmtapi.geins.io/API/Order/{id}', {
  method: 'PATCH',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
    'X-ApiKey': '{MGMT_API_KEY}'
  },
  body: JSON.stringify({
  "ExternalId": "string",
  "ParcelNumber": "string",
  "ExternalOrderStatus": 0,
  "ReturnParcelNumber": "string",
  "GoodsLabel": "string",
  "CustomerOrderNumber": "string"
})
})
.then(res => res.json())
.then((response) => response)
.catch(console.error);

import requests

url = "https://mgmtapi.geins.io/API/Order/{id}"

headers = {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
    'X-ApiKey': '{MGMT_API_KEY}'
}

payload = {
  "ExternalId": "string",
  "ParcelNumber": "string",
  "ExternalOrderStatus": 0,
  "ReturnParcelNumber": "string",
  "GoodsLabel": "string",
  "CustomerOrderNumber": "string"
}
response = requests.PATCH(url, json=payload, headers=headers)

print(response.json())

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://mgmtapi.geins.io/API/Order/{id}"
  payload := []byte(`{
  "ExternalId": "string",
  "ParcelNumber": "string",
  "ExternalOrderStatus": 0,
  "ReturnParcelNumber": "string",
  "GoodsLabel": "string",
  "CustomerOrderNumber": "string"
}`)

  req, _ := http.NewRequest("PATCH", url, bytes.NewBuffer(payload))

  req.Header.Add("Accept", "application/json")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Basic [USER-CREDENTIALS-BASE64-ENCODED]")
  req.Header.Add("X-ApiKey", "{MGMT_API_KEY}")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

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

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Basic [USER-CREDENTIALS-BASE64-ENCODED]");
client.DefaultRequestHeaders.Add("X-ApiKey", "{MGMT_API_KEY}");

var body = new
{
    ExternalId = "string",
    ParcelNumber = "string",
    ExternalOrderStatus = 0,
    ReturnParcelNumber = "string",
    GoodsLabel = "string",
    CustomerOrderNumber = "string"
};
var jsonContent = JsonSerializer.Serialize(body);
var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
var response = await client.PATCHAsync("https://mgmtapi.geins.io/API/Order/{id}", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

Response

{}

{}

"string"

Query orders (paged)

The default page size is 1000. Paging is optimized for performance but may exhibit non-deterministic behavior—items can be duplicated or skipped across pages if the underlying data changes between requests. When fetching page 2 or higher, a BatchId must be included in the query object. This BatchId is provided in the response from page 1. Once a BatchId is supplied, the original order query filters are automatically reused, so it is not necessary to include them again.

Get order statuses

Get a list of available order statuses.