command

Request Return

Command sent by a customer to return one or more items from a delivered order.

Command
POST/returns

Overview

RequestReturn is handled by the Returns APIReturns APIServicev1.0.0Public API customers use to start a return. Validates the request against the original order and records it. Publishesreturn-requestedSubscribesrequest-returnOwnerfulfilment-platformMapRepoView docs. If the order is within the returns window the request is recorded and Return RequestedReturn RequestedEventv1.0.0Published when a customer has requested to return items from an order. Ownerfulfilment-platformSchemaMapView docs is published.

Architecture diagram

Schema

Event-driven architecture documentation: Acme Inc

JSON Schema

7 properties

Request to return items from a delivered order

orderIdstring<uuid>
required
customerIdstring<uuid>
required
itemsarray[object]
required
reasonstring
required
Allowed values: damaged wrong_item not_as_described no_longer_needed other
commentstring