Rapid Flyer logo
API docs by Redocly

Rapid Flyer Shop API (1.1.0)

Download OpenAPI specification:Download

E-mail: contact@rapid-flyer.com License: MIT

Rapid Flyer Shop API documentation

users

All actions related to user functionality.

Registering a new user

This creates a new user that can log in the shop

Request Body schema: application/json
email
string
plainPassword
string
firstName
string
lastName
string
channel
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com",
  • "plainPassword": "test12334verysecure",
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "channel": "RF"
}

Logs the user in and returns the token

This route is needed to log the user in and get an access token.

Request Body schema: application/json
email
required
string
password
required
string
token
string

The token of the current cart which should be assign to the customer

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com",
  • "password": "test12334verysecure",
  • "token": "SDAOSLEFNWU35H3QLI5325"
}

Response samples

Content type
application/json
{
  • "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9"
}

Verify an account by verification token

This route is needed to verify an user.

query Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Request resetting password of user with passed email.

Email with reset password path will be sent to user. Path for password resetting is /password-reset/{token}.

Request Body schema: application/json
email
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com"
}

Password reset.

This endpoint resets the user password.

path Parameters
token
required
string

Password reset token.

Request Body schema: application/json
object (PasswordReset)

Responses

Request samples

Content type
application/json
{
  • "password": {
    }
}

Provides currently logged in user details.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "email": "sherlock@holmes.com",
  • "birthday": "2017-08-12",
  • "gender": "m",
  • "phoneNumber": "+490000000000",
  • "subscribedToNewsletter": false
}

Updates currently logged in users details.

Authorizations:
bearerAuth
Request Body schema: application/json
firstName
string
lastName
string
email
string
birthday
string
gender
string
phoneNumber
string
subscribedToNewsletter
integer

Responses

Request samples

Content type
application/json
{
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "email": "sherlock@holmes.com",
  • "birthday": "2017-08-12",
  • "gender": "f",
  • "phoneNumber": "+490000000000",
  • "subscribedToNewsletter": 0
}

Response samples

Content type
application/json
{
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "email": "sherlock@holmes.com",
  • "birthday": "2017-08-12",
  • "gender": "m",
  • "phoneNumber": "+490000000000",
  • "subscribedToNewsletter": false
}

Updates the password of the user that is currently logged in.

Request Body schema: application/json
currentPassword
string
object (PasswordReset)

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "current-user-password",
  • "newPassword": {
    }
}

address

All functions related to the Rapid-Flyer Customer Address Book

Gets the address book of the currently logged in user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new address in the the address book

Authorizations:
bearerAuth
Request Body schema: application/json
id
integer
firstName
string
lastName
string
countryCode
string
street
string
city
string
postcode
string
provinceName
string
provinceCode
string
company
string
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Updates an address in the address book

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id of the address to update

Request Body schema: application/json
id
integer
firstName
string
lastName
string
countryCode
string
street
string
city
string
postcode
string
provinceName
string
provinceCode
string
company
string
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Deletes an address from the address book

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id of the address to update

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Change the default address in the address book

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id of the address to be the default address

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

products

Show product catalog.

Show product catalog.

This endpoint will return a paginated list of products for given taxon.

path Parameters
taxonSlug
required
string

Slug of taxonomy for which products should be listed.

query Parameters
locale
string

Locale in which products should be shown.

limit
integer

Number of expected products per page.

page
integer

Page number.

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "limit": 10,
  • "pages": 3,
  • "total": 25,
  • "_links": {
    },
  • "items": [
    ]
}

Show product catalog.

This endpoint will return a paginated list of products for given taxon.

path Parameters
taxonCode
required
string

Code of taxonomy for which products should be listed.

query Parameters
locale
string

Locale in which products should be shown.

limit
integer

Number of expected products per page.

page
integer

Page number.

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "limit": 10,
  • "pages": 3,
  • "total": 25,
  • "_links": {
    },
  • "items": [
    ]
}

Show all the available format for the products which have a pattern

This endpoint will return all the distinct format for each product if they have at least one variant with a pattern

Responses

Response samples

Content type
application/json
{
  • "code": "AFF",
  • "name": "Affiche",
  • "availableFormat": {
    }
}

Show a product with the given slug.

This endpoint will return a product with the given slug.

path Parameters
slug
required
string

Slug of expected product.

query Parameters
locale
string

