Schémas de données: Retours, réclamations et échanges

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

Schémas de données

Lister — Retours, réclamations et échanges — Réponse

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

dataTableau <RequestSummaryData > Obligatoire: Exemple de réponse · ApiResponse_list_RequestSummaryData__.

Exemple: [{"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Champs supplémentaires: Non

Obtenir — Retours, réclamations et échanges — Réponse

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

dataRequestDetailData Obligatoire: Exemple de réponse · RequestDetailData.

Exemple: {"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","items":[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}],"number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example"}

Champs supplémentaires: Non

Modifier · Montant du remboursement — Retours, réclamations et échanges — Corps de la requête

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

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

minLength: 1maxLength: 64

Contraintes

pattern: "^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"

Exemple: "0.00"

expected_versionEntierObligatoire

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

minimum: 0maximum: 9223372036854775807

Exemple: 1

reasonChaîneFacultatif

Motif enregistré pour la modification.

maxLength: 500

Valeur par défaut: ""

Champs supplémentaires: Non

Informations de remboursement enregistrées

RefundData · Schéma · Schémas de données: Retours, réclamations et échanges

amountMoneyData nullObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atChaîne nullObligatoire

Date et heure de fin.

Chaîne:format: "date-time"

Exemple: null

statusChaîneObligatoire

Statut accepté par cette opération précise.

Contraintes

enum: ["pending", "completed"]

Exemple: "pending"

updated_atChaîne nullObligatoire

Date et heure de la dernière modification.

Chaîne: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

Obtenir — Retours, réclamations et échanges — Réponse

RequestDetailData · 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"

customerRequestCustomerData Obligatoire

Données du client enregistrées pour cette ressource.

Exemple: {"email":"customer@example.invalid","name":"Example"}

idChaîneObligatoire

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

Exemple: "example"

itemsTableau <RequestItemData > Obligatoire

Éléments inclus dans la ressource.

Exemple:

[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}]

numberChaîneObligatoire

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

Exemple: "example"

order_idChaîneObligatoire

Identifiant de la commande associée.

Exemple: "example"

order_numberChaîneObligatoire

Numéro de la commande associée.

Exemple: "example"

products_valueMoneyData Obligatoire

Valeur des produits de la commande.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obligatoire

Informations de remboursement enregistrées.

Exemple:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateChaîneObligatoire

État de résolution d'une demande client.

Contraintes

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

Exemple: "unknown"

statusRequestStatusData Obligatoire

Statut accepté par cette opération précise.

Exemple: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obligatoire

Type de ressource.

Exemple: "return"

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

Obtenir — Retours, réclamations et échanges — Réponse

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

idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (RequestItemData).

Exemple: "example"
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"
order_line_idChaîne nullObligatoire: Identifiant de la ligne de commande associée.

Exemple: "example"
product_idChaîneObligatoire: Identifiant du produit.

Exemple: "example"
quantityEntierObligatoire: Nombre d'unités.

Exemple: 1
returned_quantityEntierObligatoire: Quantité retournée pour cette ligne.

Exemple: 1
skuChaîneObligatoire: Code de l'unité de gestion des stocks.

Exemple: "example"
totalMoneyData Obligatoire: Montant total.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligatoire: Prix unitaire.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idChaîne nullObligatoire: Identifiant de la variante du produit.

Exemple: "example"
variant_optionsTableau <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obligatoire: Options de variante associées au produit ou à l'instantané enregistré.

Exemple: [{"name":"Example","value":"example"}]

Champs supplémentaires: Non

Statut accepté par cette opération précise

RequestStatusData · Schéma · Schémas de données: Retours, réclamations et échanges

idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (RequestStatusData).

Exemple: "example"
localeChaîneObligatoire: Langue sélectionnée pour cette requête.

Exemple: "en"
nameChaîne nullObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"

Champs supplémentaires: Non

Lister · Statuts — Retours, réclamations et échanges — Réponse

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

codeChaîneObligatoire: Code stable lisible par une machine.

Exemple: "example"
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. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Exemple: "example"
is_initialBooléenObligatoire: Indique s'il s'agit du statut initial.

Exemple: false
localeChaîneObligatoire: Langue sélectionnée pour cette requête.

Exemple: "en"
nameChaîne nullObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"
positionEntierObligatoire: Position dans la collection ordonnée.

Exemple: 1
typeRequestType Obligatoire: Type de ressource.

Exemple: "return"

Champs supplémentaires: Non

Lister · Statuts — Retours, réclamations et échanges — Réponse

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

dataTableau <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obligatoire: Exemple de réponse · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Exemple: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"locale":"en","name":"Example","position":1,"type":"return"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Champs supplémentaires: Non

Modifier · Statut — Retours, réclamations et échanges — Corps de la requête

RequestStatusUpdate · 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

status_idChaîneObligatoire

Identifiant obtenu dans le répertoire de statuts correspondant.

Contraintes

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

Exemple: "example"

Champs supplémentaires: Non

Lister — Retours, réclamations et échanges — Réponse

RequestSummaryData · 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"

customerRequestCustomerData Obligatoire

Données du client enregistrées pour cette ressource.

Exemple: {"email":"customer@example.invalid","name":"Example"}

idChaîneObligatoire

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

Exemple: "example"

numberChaîneObligatoire

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

Exemple: "example"

order_idChaîneObligatoire

Identifiant de la commande associée.

Exemple: "example"

order_numberChaîneObligatoire

Numéro de la commande associée.

Exemple: "example"

products_valueMoneyData Obligatoire

Valeur des produits de la commande.

Exemple: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obligatoire

Informations de remboursement enregistrées.

Exemple:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateChaîneObligatoire

État de résolution d'une demande client.

Contraintes

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

Exemple: "unknown"

statusRequestStatusData Obligatoire

Statut accepté par cette opération précise.

Exemple: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obligatoire

Type de ressource.

Exemple: "return"

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

Type de ressource

RequestType · Schéma · Schémas de données: Retours, réclamations et échanges

Chaîne

Contraintes

enum: ["return", "exchange", "complaint"]

Champs supplémentaires: Oui

Options de variante associées au produit ou à l'instantané enregistré

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schéma · Schémas de données: Retours, réclamations et échanges

nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"
valueChaîneObligatoire: Valeur décrite par le schéma environnant.

Exemple: "example"

Champs supplémentaires: Non