Hoppa till innehållet
ShopentlyLearn

Datascheman: Varumärken

Datascheman: Varumärken. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Hämta — Varumärken — Svar

ApiResponse_BrandData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataBrandData Obligatoriskt

Exempel på svar · BrandData.

Exempel: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt

Metadata för svaret.

Exempel: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ytterligare fält: Nej

Lista — Varumärken — Svar

ApiResponse_list_BrandData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataArray <BrandData > Obligatoriskt

Exempel på svar · ApiResponse_list_BrandData__.

Exempel: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt

Metadata för svaret.

Exempel: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ytterligare fält: Nej

Skapa — Varumärken — Begärans innehåll

BrandCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160
Exempel: "Example"

Ytterligare fält: Nej

Hämta — Varumärken — Svar

BrandData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (BrandData).

Exempel: "example"
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera — Varumärken — Begärans innehåll

BrandUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807
Exempel: 1
nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160
Exempel: "Example"

Ytterligare fält: Nej