Locale in which products should be shown.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "variants": {
    },
  • "attributes": [
    ],
  • "associations": {
    },
  • "images": [
    ],
  • "uploadableFiles": 0,
  • "advice": "string",
  • "availableService": {
    },
  • "code": "LOGAN_MUG_CODE",
  • "averageRating": "1.8",
  • "name": "Logan Mug",
  • "slug": "logan-mug",
  • "description": "A very nice mug that you can drink from or use to store beverages in.",
  • "shortDescription": "A mug.",
  • "metaKeywords": "mug drink logan",
  • "metaDescription": "Some meta description",
  • "taxons": {
    },
  • "breadcrumb": "categories/mugs/logan-mug"
}

Show a product with the given code.

This endpoint will return a product with the given code.

path Parameters
code
required
string

Code of expected product.

query Parameters
locale
string

Locale in which products should be shown.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "variants": {
    },
  • "attributes": [
    ],
  • "associations": {
    },
  • "images": [
    ],
  • "uploadableFiles": 0,
  • "advice": "string",
  • "availableService": {
    },
  • "code": "LOGAN_MUG_CODE",
  • "averageRating": "1.8",
  • "name": "Logan Mug",
  • "slug": "logan-mug",
  • "description": "A very nice mug that you can drink from or use to store beverages in.",
  • "shortDescription": "A mug.",
  • "metaKeywords": "mug drink logan",
  • "metaDescription": "Some meta description",
  • "taxons": {
    },
  • "breadcrumb": "categories/mugs/logan-mug"
}

Show information of product for quotation creation

path Parameters
slug
required
string

The slug of the product

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "code": "AFF",
  • "name": "Affiche",
  • "options": [
    ]
}

Show latest products.

This endpoint will return an array of latest products.

query Parameters
locale
string

Locale in which products should be shown.

limit
integer

Number of expected products per page.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

cart

All actions related to cart management.

Pick up your cart from the store

This endpoint will allow you to create a new cart.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Show summarized cart.

This endpoint shows you the current calculated state of cart.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Drop your cart.

This endpoint will remove the cart and all of the related cart items.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Add an item to your cart.

This endpoint will allow you to add a new item to your cart.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json

Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional variant_code or options field, but never both.

productCode
required
string
quantity
integer >= 1
Default: 1
variantCode
string
object

Keys reference to the code of an option and values to the code of option value.

Responses

Request samples

Content type
application/json
{
  • "productCode": "LOGAN_HAT_CODE",
  • "quantity": 3,
  • "variantCode": "SMALL_LOGAN_T_SHIRT_CODE",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Merge multiple carts

Merge carts in body to the one in the url

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json

List of the cart's token needed to be merged

carts
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "carts": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Add multiple items to your cart.

This endpoint will allow you to add a new item to your cart.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json

Description of items. The same rules applied to each of the array values as to the previous point.

Array of objects (PutItemToCartRequest)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Download the pdf of the cart.

this endpoint will allow a user to download the pdf of the cart.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Change quantity of a cart item.

path Parameters
token
required
string

Cart identifier.

identifier
required
string

Identifier of a specific item. Can be found in the cart summary.

Request Body schema: application/json
quantity
required
integer

Responses

Request samples

Content type
application/json
{
  • "quantity": 2
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Remove cart item.

This endpoint will remove one item from your cart

path Parameters
token
required
string

Cart identifier.

identifier
required
string

Identifier of a specific item. Can be found in the cart summary.

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Upload file(s) to a cart item.

path Parameters
token
required
string

Cart identifier.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

Request Body schema: multipart/form-data
files[]
string <binary>

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Download a cart item file.

path Parameters
token
required
string

Cart identifier.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

identifier
required
string

Identifier of a specific file item. Can be found in the cart summary.

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "*** has not been found"
}

Delete a cart item file.

path Parameters
token
required
string

Cart identifier.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

identifier
required
string

Identifier of a specific file item. Can be found in the cart summary.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Estimates the shipping cost of the cart

path Parameters
token
required
string

Cart identifier.

query Parameters
countryCode
required
string

Shipping Country

provinceCode
required
string

Province to ship to

Responses

Response samples

Content type
application/json
{
  • "price": {
    }
}

Add a promotion coupon code to the cart.

This endpoint will allow you to add a promotion coupon code to the cart and receive the discount.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
coupon
required
string

Responses

Request samples

Content type
application/json
{
  • "coupon": "BANANAS"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Remove a promotion coupon code from the cart.

This endpoint will allow you to remove a promotion coupon code from the cart.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
coupon
required
string

Responses

Request samples

Content type
application/json
{
  • "coupon": "BANANAS"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Validate cart item files.

path Parameters
id
required
string

Identifier of a specific order. Can be found in the cart summary.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "*** has not been found"
}

checkout

All actions related to checkout fulfillment. It is important, to execute them in given order (address, choose shipment, choose payment and complete).

Show checkout summary

This endpoint will show the summarized cart during checkout. This action is an equivalent of cart summarize action.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Address cart.

This endpoint will allow you to add billing and shipping addresses to the cart and begin the checkout process. You can either define the same shipping and billing address or specify them separately.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
required
object (Address)
object (Address)

Responses

Request samples

Content type
application/json
{
  • "shippingAddress": {
    },
  • "billingAddress": {
    }
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Get available shipping methods.

This endpoint will show you available shipping methods for all cart shipments.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "shipments": [
    ]
}

Choosing a cart shipping method.

This endpoint will allow you to choose a cart shipping method.

path Parameters
token
required
string

Cart identifier.

id
required
string

Order number of shipment for which shipping method should be specified.

Request Body schema: application/json
method
required
string

Code of chosen shipping method.

Responses

Request samples

Content type
application/json
{
  • "method": "DHL"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Completing checkout.

This endpoint will allow you to complete the checkout.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
email
required
string

Email of a customer.

notes
string

Additional notes.

Responses

Request samples

Content type
application/json
{
  • "email": "customer@example.com",
  • "notes": "I'm only available between 3 and 8 PM."
}

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "checkoutCompletedAt": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "invoices": [
    ]
}

Get payment instruction.

This endpoint will allow you to get the link of the bank for paid.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{}

Get available payment methods for the current order

This endpoint will show you available payment methods for all cart payments.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ]
}

