HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

ADM-ORDER-100 - Initiate a refund for a logistic order

post
https://example.com/v1/logistic-orders//refunds

Initiates a refund process for a given logistic order. The refund will be applied to the payment(s) associated with the order. The logisticOrderId refers to a reference.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
number

Gross refund amount. If absent, full refund.

string

Reason for the refund

Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

Responses
200

Refund successfully initiated.

400

Bad request – invalid parameters or unsupported refund scenario.

  • Refund already requested for this order
  • Unauthorized operation REFUND: no payment found for the logistic order
401

Unauthorized – invalid API key or permissions.

404

Logistic order not found.

409

Refund already in progress or not allowed.

500

Internal server error – refund creation failed unexpectedly.

Updated 4 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 4 months ago