API : remboursements

GET /orders/{token}/refunds

Cette méthode retourne tous les remboursements pour une commande spécifique.

URL de la ressource

GET https://app.snipcart.com/api/v1/orders/{token}/refunds

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.

Paramètres

Nom	Obligatoire?	Type	Description
token	Oui	Guid	L'identifiant unique de la commande.

Exemple de requête

curl -H "Accept: application/json" \
    https://app.snipcart.com/api/v1/orders/4243490d-87c1-480e-b413-51db0b419313/refunds \
    -u {API_KEY}:

Exemple de réponse

[
    {
        "id": "2223490d-84c1-480c-b713-50cb0b819313",
        "amount": 300.00,
        "comment": "A comment",
        "refundedByPaymentGateway: true
    },
    ...
]

GET /orders/{token}/refunds/{id}

Cette méthode retourne un remboursement particulier.

URL de la ressource

GET https://app.snipcart.com/api/v1/orders/{token}/refunds/{id}

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.

Paramètres

Nom	Obligatoire?	Type	Description
token	Oui	Guid	L'identifiant unique de la commande.
id	Oui	Guid	L'identifiant unique du remboursement.

Exemple de requête

curl -H "Accept: application/json" \
    https://app.snipcart.com/api/v1/orders/4243490d-87c1-480e-b413-51db0b419313/refunds/2223490d-84c1-480c-b713-50cb0b819313 \
    -u {API_KEY}:

Exemple de réponse

{
    "id": "2223490d-84c1-480c-b713-50cb0b819313",
    "amount": 300.00,
    "comment": "A comment",
    "refundedByPaymentGateway: true
}

POST /orders/{token}/refunds

Cette méthode permet de créer un nouveau rabais.

URL de la ressource

POST https://app.snipcart.com/api/v1/orders/{token}/refunds

En-têtes

Nom	Valeur	Obligatoire?	Description
Accept	application/json	Oui	Notre API n'accepte que le type de contenu application/json, vous devez donc toujours spécifier l'en-tête Accept: application/json dans chaque requête que vous effectuez.
Content-Type	application/json	Oui	Le corps de la requête doit être JSON, nous spécifions donc le type de contenu.

Paramètres

Nom	Obligatoire?	Type	Description
token	Oui	Guid	L'identifiant unique de la commande.
amount	Oui	decimal	Le montant du remboursement.
comment	Non	string	La raison du remboursement.

Exemple de requête

curlhttps://app.snipcart.com/api/v1/orders/4243490d-87c1-480e-b413-51db0b419313/refunds \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -u {YOUR_API_KEY}: \
  -d "{ amount: 200.50,
        comment: 'Reason for refund'
      }"

Exemple de réponse

{
    "id": "2573490e-81d2-110c-b713-51ab0d823513",
    "amount": 200.50,
    "comment": "Reason for refund",
    "refundedByPaymentGateway: true
}