Choosing payment method for the current order

This endpoint will allow you to choose order a payment method.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

id
required
string

Order number of payment for which payment method should be specified.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Request Body schema: application/json
method
required
string

Code of chosen payment method.

Responses

Request samples

Content type
application/json
{
  • "method": "PBC"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

order

Showing the order information

Shows a list of orders of the customer

Authorizations:
bearerAuth
header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "count": 2
}

Shows details of specific customer's order

Authorizations:
bearerAuth
path Parameters
tokenValue
required
string

Order token.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "checkoutCompletedAt": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "invoices": [
    ]
}

Get available payment methods for the current order

This endpoint will show you available payment methods for all cart payments.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ]
}

Choosing payment method for the current order

This endpoint will allow you to choose order a payment method.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

id
required
string

Order number of payment for which payment method should be specified.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Request Body schema: application/json
method
required
string

Code of chosen payment method.

Responses

Request samples

Content type
application/json
{
  • "method": "PBC"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

users

All actions related to user functionality.

Registering a new user

This creates a new user that can log in the shop

Request Body schema: application/json
email
string
plainPassword
string
firstName
string
lastName
string
channel
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com",
  • "plainPassword": "test12334verysecure",
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "channel": "RF"
}

Logs the user in and returns the token

This route is needed to log the user in and get an access token.

Request Body schema: application/json
email
required
string
password
required
string
token
string

The token of the current cart which should be assign to the customer

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com",
  • "password": "test12334verysecure",
  • "token": "SDAOSLEFNWU35H3QLI5325"
}

Response samples

Content type
application/json
{
  • "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9"
}

Verify an account by verification token

This route is needed to verify an user.

query Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Request resetting password of user with passed email.

Email with reset password path will be sent to user. Path for password resetting is /password-reset/{token}.

Request Body schema: application/json
email
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com"
}

Password reset.

This endpoint resets the user password.

path Parameters
token
required
string

Password reset token.

Request Body schema: application/json
object (PasswordReset)

Responses

Request samples

Content type
application/json
{
  • "password": {
    }
}

Provides currently logged in user details.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "email": "sherlock@holmes.com",
  • "birthday": "2017-08-12",
  • "gender": "m",
  • "phoneNumber": "+490000000000",
  • "subscribedToNewsletter": false
}

Updates currently logged in users details.

Authorizations:
bearerAuth
Request Body schema: application/json
firstName
string
lastName
string
email
string
birthday
string
gender
string
phoneNumber
string
subscribedToNewsletter
integer

Responses

Request samples

