API Endpoints

Products

Get Products

GET https://api.nexacommerce.com/:project/:country/getProducts

Query Parameters:

• q Full text search term (optional)
• filters Filters (see below) (optional)
• sort Sort by this attribute (optional)
• from Return results starting from result n (offset / pagination) (optional)
• size Return n results (optional)

Multiple filters can be separated with |. Attribute key and filter values are separated by :. Multiple filter values can be separated with ,. Example: categories:tShirts|size:M|colors:blue,white|targetGroups:men

Sort attribute can either just be the respective attribute key or consist of the attribute key followed by the sort order (asc or desc) separated by :. Example: price:desc

Get Product

GET https://api.nexacommerce.com/:project/:country/getProduct

Query Parameters:

• id Product ID (optional)
• sku SKU / Variant ID (optional)

Either id or sku has to be specified.

Customer / Authentication

Get Customer

GET https://api.nexacommerce.com/:project/:country/getCustomer

Register

POST https://api.nexacommerce.com/:project/:country/register

Body Parameters:

• salutation
• title (optional)
• firstName
• lastName
• email
• password

If a valid auth token of an anonymous customer is presented with this call the customer is upgraded to a registered customer. The customer ID remains the same.

Login

POST https://api.nexacommerce.com/:project/:country/login

Body Parameters:

• email
• password

If a valid auth token of an anonymous customer is presented with this call and the anonymous customer had items in their cart, the cart of the anonymous customer will be merged into the cart of the registered customer. For SKUs that appear in both carts the higher of both quantities will be taken over. The anonymous customer is deleted afterwards.

Logout

POST https://api.nexacommerce.com/:project/:country/logout

Clears the token cookie

Set Customer Details

TBD

POST https://api.nexacommerce.com/:project/:country/setCustomerDetails

Body Parameters:

• salutation (optional)
• title (optional)
• firstName (optional)
• lastName (optional)
• birthDate (optional)
• phoneNumber (optional)
• isSubscribedToNewsletter (optional)
• preferredLanguage (optional)

Set Password

TBD

Request Password Reset

TBD

Reset Password

TBD

Cart

Add To Cart

POST https://api.nexacommerce.com/:project/:country/addToCart

Body Parameters:

• sku
• quantity (optional)

If quantity is not provided one instance of the SKU will be added. If no (valid) auth token is presented with this call an anonymous customer will be created and a new token will be returned.

Set Cart Item Quantity

POST https://api.nexacommerce.com/:project/:country/setCartItemQuantity

Body Parameters:

• sku
• quantity

Remove From Cart

POST https://api.nexacommerce.com/:project/:country/removeFromCart

Body Parameters:

• sku

Logistics / Shipping

Set Shipping Address

POST https://api.nexacommerce.com/:project/:country/setShippingAddress

Body Parameters:

• country
• salutation
• title (optional)
• firstName
• lastName
• streetAddress
• supplement (optional)
• postalCode
• city
• region (optional)
• phoneNumber (optional)

Set Shipping Method

POST https://api.nexacommerce.com/:project/:country/setShippingMethod

Body Parameters:

• key Shipping Method Key

Payment

Set Billing Address

POST https://api.nexacommerce.com/:project/:country/setBillingAddress

Body Parameters:

• country
• salutation
• title (optional)
• firstName
• lastName
• streetAddress
• supplement (optional)
• postalCode
• city
• region (optional)
• phoneNumber (optional)

Set Payment Method

POST https://api.nexacommerce.com/:project/:country/setPaymentMethod

Body Parameters:

• key Payment Method Key
• data Payment Data (optional)

Add Voucher

TBD

Remove Voucher

TBD

Add Loyalty Program

TBD

Remove Loyalty Program

TBD

Orders

Get Orders

GET https://api.nexacommerce.com/:project/:country/getOrders

Get Order

GET https://api.nexacommerce.com/:project/:country/getOrder

Query Parameters:

• id Order ID

Place Order

POST https://api.nexacommerce.com/:project/:country/placeOrder

Body Parameters:

• data Payment Data (optional)

Requires shipping and billing addresses to be set and at least one item in the cart

Address Book

Get Address Book

TBD

Remove Address Book Entry

TBD

Wishlists

Add To Wishlist

TBD

Remove From Wishlist

TBD

Add Wishlist

TBD

Remove Wishlist

TBD