ReturnGroupSerializer V1
Last updated: July 16, 2025
ReturnGroupSerializer
Nom du champ Type Description
id
entier
Identifiant unique pour le groupe de retour.
shop_name
chaîne de caractères
Nom de la boutique associée.
order_platform_id
chaîne de caractères
ID spécifique à la plateforme pour la commande.
order_name
chaîne de caractères
Nom d'affichage pour la commande.
order_created_at
chaîne de caractères
Horodatage de la création de la commande.
order_sales_channel
chaîne de caractères
Canal de vente associé à la commande.
customer_name
chaîne de caractères
Nom du client.
customer_email
chaîne de caractères
Adresse e-mail du client.
country
chaîne de caractères
Pays du client.
shipment_status
chaîne de caractères (optionnel)
Statut de l'expédition.
carrier
chaîne de caractères (optionnel)
Transporteur gérant l'expédition.
tracking_number
chaîne de caractères (optionnel)
Numéro de suivi pour l'expédition.
return_method
chaîne de caractères
Méthode de retour (ex. courrier, en magasin).
credit_method
chaîne de caractères
Méthode de crédit utilisée (ex. remboursement, crédit en magasin).
is_exchange
booléen
Indique si le retour est un échange.
is_instant_exchange
booléen
Indique si l'échange est instantané.
return_subtotal
MoneyBag
Sous-total pour le retour.
return_discounted_subtotal
MoneyBag
Sous-total remisé pour le retour.
return_tax_total
MoneyBag
Total des taxes pour le retour.
return_total
MoneyBag
Montant total pour le retour.
total_refunded
MoneyBag
Montant total remboursé.
gift_card_order_ids
liste de chaînes
Liste des identifiants de commande associés aux cartes-cadeaux.
returns
liste de ReturnSerializer
Liste des articles de retour inclus dans ce groupe.
created_at
chaîne de caractères
Horodatage de la création du groupe de retour (par défaut : 1970-01-01T00:00:00Z).
updated_at
chaîne de caractères
Horodatage de la dernière mise à jour du groupe de retour (par défaut : 1970-01-01T00:00:00Z).
ReturnSerializer
Nom du champ Type Description
id
entier
Identifiant unique pour le retour.
status
chaîne de caractères
Statut du retour. Valeurs possibles :
DEMANDÉ
DEMANDÉ_REUPLOAD
CRÉÉ
ENVOI_EXPÉDIÉ
ÉTIQUETTE_ENVOYÉE
EXPÉDIÉ
Livré
NON_TRACKÉ
TERMINÉ
ANNULÉ
product_platform_id
chaîne de caractères
ID spécifique à la plateforme pour le produit.
product_name
chaîne de caractères
Nom du produit.
variant_platform_id
chaîne de caractères
ID spécifique à la plateforme pour la variante du produit.
variant_name
chaîne de caractères
Nom de la variante du produit.
line_item_platform_id
chaîne de caractères
ID spécifique à la plateforme pour l'article de ligne.
sku
chaîne de caractères (optionnel)
Unité de gestion des stocks pour le produit.
quantity
entier
Quantité de l'article retourné (par défaut : 1).
shipment_status
chaîne de caractères (optionnel)
Statut de l'expédition.
carrier
chaîne de caractères (optionnel)
Transporteur gérant l'expédition.
tracking_number
chaîne de caractères (optionnel)
Numéro de suivi pour l'expédition.
return_reason_path
chaîne de caractères
Chemin vers la raison du retour (par exemple, hiérarchie de catégorie).
return_reason
chaîne de caractères
Raison du retour.
return_note
chaîne de caractères
Notes supplémentaires pour le retour.
return_subtotal
MoneyBag
Sous-total pour le retour.
return_discounted_subtotal
MoneyBag
Sous-total remisé pour le retour.
return_tax_total
MoneyBag
Total des taxes pour le retour.
return_total
MoneyBag
Montant total pour le retour.
created_at
chaîne de caractères
Horodatage de la création du retour (par défaut : 1970-01-01T00:00:00Z).
updated_at
chaîne de caractères
Horodatage de la dernière mise à jour du retour (par défaut : 1970-01-01T00:00:00Z).
MoneyBag
Le type MoneyBag est utilisé pour représenter des montants monétaires dans deux contextes : la devise du magasin et la devise de présentation.
Nom du champ Type Description
shop_money
objet
Contient amount (décimal) et currency_code (chaîne) dans la devise du magasin.
presentment_money
objet
Contient amount (décimal) et currency_code (chaîne) dans la devise de présentation.
Exemple
{
"shop_money": {
"amount": 148.0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 148.0,
"currency_code": "USD"
}
}
Exemple de JSON de groupe de retour
{
"id": 1,
"shop_name": "Exemple Boutique",
"order_platform_id": "ORD123",
"order_name": "#12345",
"order_created_at": "2025-01-01T12:00:00Z",
"order_sales_channel": "En ligne",
"customer_name": "John Doe",
"customer_email": "johndoe@example.com",
"country": "US",
"shipment_status": "Livré",
"carrier": "UPS",
"tracking_number": "1Z999AA10123456784",
"return_method": "Courrier",
"credit_method": "Crédit en magasin",
"is_exchange": true,
"is_instant_exchange": false,
"return_subtotal": {
"shop_money": {
"amount": 100.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 100.00,
"currency_code": "USD"
}
},
"return_discounted_subtotal": {
"shop_money": {
"amount": 90.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 90.00,
"currency_code": "USD"
}
},
"return_tax_total": {
"shop_money": {
"amount": 10.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 10.00,
"currency_code": "USD"
}
},
"return_total": {
"shop_money": {
"amount": 100.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 100.00,
"currency_code": "USD"
}
},
"total_refunded": {
"shop_money": {
"amount": 50.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 50.00,
"currency_code": "USD"
}
},
"gift_card_order_ids": ["GFT123"],
"returns": [
{
"id": 101,
"status": "En attente",
"product_platform_id": "PROD001",
"product_name": "T-Shirt",
"variant_platform_id": "VAR001",
"variant_name": "Grand / Bleu",
"line_item_platform_id": "LINE001",
"sku": "SKU001",
"quantity": 1,
"return_reason_path": "Vêtements > Défectueux",
"return_reason": "Sewure déchirée",
"return_note": "Dommage visible",
"return_subtotal": {
"shop_money": {
"amount": 50.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 50.00,
"currency_code": "USD"
}
},
"return_discounted_subtotal": {
"shop_money": {
"amount": 45.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 45.00,
"currency_code": "USD"
}
},
"return_tax_total": {
"shop_money": {
"amount": 5.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 5.00,
"currency_code": "USD"
}
},
"return_total": {
"shop_money": {
"amount": 50.00,
"currency_code": "USD"
},
"presentment_money": {
"amount": 50.00,
"currency_code": "USD"
}
},
"created_at": "2025-01-01T12:00:00Z",
"updated_at": "2025-01-01T12:30:00Z"
}
],
"created_at": "2025-01-01T12:00:00Z",
"updated_at": "2025-01-01T12:30:00Z"
}