Siirry sisältöön
ShopentlyLearn

Luo · Varastokorjaus — Varastosaldot

Suorita ”Luo · Varastokorjaus” resurssissa ”Varastosaldot” alla kuvatuilla tiedoilla.

POST/api/v1/inventory/stock-adjustments

Todentaminen
Bearer
Saatavilla alkaen
STANDARD
Vaaditut käyttöoikeudet
inventory.stock:update

Koodiesimerkit

Pyyntöesimerkki

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: example-create_adjustment_api_v1_inventory_stock_adjustments_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 0,
  "locations": [
    {
      "location_id": "example",
      "on_hand": 1
    }
  ],
  "reason": "Example",
  "target_id": "example",
  "target_type": "product",
  "warehouse_id": "example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/inventory/stock-adjustments

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = ['Idempotency-Key: example-create_adjustment_api_v1_inventory_stock_adjustments_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/inventory/stock-adjustments');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
  "expected_version": 0,
  "locations": [
    {
      "location_id": "example",
      "on_hand": 1
    }
  ],
  "reason": "Example",
  "target_id": "example",
  "target_type": "product",
  "warehouse_id": "example"
}');
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {'Idempotency-Key': 'example-create_adjustment_api_v1_inventory_stock_adjustments_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 0,\n  "locations": [\n    {\n      "location_id": "example",\n      "on_hand": 1\n    }\n  ],\n  "reason": "Example",\n  "target_id": "example",\n  "target_type": "product",\n  "warehouse_id": "example"\n}'
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'POST', base_url + '/api/v1/inventory/stock-adjustments', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Vastausesimerkki 201

JSON
{
  "data": {
    "deleted": false,
    "id": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ",
    "version": 1
  },
  "meta": {
    "request_id": "example"
  }
}

Periaatteet

  • Varastotietueet erottavat fyysisen on_hand-määrän, tilausvaraukset, manuaaliset varaukset ja myyntiin käytettävissä olevan määrän.
  • Käytä palautettua varastotietueen tunnistetta ja versiota.
  • Tuotteen ja variantin saldot ovat erillisiä kohteita.
  • sellable_limit-arvo -1 tarkoittaa rajatonta määrää, kun taas 0 tarkoittaa, ettei myytävää määrää ole saatavilla.
  • Rajaton saatavuus esitetään available-kentän null-arvona.
  • Älä käsittele null-arvoa nollana.
  • Varastosaldon oikaisut, myyntirajat ja manuaaliset varaukset käyttävät erillisiä toimintoja ja oikeuksia.

Parametrit

Pyynnön otsakkeet

Idempotency-KeyMerkkijonoPakollinen

Yhden loogisen kirjoitustoiminnon yksilöllinen tunniste.

minLength: 1maxLength: 128
Rajoitukset
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Esimerkki: "example-create_adjustment_api_v1_inventory_stock_adjustments_post"

Pyynnön sisältö

application/json · Pakollinen

StockAdjustmentCreate
expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 0maximum: 9223372036854775807
Esimerkki: 0
locationsTaulukko <LocationQuantity > Pakollinen

Varastosijainnit.

minItems: 1maxItems: 100
Esimerkki: [{"location_id":"example","on_hand":1}]
reasonMerkkijonoPakollinen

Muutokselle kirjattu syy.

minLength: 1maxLength: 500
Esimerkki: "Example"
target_idMerkkijonoPakollinen

Toiminnon kohteena olevan tuotteen tai variantin tunniste.

Rajoitukset
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Esimerkki: "example"
target_typeMerkkijonoPakollinen

Koskeeko toiminto tuotetta vai varianttia.

Rajoitukset
enum
["product", "variant"]
Esimerkki: "product"
warehouse_idMerkkijonoPakollinen

Varaston tunniste.

Rajoitukset
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Esimerkki: "example"

Vastaukset

Vastaus 200

dataMutationData Pakollinen

Onnistuneen vastauksen sisältö.

Kentät · data
deletedTotuusarvoPakollinen

Toteutettiinko poisto.

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

versionKokonaisluku nullPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen

Vastauksen metatiedot.

Kentät · meta

ContextPageMeta

localeMerkkijonoPakollinen

Tälle pyynnölle valittu kieli.

market_codeMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinakoodi.

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

ContextMeta

localeMerkkijonoPakollinen

Tälle pyynnölle valittu kieli.

market_codeMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinakoodi.

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

PageMeta

paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

RequestMeta

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

Vastaus 201

dataMutationData Pakollinen

Onnistuneen vastauksen sisältö.

Kentät · data
deletedTotuusarvoPakollinen

Toteutettiinko poisto.

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

versionKokonaisluku nullPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen

Vastauksen metatiedot.

Kentät · meta

ContextPageMeta

localeMerkkijonoPakollinen

Tälle pyynnölle valittu kieli.

market_codeMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinakoodi.

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

ContextMeta

localeMerkkijonoPakollinen

Tälle pyynnölle valittu kieli.

market_codeMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinakoodi.

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

PageMeta

paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

RequestMeta

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100
Vastausesimerkki

HTTP-tilakoodi

200
Onnistunut vastaus Skeema
201
Resurssi luotu Skeema
400
Virheellinen pyyntö
401
Tunnistautuminen vaaditaan
403
Pääsy estetty
404
Resurssia ei löydy
409
Versioristiriita
422
Validointi epäonnistui
429
Pyyntöraja ylitetty
Muut HTTP-tilat (7)
405
Menetelmä ei ole sallittu
413
Pyyntö on liian suuri
415
Muotoa ei tueta
500
Palvelinvirhe
502
API-yhdyskäytävän virhe
503
Palvelu ei ole käytettävissä
504
Aikakatkaisu

Virheluettelo: ErrorResponse

Otsakkeet

201

LocationMerkkijonoValinnainen

Luodun resurssin suhteellinen URL-osoite.

401

WWW-AuthenticateMerkkijonoValinnainen

Palvelimen vaatima todentamismenetelmä.

405

AllowMerkkijonoValinnainen

Tämän resurssin tukemat HTTP-metodit.

429, 503

Retry-AfterKokonaislukuValinnainen

Vähimmäisviive ennen uudelleenyritystä sekunteina.

minimum: 0