Content type
application/json
{
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "email": "sherlock@holmes.com",
  • "birthday": "2017-08-12",
  • "gender": "f",
  • "phoneNumber": "+490000000000",
  • "subscribedToNewsletter": 0
}

Response samples

Content type
application/json
{
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "email": "sherlock@holmes.com",
  • "birthday": "2017-08-12",
  • "gender": "m",
  • "phoneNumber": "+490000000000",
  • "subscribedToNewsletter": false
}

Updates the password of the user that is currently logged in.

Request Body schema: application/json
currentPassword
string
object (PasswordReset)

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "current-user-password",
  • "newPassword": {
    }
}

address

All functions related to the Rapid-Flyer Customer Address Book

Gets the address book of the currently logged in user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new address in the the address book

Authorizations:
bearerAuth
Request Body schema: application/json
id
integer
firstName
string
lastName
string
countryCode
string
street
string
city
string
postcode
string
provinceName
string
provinceCode
string
company
string
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Updates an address in the address book

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id of the address to update

Request Body schema: application/json
id
integer
firstName
string
lastName
string
countryCode
string
street
string
city
string
postcode
string
provinceName
string
provinceCode
string
company
string
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "firstName": "Sherlock",
  • "lastName": "Holmes",
  • "countryCode": "GB",
  • "street": "Baker Street 221b",
  • "city": "London",
  • "postcode": "NW1",
  • "provinceName": "Greater London",
  • "provinceCode": "GB_gl",
  • "company": "Holmes Investigation Service",
  • "phoneNumber": "+490000000000"
}

Deletes an address from the address book

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id of the address to update

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Change the default address in the address book

Authorizations:
bearerAuth
path Parameters
id
required
integer

Id of the address to be the default address

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

content

All actions related to site content functionality.

Pick up a carousel for homepage

This endpoint will allow you to get carousel for homepage.

Responses

Response samples

Content type
application/json
{
  • "title": "carousel-homepage",
  • "carouselItems": [
    ]
}

Pick up a carousel from taxon

This endpoint will allow you to get carousel form taxon.

path Parameters
code
required
string

Code of expected taxon

Responses

Response samples

Content type
application/json
{
  • "title": "carousel-homepage",
  • "carouselItems": [
    ]
}

Provides navigation menu (tabs/sections/columns/items).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the page content and metadata from locale and page slug

path Parameters
slug
required
string

Slug of expected page

Responses

Response samples

Content type
application/json
{
  • "code": "page-code",
  • "content": "[{ code: 'monsieurbiz.text', data: '<h1>100% Satisfait ou ré-imprimé !</h1>' }]",
  • "descriptionWhenLinked": "page-linked-description",
  • "metaDescription": "page-meta-description",
  • "metaKeywords": "page-meta-keywords",
  • "name": "page-name",
  • "nameWhenLinked": "page-linked-name",
  • "slug": "page-slug"
}

Gets the blocks details from locale and filtering parameters

query Parameters
products
Array of strings

Products codes

taxonomies
Array of strings

Taxonomies codes

sections
Array of strings

Sections codes

product-by-slug
string

Product slug

taxonomy-by-slug
string

Taxonomy slug

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the block content and metadata from locale and block code

path Parameters
code
required
string

Code of expected block

Responses

Response samples

Content type
application/json
{
  • "code": "my-block-code",
  • "name": "block-name",
  • "content": "[{ code: 'monsieurbiz.text', data: '<h1>100% Satisfait ou ré-imprimé !</h1>' }]",
  • "link": "https://www.google.com"
}

taxons

Show taxon tree

Show taxon tree.

This endpoint will return an array of all available taxon roots with all of its children.

query Parameters
locale
string

Locale in which taxons should be shown.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show taxon with given code.

This endpoint will return a taxon with given code, children and the root node with direct path to this taxon.

path Parameters
code
required
string

Code of expected taxon.

query Parameters
locale
string

Locale in which taxons should be shown.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "self": {
    },
  • "parentTree": {
    }
}

Show taxon with given code.

This endpoint will return a taxon with given code, children and the root node with direct path to this taxon.

path Parameters
code
required
string

Code of expected taxon.

query Parameters
locale
string

