There is a WADL document available that describes the resources API.
You may also enjoy the interactive interface provided for this API by Swagger.
name | path | methods | description |
---|---|---|---|
Customer API |
|
|
Allows to retrieve and update customer information. |
Offer API |
|
|
Allows to retrieve offer-information and add offer-codes. |
Subscription API |
|
|
Allows for retrieval of subscription information. |
type | description |
---|---|
AppliedToPrices | Defines how offers are applied to variants based on their price. |
ArrivalMethod | Arrival method |
ArrivalMethod | Arrival method |
BlockCode | Block Code |
CancellationReason | Cancellation Reason |
CancellationReason | Cancellation Reason |
Category | Customer Category |
Consent | Customer's consent. |
ConsentKey | Consent key (name). |
ConsentValue | Consent value. |
Customer | Customer information. |
Customer | Customer |
CustomerChanges | Contains changes that applies to a customer. |
CustomerResult | Holds a search result of customers. |
Offer | Offer |
OfferCode | OfferCode |
OfferCodes | OfferCodes to add to a specific offer |
OfferResult | Holds a search result of offers. |
OfferType | The type of offer. |
Parameter | A variable condition or value of an offer |
PaymentMethod | Payment method |
PaymentMethod | Payment method |
PreviousDelivery | Previous Delivery information |
Store | A marketplace where the offer is made available |
Subscription | Subscription information. |
Subscription | Subscription information. |
SubscriptionResult | Holds a search result of subscriptions. |
SubscriptionResult | Holds a search result of subscriptions. |