Aller au contenu
ShopentlyLearn

Schémas de données: Marques

Schémas de données: Marques. Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Schémas de données

Obtenir — Marques — Réponse

ApiResponse_BrandData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.
dataBrandData Obligatoire

Exemple de réponse · BrandData.

Exemple: {"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 Obligatoire

Métadonnées de la réponse.

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

Champs supplémentaires: Non

Lister — Marques — Réponse

ApiResponse_list_BrandData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.
dataTableau <BrandData > Obligatoire

Exemple de réponse · ApiResponse_list_BrandData__.

Exemple: [{"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 Obligatoire

Métadonnées de la réponse.

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

Champs supplémentaires: Non

Créer — Marques — Corps de la requête

BrandCreate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.
nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160
Exemple: "Example"

Champs supplémentaires: Non

Obtenir — Marques — Réponse

BrandData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.
created_atChaîneObligatoire

Date et heure de création.

format: "date-time"
Exemple: "2026-01-01T12:00:00Z"
idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (BrandData).

Exemple: "example"
nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Example"
numberChaîneObligatoire

Numéro de commande ou de demande visible par l'utilisateur.

Exemple: "example"
updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"
Exemple: "2026-01-01T12:00:00Z"
versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

Modifier — Marques — Corps de la requête

BrandUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.
expected_versionEntierObligatoire

Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807
Exemple: 1
nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

minLength: 1maxLength: 160
Exemple: "Example"

Champs supplémentaires: Non