Locale in which taxons should be shown.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "name": "Hôtels & Restaurants",
  • "slug": "hotels-restaurants",
  • "description": "Pourquoi utiliser des imprimés dans votre café / hôtel / restaurant...",
  • "shortDescription": "Pourquoi utiliser des imprimés dans votre café / hôtel / restaurant",
  • "metaTitle": "Impression et communication pour hôtel et restaurant - Rapid Flyer",
  • "metaDescription": "Découvrez notre gamme d’imprimés et supports de communication pour hôtels et restaurants",
  • "metaKeywords": "Hôtels,Restaurants",
  • "medias": [
    ],
  • "nbWindows": 10,
  • "windows": [
    ],
  • "breadcrumbs": [
    ],
  • "helpLinks": {},
  • "blogLinks": {}
}

pattern

All actions related to site patterns functionality.

Search a pattern by product and format

This endpoint will return a pattern link to a product variant with the given format

query Parameters
locale
string

Locale in which pattern should be shown.

Request Body schema: application/json

Code of the product

productCode
required
string
formatCode
required
string

Responses

Request samples

Content type
application/json
{
  • "productCode": "AFF",
  • "formatCode": "100x150"
}

Response samples

Content type
application/json
{
  • "name": "AFF_100x150-cm",
  • "pdf": {
    },
  • "illustrator": {
    }
}

products

Show product catalog.

Show product catalog.

This endpoint will return a paginated list of products for given taxon.

path Parameters
taxonSlug
required
string

Slug of taxonomy for which products should be listed.

query Parameters
locale
string

Locale in which products should be shown.

limit
integer

Number of expected products per page.

page
integer

Page number.

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "limit": 10,
  • "pages": 3,
  • "total": 25,
  • "_links": {
    },
  • "items": [
    ]
}

Show product catalog.

This endpoint will return a paginated list of products for given taxon.

path Parameters
taxonCode
required
string

Code of taxonomy for which products should be listed.

query Parameters
locale
string

Locale in which products should be shown.

limit
integer

Number of expected products per page.

page
integer

Page number.

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "limit": 10,
  • "pages": 3,
  • "total": 25,
  • "_links": {
    },
  • "items": [
    ]
}

Show all the available format for the products which have a pattern

This endpoint will return all the distinct format for each product if they have at least one variant with a pattern

Responses

Response samples

Content type
application/json
{
  • "code": "AFF",
  • "name": "Affiche",
  • "availableFormat": {
    }
}

Show a product with the given slug.

This endpoint will return a product with the given slug.

path Parameters
slug
required
string

Slug of expected product.

query Parameters
locale
string

Locale in which products should be shown.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "variants": {
    },
  • "attributes": [
    ],
  • "associations": {
    },
  • "images": [
    ],
  • "uploadableFiles": 0,
  • "advice": "string",
  • "availableService": {
    },
  • "code": "LOGAN_MUG_CODE",
  • "averageRating": "1.8",
  • "name": "Logan Mug",
  • "slug": "logan-mug",
  • "description": "A very nice mug that you can drink from or use to store beverages in.",
  • "shortDescription": "A mug.",
  • "metaKeywords": "mug drink logan",
  • "metaDescription": "Some meta description",
  • "taxons": {
    },
  • "breadcrumb": "categories/mugs/logan-mug"
}

Show a product with the given code.

This endpoint will return a product with the given code.

path Parameters
code
required
string

Code of expected product.

query Parameters
locale
string

Locale in which products should be shown.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "variants": {
    },
  • "attributes": [
    ],
  • "associations": {
    },
  • "images": [
    ],
  • "uploadableFiles": 0,
  • "advice": "string",
  • "availableService": {
    },
  • "code": "LOGAN_MUG_CODE",
  • "averageRating": "1.8",
  • "name": "Logan Mug",
  • "slug": "logan-mug",
  • "description": "A very nice mug that you can drink from or use to store beverages in.",
  • "shortDescription": "A mug.",
  • "metaKeywords": "mug drink logan",
  • "metaDescription": "Some meta description",
  • "taxons": {
    },
  • "breadcrumb": "categories/mugs/logan-mug"
}

Show information of product for quotation creation

path Parameters
slug
required
string

The slug of the product

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "code": "AFF",
  • "name": "Affiche",
  • "options": [
    ]
}

Show latest products.

This endpoint will return an array of latest products.

query Parameters
locale
string

Locale in which products should be shown.

limit
integer

Number of expected products per page.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

cart

All actions related to cart management.

Pick up your cart from the store

This endpoint will allow you to create a new cart.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Show summarized cart.

This endpoint shows you the current calculated state of cart.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Drop your cart.

This endpoint will remove the cart and all of the related cart items.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Add an item to your cart.

This endpoint will allow you to add a new item to your cart.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json

Description of an item. The smallest required amount of data is a product code and quantity for a simple product. Configurable products will require an additional variant_code or options field, but never both.

productCode
required
string
quantity
integer >= 1
Default: 1
variantCode
string
object

Keys reference to the code of an option and values to the code of option value.

Responses

Request samples

Content type
application/json
{
  • "productCode": "LOGAN_HAT_CODE",
  • "quantity": 3,
  • "variantCode": "SMALL_LOGAN_T_SHIRT_CODE",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Merge multiple carts

Merge carts in body to the one in the url

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json

List of the cart's token needed to be merged

carts
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "carts": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Add multiple items to your cart.

This endpoint will allow you to add a new item to your cart.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json

Description of items. The same rules applied to each of the array values as to the previous point.

Array of objects (PutItemToCartRequest)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Download the pdf of the cart.

this endpoint will allow a user to download the pdf of the cart.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Change quantity of a cart item.

path Parameters
token
required
string

Cart identifier.

identifier
required
string

Identifier of a specific item. Can be found in the cart summary.

Request Body schema: application/json
quantity
required
integer

Responses

Request samples

Content type
application/json
{
  • "quantity": 2
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Remove cart item.

This endpoint will remove one item from your cart

path Parameters
token
required
string

Cart identifier.

identifier
required
string

Identifier of a specific item. Can be found in the cart summary.

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Upload file(s) to a cart item.

path Parameters
token
required
string

Cart identifier.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

Request Body schema: multipart/form-data
files[]
string <binary>

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Download a cart item file.

path Parameters
token
required
string

Cart identifier.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

identifier
required
string

Identifier of a specific file item. Can be found in the cart summary.

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "*** has not been found"
}

Delete a cart item file.

path Parameters
token
required
string

Cart identifier.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

identifier
required
string

Identifier of a specific file item. Can be found in the cart summary.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Estimates the shipping cost of the cart

path Parameters
token
required
string

Cart identifier.

query Parameters
countryCode
required
string

Shipping Country

provinceCode
required
string

Province to ship to

Responses

Response samples

Content type
application/json
{
  • "price": {
    }
}

Add a promotion coupon code to the cart.

This endpoint will allow you to add a promotion coupon code to the cart and receive the discount.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
coupon
required
string

Responses

Request samples

Content type
application/json
{
  • "coupon": "BANANAS"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Remove a promotion coupon code from the cart.

This endpoint will allow you to remove a promotion coupon code from the cart.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
coupon
required
string

Responses

Request samples

Content type
application/json
{
  • "coupon": "BANANAS"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Validate cart item files.

path Parameters
id
required
string

Identifier of a specific order. Can be found in the cart summary.

item
required
string

Identifier of a specific item. Can be found in the cart summary.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "*** has not been found"
}

checkout

All actions related to checkout fulfillment. It is important, to execute them in given order (address, choose shipment, choose payment and complete).

Show checkout summary

This endpoint will show the summarized cart during checkout. This action is an equivalent of cart summarize action.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "couponCode": "LD11FA"
}

Address cart.

This endpoint will allow you to add billing and shipping addresses to the cart and begin the checkout process. You can either define the same shipping and billing address or specify them separately.

path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
required
object (Address)
object (Address)

Responses

Request samples

Content type
application/json
{
  • "shippingAddress": {
    },
  • "billingAddress": {
    }
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Get available shipping methods.

This endpoint will show you available shipping methods for all cart shipments.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{
  • "shipments": [
    ]
}

Choosing a cart shipping method.

This endpoint will allow you to choose a cart shipping method.

path Parameters
token
required
string

Cart identifier.

id
required
string

Order number of shipment for which shipping method should be specified.

Request Body schema: application/json
method
required
string

Code of chosen shipping method.

Responses

Request samples

Content type
application/json
{
  • "method": "DHL"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Completing checkout.

This endpoint will allow you to complete the checkout.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

Request Body schema: application/json
email
required
string

Email of a customer.

notes
string

Additional notes.

Responses

Request samples

Content type
application/json
{
  • "email": "customer@example.com",
  • "notes": "I'm only available between 3 and 8 PM."
}

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "checkoutCompletedAt": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "invoices": [
    ]
}

Get payment instruction.

This endpoint will allow you to get the link of the bank for paid.

path Parameters
token
required
string

Cart identifier.

Responses

Response samples

Content type
application/json
{}

Get available payment methods for the current order

This endpoint will show you available payment methods for all cart payments.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ]
}

Choosing payment method for the current order

This endpoint will allow you to choose order a payment method.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

id
required
string

Order number of payment for which payment method should be specified.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Request Body schema: application/json
method
required
string

Code of chosen payment method.

Responses

Request samples

Content type
application/json
{
  • "method": "PBC"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

order

Showing the order information

Shows a list of orders of the customer

Authorizations:
bearerAuth
header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "count": 2
}

Shows details of specific customer's order

Authorizations:
bearerAuth
path Parameters
tokenValue
required
string

Order token.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "tokenValue": "SDAOSLEFNWU35H3QLI5325",
  • "channel": "RF",
  • "currency": "EUR",
  • "locale": "fr_FR",
  • "checkoutState": "cart",
  • "checkoutCompletedAt": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "totals": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "payments": [
    ],
  • "shipments": [
    ],
  • "cartDiscounts": [
    ],
  • "invoices": [
    ]
}

Get available payment methods for the current order

This endpoint will show you available payment methods for all cart payments.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ]
}

Choosing payment method for the current order

This endpoint will allow you to choose order a payment method.

Authorizations:
bearerAuth
path Parameters
token
required
string

Cart identifier.

id
required
string

Order number of payment for which payment method should be specified.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Request Body schema: application/json
method
required
string

Code of chosen payment method.

Responses

Request samples

Content type
application/json
{
  • "method": "PBC"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

bat

All actions related to BAT management

Refuses this BAT.

Authorizations:
bearerAuth
path Parameters
orderItemId
required
string

Order item id.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Refuses this BAT and reverts to previous state.

Authorizations:
bearerAuth
path Parameters
orderItemId
required
string

Order item id.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Responses

Validate this BAT and move to next state : bat_accepted

Authorizations:
bearerAuth
path Parameters
orderItemId
required
string

Order item id.

Responses

quotation

All functions related to the Rapid-Flyer Customer Address Book

Create a quotation.

this endpoint will allow an user to create a drafted quotation.

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Request Body schema: application/json
zone
required
string

The code of the zone

required
object (QuotationCreationItem)

Responses

Request samples

Content type
application/json
{
  • "zone": "WORLD",
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "reference": "DEV02022021",
  • "publishingDate": "2021-02-02T11:56:46+01:00",
  • "validityDate": "2021-03-04T11:56:46+01:00",
  • "linkGeneratePdf": "/shop-api/quotations/37824/download-pdf",
  • "status": "generated",
  • "priceTTC": "1000",
  • "items": {
    }
}

Add files to quotation item.

this endpoint will allow an user to add files to existing given quotation item.

path Parameters
quotationId
required
integer

Id of quotation

quotationItemId
required
integer

Id of quotation item

header Parameters
x-channel
string <string>
Default: RF

Channel (point of sale) code

Request Body schema: multipart/form-data
files[]
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "reference": "DEV02022021",
  • "publishingDate": "2021-02-02T11:56:46+01:00",
  • "validityDate": "2021-03-04T11:56:46+01:00",
  • "linkGeneratePdf": "/shop-api/quotations/37824/download-pdf",
  • "status": "generated",
  • "priceTTC": "1000",
  • "items": {
    }
}

Download the pdf of the quote.

this endpoint will allow a user to download the pdf of the quote.

path Parameters
quotationId
required
integer

Id of quotation

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Validate quotation, create associated order.

this endpoint will allow a user to validate a quotation and create associated order.

path Parameters
quotationId
required
integer

Id of quotation

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Validation failed",
  • "errors": {
    }
}

Get a quotations available.

this endpoint will allow a user to retrieve their quotes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

reviews

Get reviews of product.

Get paginated view of the reviews of a product.

path Parameters
productId
required
integer

The id of the product you want the review.

query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "opinions": [
    ]
}

Get average rate of product.

Get the average rate of a product.

path Parameters
productId
required
integer

The id of the product you want the review.

Responses

Response samples

Content type
application/json
{
  • "count": 17,
  • "rate": 4.2
}

Get reviews of RapidFlyer.

Get paginated view of the reviews of RapidFlyer.

query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "opinions": [
    ]
}

Get average rate RapidFlyer.

Get the average rate of RapidFlyer.

Responses

Response samples

Content type
application/json
{
  • "count": 17,
  • "rate": 4.2
}