Beyond is a cloud-based platform that offers a flexible and performant feature set to satisfy the varying requirements of the ecommerce business. Add new functionality or integrations or build awesome ecommerce applications using our brand new REST API. Our modern microservice architecture allows you to quickly develop your ecommerce solution by offering you access to services such as checkout, orders, products, payments, and many more. Anyone who is curious about our new platform can already sign up for a beyondshop.

API Reference

The following sections provide you with all the required information on API resources, operations, and usage.

Authentication

Create a JsonWebToken from Authorization Code

A POST request is used to create a JsonWebToken using the authorization_code grant type.

Request parameters

Parameter Description

grant_type

OAuth2 grant type. Use authorization_code for authorization code flow

code

The authorization code.

Request header properties

Name Description

Authorization

The HTTP Basic Authorization header containing the OAuth 2.0 client credentials (client_id:client_secret).

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/oauth/token' -i -u 'd31f8460-305e-43a5-a707-808809084fef:956kr30jq25geh84h1274lj3at' -X POST -d 'grant_type=authorization_code&code=TYDLxs'

Response body properties

Path Type Description

access_token

String

The encoded JsonWebToken to access the resource.

tenantId

Number

The unique identifier of the tenant.

token_type

String

Represents how an accessToken will be generated and presented for accessing a resource. Always issued as Bearer.

iat

Number

The timestamp when the token was created (Issued At). Displayed in seconds since the start of the Epoch. Refer to RFC 7519.

expires_in

Number

The time of token expiry in seconds. Calculated from iat.

scope

String

A space-delimited list of scopes the token is issued for.

jti

String

The unique token identifier of the token. Must be unique to each request. Refer to RFC 7519.

refresh_token

String

The token that can be used to obtain a renewed access token.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 1554

{
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJ1c2VyX25hbWUiOiJ1c2VyIiwic2NvcGUiOlsidXNlcjpyIl0sInRlbmFudElkIjoxMzUsImV4cCI6MTUxMjY5NTk3NywiaWF0IjoxNTEyNjUyNzc3LCJqdGkiOiI5ODhiYzc4MS05ZmJkLTRhZjYtOTQ1ZS01OTRjNTY4NjU4MmUiLCJjbGllbnRfaWQiOiJkMzFmODQ2MC0zMDVlLTQzYTUtYTcwNy04MDg4MDkwODRmZWYifQ.XJvn3WZZK5S49dXB8zS4fe_Ox_tz60GZ1cHmHBGAxduNmcmCTlxAxnZfqqSvVYEG8dK3jGBQKLhLlLHkkKB8ikbyabUL3g672xC52m7pDdftUCG3nSJQfXr5DZPOJdhjNE4_-VsBIC4rjuRRFQo8noj2pAJLcrOuiaIljuI-ldXcCQ8UJniCSXPxhGZylxP7Em1MGB2c4-iEwmU7VtE4_MLLONE1LqlFKk-bOk-moN8QhDQX0uRMBfR-DGESDTAizQND3YiuKCitxNTJoJYmzf8mrV5uONYYJEzbmc9WfY2lgMmeXlEw4PjUtGTyugvaAlHy08N6zjVwsgN_6x9iAg",
  "token_type" : "bearer",
  "refresh_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJ1c2VyX25hbWUiOiJ1c2VyIiwic2NvcGUiOlsidXNlcjpyIl0sImF0aSI6Ijk4OGJjNzgxLTlmYmQtNGFmNi05NDVlLTU5NGM1Njg2NTgyZSIsInRlbmFudElkIjoxMzUsImV4cCI6MTUxNTI0NDc3NywiaWF0IjoxNTEyNjUyNzc3LCJqdGkiOiI0ZTNhM2RkMC1mYTNhLTRkMjQtYmI1Yi1jYzEyYjFiMWEyNGQiLCJjbGllbnRfaWQiOiJkMzFmODQ2MC0zMDVlLTQzYTUtYTcwNy04MDg4MDkwODRmZWYifQ.iLvAbAeOM_aa-vJhhO4CvpA2jTusl5NNnOMm9dquOPA2LbeOcDVBBPa2Ss8BTvOzdefxDxWpcmWixZtfrWsyNMuvignF94G7adw5NL2lWfK5X1tTi3a5RVsGf9Sd9xjIXRYBdUZMt85vGn9ywCqteHxRH7M0d6EPgfcMnxWsdYwFy54wrVQvYgVaBh7W7mK8X9fyPX3XHVVRWjHJ2b9TBl-6l0LJsfdxPU_UDWglwK3wrsEiUG24JvXfmpS-12XLNbFr5iJU12A-Dy78hFE-MNZ47937J_8Q7r6uzkXWE5T1nbN0vV2fHct9daXjJ8sMI1i7HFSzOtlcLJvEu1uAxQ",
  "expires_in" : 43199,
  "scope" : "user:r",
  "tenantId" : 135,
  "iat" : 1512652777,
  "jti" : "988bc781-9fbd-4af6-945e-594c5686582e"
}

Create a JsonWebToken from Refresh Token

A POST request is used to create a JsonWebToken from a refresh token.

Request parameters

Parameter Description

grant_type

OAuth2 grant type. Used to obtain additional access tokens to prolong the authorization to access resources. Use refresh_token here.

client_id

The client identifier issued to the client during the registration process. Refer to RFC 6749.

refresh_token

The token that can be used to obtain a renewed access token when the current token has expired.

Request header properties

Name Description

Authorization

The HTTP Basic Authorization header containing the OAuth 2.0 client credentials (client_id:client_secret).

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/oauth/token' -i -u 'sample-client:d76851be-e23d-44e2-bb12-237be6e3a122' -X POST -d 'grant_type=refresh_token&client_id=sample-client&refresh_token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJ1c2VyX25hbWUiOiJ1c2VyIiwic2NvcGUiOlsicHJvZDpyYyJdLCJhdGkiOiJjMDA1MmJhYS0wNWZjLTRiMGYtYjRkZC0wOGE1Y2U0NjIzMWYiLCJ0ZW5hbnRJZCI6MTQzOCwiZXhwIjoxNTE1MjQ0NzYyLCJpYXQiOjE1MTI2NTI3NjIsInVzZXJJZCI6ImQwYmUwZjMxLTc1OTktNDUwNy1iYzcwLTdhMjI0ZWMxOGQwOSIsImp0aSI6IjhjNTIxYjMwLTk5ZjEtNDdhMy1iOGQ1LWUzYWJmYTEzZTZiMyIsImNsaWVudF9pZCI6InNhbXBsZS1jbGllbnQiLCJ1c2VybmFtZSI6InVzZXIifQ.kzf_OXnA6dDiVhNV1pNy2voqMroe2ILwceit3Poijz6TK_txo5C78DZ_lFAt8VDvKXkh1tA-QV6NoT5f2sHTmxnMFmXD7G0onROm7X1GRc2NSFoAjsN9uNrJ3oxfvt2B4ySWNedJFuJ6Ey4LmxNxt2rmUYXmc3Eg7sZmahL7NZFWPckWONUe2DovgB-MukP7KrVv8NRliIUzY9Q2IhlGPbD_dgQhzW3jCuKjrevIP0PE9gjqaFlNOdJQFunkWXRN2_Iut0aCLkRi9iQhpYqG2QB-D--2zcdcCS9UsNIegPzu4gcCzfSidY1uBWuKz9wpl63dB9gvhOxCG4cJQl6tyQ'

Response body properties

Path Type Description

refresh_token

String

The token that can be used to obtain a renewed access token.

userId

String

The unique identifier of the user the token was issued for.

username

String

The username that identifies the user the token was issued for.

access_token

String

The encoded JsonWebToken to access the resource.

tenantId

Number

The unique identifier of the tenant.

token_type

String

Represents how an accessToken will be generated and presented for accessing a resource. Always issued as Bearer.

iat

Number

The timestamp when the token was created (Issued At). Displayed in seconds since the start of the Epoch. Refer to RFC 7519.

expires_in

Number

The time of token expiry in seconds. Calculated from iat.

scope

String

A space-delimited list of scopes the token is issued for.

jti

String

The unique token identifier of the token. Must be unique to each request. Refer to RFC 7519.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 1753

{
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJ1c2VyX25hbWUiOiJ1c2VyIiwic2NvcGUiOlsicHJvZDpyYyJdLCJ0ZW5hbnRJZCI6MTQzOCwiZXhwIjoxNTEyOTExOTYyLCJpYXQiOjE1MTI2NTI3NjIsInVzZXJJZCI6ImQwYmUwZjMxLTc1OTktNDUwNy1iYzcwLTdhMjI0ZWMxOGQwOSIsImp0aSI6IjQzZDMwMjkwLTg4Y2MtNDE2Zi1iOTJhLTE2NzFlNjA4M2M0OSIsImNsaWVudF9pZCI6InNhbXBsZS1jbGllbnQiLCJ1c2VybmFtZSI6InVzZXIifQ.KQYED8Eua1suMwePQ1FOJDzeu7JZtWahK1qRe0uscFpBIHNwA5B-EXw4e2MNFzDBSG4T9_JTEQRQlTCRMy1J7_CjlxzAaSR-fJ32LlwYJ8pcyeXEND1elWhFQRw1UsGCpBFw78yYeRYVRxXaNt7LtkUU1v68ggyO-Fn6B2FG8F3IkDUBXhUwkERM_9Dw2VjTlkcFBSFMHHWew3gWTjirzzLv8W2O8p1v-K21dOZfJoHzMxkM9oCJ75zfUydH2DNa-2NFbuZyBrGsljfrWlt7nMvloKiTNm0ijp7_r0F0PTOjjK-LxEDRCI9Nxj8Q1QMZoUt9O5YyppoU98fbk_SYlw",
  "token_type" : "bearer",
  "refresh_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJ1c2VyX25hbWUiOiJ1c2VyIiwic2NvcGUiOlsicHJvZDpyYyJdLCJhdGkiOiI0M2QzMDI5MC04OGNjLTQxNmYtYjkyYS0xNjcxZTYwODNjNDkiLCJ0ZW5hbnRJZCI6MTQzOCwiZXhwIjoxNTE1MjQ0NzYyLCJpYXQiOjE1MTI2NTI3NjIsInVzZXJJZCI6ImQwYmUwZjMxLTc1OTktNDUwNy1iYzcwLTdhMjI0ZWMxOGQwOSIsImp0aSI6IjhjNTIxYjMwLTk5ZjEtNDdhMy1iOGQ1LWUzYWJmYTEzZTZiMyIsImNsaWVudF9pZCI6InNhbXBsZS1jbGllbnQiLCJ1c2VybmFtZSI6InVzZXIifQ.k-AQ4kz_hmApNFVSTyGUZdYEOEdDjZxqoTn85FnrR63l6ulgXLoIOG_0P7YmKHAGHhBf1bzK-iZVraB6DrusiyRNnF2zoZ4M1nQ4A9QMh4Zdv_5R-HWvI-GqMXCOtq1Kbz9b7J-OwMVII2KMjEEhL_GGw0_OKfM9REWPlR0g5AUKMpOEjT8B988JGWN6tiidmLxzx2akdBp5_0oFG20wLz0_oEKYMH3C_Pj407KYDtIBLm6iChkFM2ZqcI5YaPj7JogIW_SOwKBcLMLjU_csf9Lyc5W23PJ3N6JZPovDNv_0_ichKLAgtX_skZSFP_wuJ2A8ZsunfrDVYz883ZJQIw",
  "expires_in" : 259199,
  "scope" : "prod:rc",
  "tenantId" : 1438,
  "iat" : 1512652762,
  "userId" : "d0be0f31-7599-4507-bc70-7a224ec18d09",
  "username" : "user",
  "jti" : "43d30290-88cc-416f-b92a-1671e6083c49"
}

Create a JsonWebToken from Client Credentials

A POST request is used to create a JsonWebToken using the client_credentials grant type.

Request parameters

Parameter Description

grant_type

OAuth2 grant type. Used as an authorization grant to request access to protected resources. Use client_credentials for client credentials flow. Refer to RFC 6749.

Request header properties

Name Description

Authorization

The HTTP Basic Authorization header containing the OAuth 2.0 client credentials (client_id:client_secret).

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/oauth/token' -i -u 'clientId1:password' -X POST -d 'grant_type=client_credentials'

Response body properties

Path Type Description

access_token

String

The encoded JsonWebToken to access the resource.

tenantId

Number

The unique identifier of the tenant.

token_type

String

Represents how an accessToken will be generated and presented for accessing a resource. Always issued as Bearer.

iat

Number

The timestamp when the token was created (Issued At). Displayed in seconds since the start of the Epoch. Refer to RFC 7519.

expires_in

Number

The time of token expiry in seconds. Calculated from iat.

scope

String

A space-delimited list of scopes the token is issued for.

jti

String

The unique token identifier of the token. Must be unique to each request. Refer to RFC 7519.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 773

{
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjEifQ.eyJzY29wZSI6WyJwcm9kOmNyIl0sInRlbmFudElkIjoxNDM4LCJleHAiOjE1MTI2OTU5NjQsImlhdCI6MTUxMjY1Mjc2NCwianRpIjoiNzk5M2I2YzAtOWRmNC00MWQ0LWI2NTAtOGEwMzIyMWEwYzlmIiwiY2xpZW50X2lkIjoiY2xpZW50SWQxIn0.HGZS2v0uQ3pcsys4FheQwQFlXU8WfzWPLH4TdcZLT7iXCfWt_hjlAFIjc89KVENjogsuPZg8x3kVHDrDmGkMx-zr2WjjOFHbRVLtNkShOaQyK6h58udUnjXyfyCKNaXoAqkGJsqPqqi-3AN70UUNfGEiAK5r4Yr4tjS2HSSMIKkgAb7A4w-iLo4sRhQoMK4BV88ZQ6SpbyTJjn8F2WdbRREIxHAf0GHXZ7fz3xxkzfcZWCwjPtmLTA-7UExOs6eAve9xPKmIhyKxalSIhXUqsQm2fwFS7IkqaHWLkzZsKvT6PI0KeXXGmioeFzxeyepjkDoTV2PWW7DtFaJjrw8DAQ",
  "token_type" : "bearer",
  "expires_in" : 43199,
  "scope" : "prod:cr",
  "tenantId" : 1438,
  "iat" : 1512652764,
  "jti" : "7993b6c0-9df4-41d4-b650-8a03221a0c9f"
}

Carts

The carts resources is used to manage the carts of a shop.

Create cart

A POST request is used to create a cart.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -d '{}'

Example response

HTTP/1.1 201 Created
Location: https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4410

{
  "lineItems" : [ ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "c23b7002-6723-42f2-aa0b-06bd5cffd412",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/8a5e6fbe-6cfb-4166-8c77-fb0305d2ea8f/shipping-methods/c23b7002-6723-42f2-aa0b-06bd5cffd412"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "2b1cad87-8d90-42c6-b0d8-262139ecb001",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/2b1cad87-8d90-42c6-b0d8-262139ecb001"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/2b1cad87-8d90-42c6-b0d8-262139ecb001/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 0,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/09d468b1-536b-443d-bfaa-2ca8b6d72398/shipping-address"
    }
  },
  "_id" : "09d468b1-536b-443d-bfaa-2ca8b6d72398"
}

Show cart details

A GET request is used to retrieve the details of a cart.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_id

String

The unique identifier of the cart.

lineItems[]._id

String

The unique identifier of the product line item.

lineItems[]._ref

String

The ID of the associated item (in case of _type=PRODUCT the product ID).

lineItems[]._type

String

The type of the line item (always PRODUCT for product line items).

lineItems[].name

String

The name of the line item.

lineItems[]._embedded.product

Object

The product-related details.

lineItems[]._embedded.product.sku

String

The SKU of the product line item.

lineItems[]._embedded.product.essentialFeatures

String

The essential product properties. Shown in the cart and checkout. In Germany mandatory field in online shops according to §312j Abs. 2 BGB (German Civil Code).

lineItems[]._embedded.product._links.product

Object

The link to the product.

lineItems[]._embedded.product._links.default-image-data

Object

Download URL of the default image.

lineItems[].quantity.value

Number

The value of the quantity.

lineItems[].quantity.unit

String

The unit of the quantity.

lineItems[].quantityInt

Number

The value of the quantity.

lineItems[].singleItemPrice.taxModel

String

The tax model of the single line item price.

lineItems[].singleItemPrice.amount

Number

The amount of the single line item price.

lineItems[].singleItemPrice.currency

String

The currency of the single line item price.

lineItems[].lineItemPrice.taxModel

String

The tax model of the line item total price.

lineItems[].lineItemPrice.amount

Number

The amount of the line item total price.

lineItems[].lineItemPrice.currency

String

The currency of the line item total price.

lineItems[].lineItemTax.taxRate

Number

The tax rate of the line item.

lineItems[].lineItemTax.taxClass

String

The tax class of the line item.

lineItems[].lineItemTax.amount

Number

The tax amount of the line item.

lineItems[].lineItemTax.currency

String

The currency of the line item.

lineItems[]._links.self.href

String

The self URI of the product line item.

shippingLineItem._embedded.shipping-method

Object

The line items of the shipping method.

shippingLineItem.lineItemTaxes

Array

The tax information for the shipping line item. The array contains one item per tax class.

shippingLineItem.lineItemPrice.taxModel

String

The tax model of the price for this shipping line item.

shippingLineItem.lineItemPrice.amount

Number

The amount of the price for this shipping line item.

shippingLineItem.lineItemPrice.currency

String

The currency of the price for this shipping line item.

paymentLineItem._embedded.payment-method

Object

Refer to Show payment method details for item documentation.

paymentLineItem.lineItemTaxes

Array

The tax information for the payment line item. The array contains one item per tax class.

paymentLineItem.lineItemPrice.taxModel

String

The tax model of the payment line item price.

paymentLineItem.lineItemPrice.amount

Number

The amount of the payment line item price.

paymentLineItem.lineItemPrice.currency

String

The currency of the payment line item price.

billingAddress

Object

The billing address of the cart. Refer to Set cart billing address for item documentation.

shippingAddress

Object

The shipping address that applies to the cart. Defaults to billing address if no shipping address is set. Refer to Set cart shipping address for item documentation.

grandTotal

Object

The total price to be paid including product price, shipping, and tax.

subtotal

Object

The subtotal of the product line items.

netTotal

Object

The total net amount of the cart.

taxTotal

Object

The total tax amount.

taxable

Boolean

Indicates if a tax applies for the cart. Can be true or false.

taxes

Array

The tax amount per tax class.

taxes[*].taxClass

String

The tax class that applies for the cart.

taxes[*].taxRate

Number

The tax rate of this tax class.

taxes[*].amount

Number

The tax amount of this tax class.

taxes[*].currency

String

The currency for this tax amount.

balanceDue

Object

The outstanding balance of the amount to be paid.

minimumOrderValue

Object

The mininmum value of the cart so that this payment method can be used.

weight

Number

The total weight of products in the cart. A product’s weight defaults to 0 if not set.

checkoutState.readyToOrder

Boolean

Indicates if this cart is ready to create an order. Can be true or false.

checkoutState.shippingMethodValid

Boolean

Indicates if the shipping method for this cart is valid.

checkoutState.shippingMethodSelectable

Boolean

Indicates if the shipping method for this cart can be selected.

checkoutState.paymentMethodValid

Boolean

Indicates if the payment method for this cart is valid. Can be true or false.

checkoutState.paymentMethodSelectable

Boolean

Indicates if the payment method for this cart can be selected. Can be true or false.

checkoutState.billingAddressSet

Boolean

Indicates if the billing address for the cart is set. Can be true or false.

checkoutState.priceValidToOrder

Boolean

Indicates if the cart price is valid to create an order. Can be true or false.

checkoutState.paymentTransactionStatus

String

The state of the payment transaction of this cart. Can be one of NO_APPROVAL_NEEDED, APPROVAL_PENDING or APPROVED.

Links

Relation Description

line-items

The link to the line items.

payment-method-available

The link to the payment methods available for this cart.

payment-method-default

The link to the default payment method.

payment-method-current

The link to the current payment method.

shipping-method-available

The link to the shipping methods available for this cart.

shipping-method-default

The link to the default shipping method.

shipping-method-current

The link to the current shipping method.

shipping-address

The link to the shipping address.

billing-address

The link to the billing address.

place-order

The link to place an order. Only available on carts that are ready to order.

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 7633

{
  "lineItems" : [ {
    "_type" : "PRODUCT",
    "_id" : "faad5eb0-8e64-4e4c-b57b-2e94bde619bc",
    "_ref" : "16661496-b27a-4827-bc7d-5da9c890cf40",
    "name" : "Decorative Sand (2 kg Jumbo Pack)",
    "quantity" : {
      "value" : 1,
      "unit" : "PIECE"
    },
    "singleItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "lineItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "_embedded" : {
      "product" : {
        "_id" : "16661496-b27a-4827-bc7d-5da9c890cf40",
        "sku" : "1018",
        "essentialFeatures" : "Not suitable for children under the age of 8.",
        "_links" : {
          "product" : {
            "href" : "https://api-shop.beyondshop.cloud/api/product-view/products/16661496-b27a-4827-bc7d-5da9c890cf40?locale=de-DE"
          },
          "default-image-data" : {
            "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
            "templated" : true
          }
        }
      }
    },
    "quantityInt" : 1,
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.9816
    },
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/line-items/faad5eb0-8e64-4e4c-b57b-2e94bde619bc"
      }
    }
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "471a148b-8a6a-4bce-969f-aa538c69d3d3",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/31b8b880-fcd7-450d-b7ac-5f5bf5066edf/shipping-methods/471a148b-8a6a-4bce-969f-aa538c69d3d3"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "f91df2a5-641a-41d1-9627-c28b98cfd1ab",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/f91df2a5-641a-41d1-9627-c28b98cfd1ab"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/f91df2a5-641a-41d1-9627-c28b98cfd1ab/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : null,
    "title" : "",
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "Erdgeschoss",
    "addressExtension" : "",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a.alsterh@example.com",
    "phone" : "(800) 555-0102",
    "mobile" : "(800) 555-0103",
    "displayAddressLines" : [ "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "20999 Alsterwasser" ],
    "vatId" : "123456789",
    "taxNumber" : "123-34-6789",
    "birthDate" : "1985-03-20"
  },
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : null,
    "title" : "",
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "Erdgeschoss",
    "addressExtension" : "",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a.alsterh@example.com",
    "phone" : "(800) 555-0102",
    "mobile" : "(800) 555-0103",
    "displayAddressLines" : [ "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "20999 Alsterwasser" ],
    "doorCode" : "0815"
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 42.0084
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.0,
    "currency" : "EUR",
    "amount" : 0
  } ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 2000,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : true,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : true
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/shipping-address"
    },
    "place-order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02/order"
    }
  },
  "_id" : "1dddbe1e-1f3d-4ce7-b11a-e79c64a0ef02"
}

Delete cart

A DELETE request is used to remove the cart.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/8e5ae07b-71fb-47a2-b1cc-961da22a39c1' -i -X DELETE

Example response

HTTP/1.1 204 No Content

Create order from cart

A POST request is used to create an order from the cart.

This endpoint can just be used on a cart with checkoutState.readyToOrder == true. The readyToOrder does not include the availability check, so this might still fail if stock-managed products are not available.

The response contains a location header with a link to the order. Note that the order is created asynchronously and is not available immediately.

Request body properties

Path Type Description

customerComment

String

An optional comment from the customer regarding the order.

salesChannel

String

The sales channel for this order.

marketingChannel

String

The marketing channel for this order.

marketingSubchannel

String

The marketing subchannel for this order.

testOrder

Boolean

Indicates if this order is a test order. Can be true or false.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/f8ec663b-c738-449d-aedd-cd7932ee4067/order' -i -X POST -H 'Content-Type: application/json' -d '{"customerComment":"send it fast please", "salesChannel":"DifferentChannel", "marketingChannel":"Google", "marketingSubchannel":"Search page 2", "testOrder":false}'

Example response

HTTP/1.1 202 Accepted
Location: https://api-shop.beyondshop.cloud/api/order/orders/search/find-by-cart-id?cartId=f8ec663b-c738-449d-aedd-cd7932ee4067

Add single line item to cart

A POST request is used to add a line item to the cart. Currently only product line items are supported.

Request body properties

Path Type Description

_type

String

The type of the line item (always PRODUCT for product line items).

_ref

String

The ID of the associated item (in case of _type=PRODUCT the product ID).

quantityInt

Number

The value of the quantity.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/line-items' -i -X POST -H 'Content-Type: application/json' -d '{"_type":"PRODUCT","_ref":"fb3a1e1e-ff1d-4ff6-9e56-248225298e68","quantityInt":1}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 6172

{
  "lineItems" : [ {
    "_type" : "PRODUCT",
    "_id" : "6634b47b-fa9e-48cf-8211-0924a8a7b279",
    "_ref" : "fb3a1e1e-ff1d-4ff6-9e56-248225298e68",
    "name" : "Decorative Sand (2 kg Jumbo Pack)",
    "quantity" : {
      "value" : 1,
      "unit" : "PIECE"
    },
    "singleItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "lineItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "_embedded" : {
      "product" : {
        "_id" : "fb3a1e1e-ff1d-4ff6-9e56-248225298e68",
        "sku" : "1018",
        "essentialFeatures" : "Not suitable for children under the age of 8.",
        "_links" : {
          "product" : {
            "href" : "https://api-shop.beyondshop.cloud/api/product-view/products/fb3a1e1e-ff1d-4ff6-9e56-248225298e68?locale=de-DE"
          },
          "default-image-data" : {
            "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
            "templated" : true
          }
        }
      }
    },
    "quantityInt" : 1,
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.981596
    },
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/line-items/6634b47b-fa9e-48cf-8211-0924a8a7b279"
      }
    }
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "d981d6cd-3e18-411d-ad73-546b66e76d77",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/a5b97e7e-3ed8-4f1a-83f2-5eb8aa431e43/shipping-methods/d981d6cd-3e18-411d-ad73-546b66e76d77"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "8fad0fdd-1908-4350-a223-79410739826f",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/8fad0fdd-1908-4350-a223-79410739826f"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/8fad0fdd-1908-4350-a223-79410739826f/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 42.0084
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.0,
    "currency" : "EUR",
    "amount" : 0
  } ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 2000,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/66261a1c-9cdc-408b-b5fa-b254a609f6c2/shipping-address"
    }
  },
  "_id" : "66261a1c-9cdc-408b-b5fa-b254a609f6c2"
}

Replace line items

A PUT request is used to replace the current line items of the cart with the given list.

Request body properties

Path Type Description

[]

Array

The list of line items.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/line-items' -i -X PUT -H 'Content-Type: application/json' -d '[{"_type":"PRODUCT","_ref":"229ded7d-0046-4a85-b981-1d66c5da642a","quantityInt":1}]'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 6172

{
  "lineItems" : [ {
    "_type" : "PRODUCT",
    "_id" : "740a467b-b224-4275-8a8d-4e2c62eeb4c4",
    "_ref" : "229ded7d-0046-4a85-b981-1d66c5da642a",
    "name" : "Decorative Sand (2 kg Jumbo Pack)",
    "quantity" : {
      "value" : 1,
      "unit" : "PIECE"
    },
    "singleItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "lineItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "_embedded" : {
      "product" : {
        "_id" : "229ded7d-0046-4a85-b981-1d66c5da642a",
        "sku" : "1018",
        "essentialFeatures" : "Not suitable for children under the age of 8.",
        "_links" : {
          "product" : {
            "href" : "https://api-shop.beyondshop.cloud/api/product-view/products/229ded7d-0046-4a85-b981-1d66c5da642a?locale=de-DE"
          },
          "default-image-data" : {
            "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
            "templated" : true
          }
        }
      }
    },
    "quantityInt" : 1,
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.981596
    },
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/line-items/740a467b-b224-4275-8a8d-4e2c62eeb4c4"
      }
    }
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "3f86208e-5e45-41c6-a170-c1739330c4b4",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/b8cc701f-d7c8-458d-aa27-21602fb975d2/shipping-methods/3f86208e-5e45-41c6-a170-c1739330c4b4"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "bc939a5a-cd6e-4cc6-b3a5-0145ccc672bf",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/bc939a5a-cd6e-4cc6-b3a5-0145ccc672bf"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/bc939a5a-cd6e-4cc6-b3a5-0145ccc672bf/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 42.0084
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 60.9584
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.0,
    "currency" : "EUR",
    "amount" : 0
  } ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 2000,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/d4f8f10b-50a0-4c1b-a698-4e006d0eef5b/shipping-address"
    }
  },
  "_id" : "d4f8f10b-50a0-4c1b-a698-4e006d0eef5b"
}

Delete line item

A DELETE request is used to remove a line item from the cart.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/line-items/59b01e16-ff80-4933-bf8c-aee7e40cf17d' -i -X DELETE

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4410

{
  "lineItems" : [ ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "d8c58a13-9191-497d-973b-aa995121a888",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/f6f26f29-34a6-477d-b567-5e4f2bbd4980/shipping-methods/d8c58a13-9191-497d-973b-aa995121a888"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "8d3d03f1-4906-46a5-8baa-006091a58ca0",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/8d3d03f1-4906-46a5-8baa-006091a58ca0"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/8d3d03f1-4906-46a5-8baa-006091a58ca0/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 0,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/6d1d177a-8b4b-4882-bee1-5f76868a0fc0/shipping-address"
    }
  },
  "_id" : "6d1d177a-8b4b-4882-bee1-5f76868a0fc0"
}

Set cart billing address

A PUT request is used to set the billing address of the cart.

The billing address is mandatory for a cart being ready to order

Request body properties

Path Type Description Constraints

salutation

String

The customer’s salutation, e.g. Mr or Mrs.

gender

String

The customer’s gender. Can be FEMALE, MALE or UNDEFINED.

title

String

The customer’s academic title, e.g. professor, or PhD.

firstName

String

The first name of the customer.

middleName

String

The middle name of the customer.

lastName

String

The last name of the customer.

street

String

The street of the customer address.

Must not be empty

houseNumber

String

The house number of the customer address.

street2

String

Additional street field for the customer address.

doorCode

String

The door code of the customer address.

addressExtension

String

The address extension of the customer address, e.g. PO box.

postalCode

String

The zip code of the customer address.

Must not be empty

city

String

The city of the customer address.

Must not be empty

country

String

A two letter country code according to ISO 3166-1. Only officially assigned country codes.

Must be an officially assigned country code (see ISO 3166-1 Alpha-2). Must not be null. The address country must be in the list of shipping countries of the shop

state

String

The state of the customer address.

email

String

The email address of the customer.

Must be a well-formed email address. Must not be empty

phone

String

The landline phone number of the customer.

mobile

String

The mobile phone number of the customer.

vatId

String

taxNumber

String

birthDate

String

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/billing-address' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -d '{"salutation":"Mrs","gender":"FEMALE","title":"","firstName":"Astrid","middleName":"Agnes","lastName":"Alster","street":"Alsterwasserweg","houseNumber":"2","street2":"Erdgeschoss","doorCode":"0815","addressExtension":"","postalCode":"20999","city":"Alsterwasser","country":"DE","state":"Hamburg","email":"a.alsterh@example.com","phone":"(800) 555-0102","mobile":"(800) 555-0103","vatId":"123456789","taxNumber":"123-34-6789","birthDate":"1985-03-20"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5234

{
  "lineItems" : [ ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "5a7d1960-fefa-42af-a364-57afb0bf7c5c",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/fddf4bdc-34f4-4c98-b946-fbd8054cdaa9/shipping-methods/5a7d1960-fefa-42af-a364-57afb0bf7c5c"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "1107198e-0f40-4cc7-b921-bcbf538d9ed6",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1107198e-0f40-4cc7-b921-bcbf538d9ed6"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1107198e-0f40-4cc7-b921-bcbf538d9ed6/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : null,
    "title" : "",
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "Erdgeschoss",
    "addressExtension" : "",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a.alsterh@example.com",
    "phone" : "(800) 555-0102",
    "mobile" : "(800) 555-0103",
    "displayAddressLines" : [ "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "20999 Alsterwasser" ],
    "vatId" : "123456789",
    "taxNumber" : "123-34-6789",
    "birthDate" : "1985-03-20"
  },
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 0,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : true,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : true
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/shipping-address"
    },
    "place-order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/2aa91914-a897-4841-9dfc-64f821481b7b/order"
    }
  },
  "_id" : "2aa91914-a897-4841-9dfc-64f821481b7b"
}

Set cart shipping address

A PUT request is used to set the shipping address of the cart.

If a shipping address is not set it will default to the billing address

Request body properties

Path Type Description Constraints

salutation

String

The customer’s salutation, e.g. Mr or Mrs.

gender

String

The customer’s gender. Can be FEMALE, MALE or UNDEFINED.

title

String

The customer’s academic title, e.g. professor, or PhD.

firstName

String

The first name of the customer.

middleName

String

The middle name of the customer.

lastName

String

The last name of the customer.

street

String

The street of the customer address.

Must not be empty

houseNumber

String

The house number of the customer address.

street2

String

Additional street field for the customer address.

doorCode

String

The door code of the customer address.

addressExtension

String

The address extension of the customer address, e.g. PO box.

postalCode

String

The zip code of the customer address.

Must not be empty

city

String

The city of the customer address.

Must not be empty

country

String

A two letter country code according to ISO 3166-1. Only officially assigned country codes.

Must be an officially assigned country code (see ISO 3166-1 Alpha-2). Must not be null. The address country must be in the list of shipping countries of the shop

state

String

The state of the customer address.

email

String

The email address of the customer.

Must be a well-formed email address. Must not be empty

phone

String

The landline phone number of the customer.

mobile

String

The mobile phone number of the customer.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/shipping-address' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -d '{"salutation":"Mrs","gender":"FEMALE","title":"","firstName":"Astrid","middleName":"Agnes","lastName":"Alster","street":"Alsterwasserweg","houseNumber":"2","street2":"Erdgeschoss","doorCode":"0815","addressExtension":"","postalCode":"20999","city":"Alsterwasser","country":"DE","state":"Hamburg","email":"a.alsterh@example.com","phone":"(800) 555-0102","mobile":"(800) 555-0103"}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5049

{
  "lineItems" : [ ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "d63b69d0-8c15-43fc-9e2b-2f3eefc7538e",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/662c0195-dcc8-4d8a-9cc9-479abf499c2f/shipping-methods/d63b69d0-8c15-43fc-9e2b-2f3eefc7538e"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "75aacf17-3f7e-4eb7-86e8-630f96ce9162",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/75aacf17-3f7e-4eb7-86e8-630f96ce9162"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/75aacf17-3f7e-4eb7-86e8-630f96ce9162/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : null,
    "title" : "",
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "Erdgeschoss",
    "addressExtension" : "",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a.alsterh@example.com",
    "phone" : "(800) 555-0102",
    "mobile" : "(800) 555-0103",
    "displayAddressLines" : [ "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "20999 Alsterwasser" ],
    "doorCode" : "0815"
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 0,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/c25c7637-b18f-430c-bb99-a6f50b0c6d18/shipping-address"
    }
  },
  "_id" : "c25c7637-b18f-430c-bb99-a6f50b0c6d18"
}

Set current cart payment method

A PUT request is used to set the current payment method of the cart.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/payment-methods/current' -i -X PUT -H 'Content-Type: text/uri-list' -H 'Accept: application/json' -d 'https://api-shop.beyondshop.cloud/api/payment-methods/58583058-fcc2-4acb-928f-2b4608d7005e'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 6170

{
  "lineItems" : [ {
    "_type" : "PRODUCT",
    "_id" : "033433b5-7662-4e8a-8f8d-fd6e6912e44f",
    "_ref" : "6ddf3553-ecb2-453a-a78b-0999a3241aef",
    "name" : "Decorative Sand (2 kg Jumbo Pack)",
    "quantity" : {
      "value" : 1,
      "unit" : "PIECE"
    },
    "singleItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "lineItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 42.0084
    },
    "_embedded" : {
      "product" : {
        "_id" : "6ddf3553-ecb2-453a-a78b-0999a3241aef",
        "sku" : "1018",
        "essentialFeatures" : "Not suitable for children under the age of 8.",
        "_links" : {
          "product" : {
            "href" : "https://api-shop.beyondshop.cloud/api/product-view/products/6ddf3553-ecb2-453a-a78b-0999a3241aef?locale=de-DE"
          },
          "default-image-data" : {
            "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
            "templated" : true
          }
        }
      }
    },
    "quantityInt" : 1,
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.981596
    },
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/line-items/033433b5-7662-4e8a-8f8d-fd6e6912e44f"
      }
    }
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "effbe3de-a4e0-4aaa-bce0-3a67f9ee5f87",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/b89d3efa-f897-47c4-ac3f-ed32a2983c6d/shipping-methods/effbe3de-a4e0-4aaa-bce0-3a67f9ee5f87"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 1.179168
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ],
    "_embedded" : {
      "payment-method" : {
        "name" : "Credit Card",
        "description" : "Pay with CreditCard",
        "officialName" : "Credit Card",
        "officialDescription" : "Pay with CreditCard",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "PERCENTAGE",
          "absoluteValue" : null,
          "percentageValue" : 0.02
        },
        "position" : 2,
        "serviceableCountries" : [ "DE", "GB" ],
        "minimumOrderValue" : {
          "currency" : "EUR",
          "amount" : 20
        },
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "58583058-fcc2-4acb-928f-2b4608d7005e",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/58583058-fcc2-4acb-928f-2b4608d7005e"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/58583058-fcc2-4acb-928f-2b4608d7005e/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 42.0084
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 60.137568
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 60.137568
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 60.137568
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.0,
    "currency" : "EUR",
    "amount" : 0
  } ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 2000,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/0aeb2a46-3b53-4a0c-a7d5-66601845934f/shipping-address"
    }
  },
  "_id" : "0aeb2a46-3b53-4a0c-a7d5-66601845934f"
}

Set cart payment method to current default

A PUT request is used to set the payment method to the current default payment method. The default payment method is the one with the highest priority of the applicable payment methods.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/payment-methods/default' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 4410

{
  "lineItems" : [ ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "407fbee2-4a0f-4cc8-95d6-e8eaccfbf280",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/ee7f9e49-93f0-40f3-8b79-49615c28c41c/shipping-methods/407fbee2-4a0f-4cc8-95d6-e8eaccfbf280"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "928f003b-bc0e-43b4-bc1a-8431d927ede1",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/928f003b-bc0e-43b4-bc1a-8431d927ede1"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/928f003b-bc0e-43b4-bc1a-8431d927ede1/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 0,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/b627795a-8607-498a-8caf-9f2c3b573a59/shipping-address"
    }
  },
  "_id" : "b627795a-8607-498a-8caf-9f2c3b573a59"
}

Show current cart payment method details

A GET request is used to get the current payment method. The payment method type is documented here.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/441b5b91-b13b-4827-8e59-aa9075c3361c/payment-methods/current' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 864

{
  "name" : "PayPal",
  "description" : "Pay with PayPal",
  "officialName" : "PayPal",
  "officialDescription" : "Pay with PayPal",
  "taxClass" : "REGULAR",
  "discountOrFee" : {
    "type" : "ABSOLUTE",
    "absoluteValue" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "percentageValue" : null
  },
  "position" : 1,
  "serviceableCountries" : [ "DE" ],
  "minimumOrderValue" : null,
  "activated" : true,
  "activeLogoSet" : null,
  "onlinePayment" : false,
  "activatable" : true,
  "_id" : "0f5f550e-ad51-4f83-a424-8775851c8a04",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/0f5f550e-ad51-4f83-a424-8775851c8a04"
    },
    "deactivate-payment-method" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/0f5f550e-ad51-4f83-a424-8775851c8a04/deactivate"
    }
  }
}

Show applicable cart payment method details

A GET request is used to get the applicable payment methods of a cart. The payment method type is documented here.

The selectable field indicates if a payment method is currently selectable. Non-selectable payment methods are currently restricted because of rules that apply to a Cart. Trying to set such a payment method as the current one of the cart will fail.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/1dc6ef87-109c-44f8-9ba4-5f82fcb1ce1f/payment-methods' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_embedded.payment-methods[].selectable

Boolean

Indicates if the payment method can be selected for the current cart. A payment method can be become non-selectable if the cart is modified, so that the minimumOrderValue is no longer reached. A cart with an non-selectable payment method cannot be ordered.

_embedded.payment-methods[].lineItemPrice

Object

The calculated price for this payment on the current cart.

_embedded.payment-methods[]._embedded.payment-method._id

String

The immutable, unique identifier of the requested resource.

_embedded.payment-methods[]._embedded.payment-method.position

Number

The sorting position of the payment method in the merchant administration in relation to other payment methods.

_embedded.payment-methods[]._embedded.payment-method.officialName

String

The official name of the payment method chosen by the merchant during setup.

_embedded.payment-methods[]._embedded.payment-method.officialDescription

String

The official description of the payment method chosen by the merchant during setup.

_embedded.payment-methods[]._embedded.payment-method.name

String

The name of the payment method that is used during checkout.

_embedded.payment-methods[]._embedded.payment-method.description

String

Description of the payment method that is used during checkout.

_embedded.payment-methods[]._embedded.payment-method.activated

Boolean

Indicates if a payment method is active. Can be true or false.

_embedded.payment-methods[]._embedded.payment-method.taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

_embedded.payment-methods[]._embedded.payment-method.discountOrFee

Object

The details about the fee to be payed or discount to be granted for this payment method.

_embedded.payment-methods[]._embedded.payment-method.discountOrFee.type

String

The discount or fee can be an absolute or a percentage based value. Can be one of PERCENTAGE or ABSOLUTE. ABSOLUTE contains another attribute absoluteValue with a positive or negative price. PERCENTAGE contains another attribute percentageValue with a negative or positive percentage value.

_embedded.payment-methods[]._embedded.payment-method.serviceableCountries

Array

The list of target countries this payment method can be used in.

_embedded.payment-methods[]._embedded.payment-method.minimumOrderValue

Null

The mininmum value of the cart so that this payment method can be used.

_embedded.payment-methods[]._embedded.payment-method.onlinePayment

Boolean

Indicates if the payment method is an online payment. Can be true or false.

_embedded.payment-methods[]._embedded.payment-method.activatable

Boolean

Indicates if a payment method can be activated (feature enabled for the shop). Can be true or false.

_embedded.payment-methods[]._embedded.payment-method.activeLogoSet

Null

The name of the currently selected logo set. Can be TILE, DETAILS, LIST or STOREFRONT. (official is always the fallback).

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1514

{
  "_embedded" : {
    "payment-methods" : [ {
      "lineItemPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 2
      },
      "selectable" : true,
      "_embedded" : {
        "payment-method" : {
          "name" : "PayPal",
          "description" : "Pay with PayPal",
          "officialName" : "PayPal",
          "officialDescription" : "Pay with PayPal",
          "taxClass" : "REGULAR",
          "discountOrFee" : {
            "type" : "ABSOLUTE",
            "absoluteValue" : {
              "taxModel" : "GROSS",
              "currency" : "EUR",
              "amount" : 2
            },
            "percentageValue" : null
          },
          "position" : 1,
          "serviceableCountries" : [ "DE" ],
          "minimumOrderValue" : null,
          "activated" : true,
          "activeLogoSet" : null,
          "onlinePayment" : false,
          "activatable" : true,
          "_id" : "a038baca-faf6-41b5-b594-fbba9ab5523c",
          "_links" : {
            "self" : {
              "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/a038baca-faf6-41b5-b594-fbba9ab5523c"
            },
            "deactivate-payment-method" : {
              "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/a038baca-faf6-41b5-b594-fbba9ab5523c/deactivate"
            }
          }
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/1dc6ef87-109c-44f8-9ba4-5f82fcb1ce1f/payment-methods"
    }
  }
}

Create Payment

A POST request is used to initiate the creation of a payment.

Request body properties

Path Type Description

returnUri

String

The redirect URI after successful payment authorization.

cancelUri

String

The redirect URI if the payment authorization was not successful.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/eca740b9-de55-40e1-82f3-7b32a0c756f0/create-payment' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -d '{
  "returnUri" : "http://some.com/return",
  "cancelUri" : "http://some.com/cancel"
}'

Response body properties

Path Type Description

approvalUri

String

The URI used to approve the payment. The client has to redirect to this URI to initiate the approval.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 47

{
  "approvalUri" : "http://some.de/approval"
}

Set current cart shipping method

A PUT request is used to set the current shipping method of the cart.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/shipping-methods/current' -i -X PUT -H 'Content-Type: text/uri-list' -H 'Accept: application/json' -d 'https://api-shop.beyondshop.cloud/api/shipping-zones/e260931e-79ce-456a-b548-9b564189cf13/shipping-methods/2c615e55-306e-4919-807c-bb4137b8b934'

Example response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 5937

{
  "lineItems" : [ ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 50
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Express",
        "description" : "Shipping overnight, delivery on the next day.",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : {
          "currency" : "EUR",
          "amount" : 1000
        },
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 50
        },
        "weightBasedPrice" : null,
        "_id" : "2c615e55-306e-4919-807c-bb4137b8b934",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/e260931e-79ce-456a-b548-9b564189cf13/shipping-methods/2c615e55-306e-4919-807c-bb4137b8b934"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "9c51afd2-759c-4859-9604-756dc2738cf9",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/9c51afd2-759c-4859-9604-756dc2738cf9"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/9c51afd2-759c-4859-9604-756dc2738cf9/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : null,
    "title" : "",
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "Erdgeschoss",
    "addressExtension" : "",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a.alsterh@example.com",
    "phone" : "(800) 555-0102",
    "mobile" : "(800) 555-0103",
    "displayAddressLines" : [ "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "20999 Alsterwasser" ],
    "vatId" : "123456789",
    "taxNumber" : "123-34-6789",
    "birthDate" : "1985-03-20"
  },
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : null,
    "title" : "",
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "Erdgeschoss",
    "addressExtension" : "",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a.alsterh@example.com",
    "phone" : "(800) 555-0102",
    "mobile" : "(800) 555-0103",
    "displayAddressLines" : [ "Astrid Agnes Alster", "Alsterwasserweg 2", "Erdgeschoss", "20999 Alsterwasser" ],
    "doorCode" : "0815"
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 52
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 52
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 52
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 0,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : true,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : true
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/shipping-address"
    },
    "place-order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/f0c73650-2134-4586-aae6-db1661f24433/order"
    }
  },
  "_id" : "f0c73650-2134-4586-aae6-db1661f24433"
}

Set cart shipping method to current default

A PUT request is used to set the shipping method to the current default shipping method. The default shipping method is the one with the highest priority of the applicable shipping methods.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/shipping-methods/default' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 4410

{
  "lineItems" : [ ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "shipping-method" : {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "63eada49-e6ff-4583-aa95-d8d20c8f1beb",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/50c22462-7631-4b07-91cc-8fa1e5c2511a/shipping-methods/63eada49-e6ff-4583-aa95-d8d20c8f1beb"
          }
        }
      }
    }
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "lineItemTaxes" : [ ],
    "_embedded" : {
      "payment-method" : {
        "name" : "PayPal",
        "description" : "Pay with PayPal",
        "officialName" : "PayPal",
        "officialDescription" : "Pay with PayPal",
        "taxClass" : "REGULAR",
        "discountOrFee" : {
          "type" : "ABSOLUTE",
          "absoluteValue" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 2
          },
          "percentageValue" : null
        },
        "position" : 1,
        "serviceableCountries" : [ "DE" ],
        "minimumOrderValue" : null,
        "activated" : true,
        "activeLogoSet" : null,
        "onlinePayment" : false,
        "activatable" : true,
        "_id" : "83004911-fad9-440a-944f-7bae33bca0f8",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/83004911-fad9-440a-944f-7bae33bca0f8"
          },
          "deactivate-payment-method" : {
            "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/83004911-fad9-440a-944f-7bae33bca0f8/deactivate"
          }
        }
      }
    }
  },
  "billingAddress" : null,
  "shippingAddress" : null,
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 18.95
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxes" : [ ],
  "taxable" : true,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "weight" : 0,
  "checkoutState" : {
    "shippingMethodValid" : true,
    "shippingMethodSelectable" : true,
    "paymentMethodValid" : true,
    "paymentMethodSelectable" : true,
    "billingAddressSet" : false,
    "priceValidToOrder" : true,
    "paymentTransactionStatus" : "NO_APPROVAL_NEEDED",
    "readyToOrder" : false
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92"
    },
    "line-items" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/line-items"
    },
    "shipping-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/shipping-methods"
    },
    "shipping-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/shipping-methods/default"
    },
    "shipping-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/shipping-methods/current"
    },
    "payment-method-available" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/payment-methods"
    },
    "payment-method-default" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/payment-methods/default"
    },
    "payment-method-current" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/payment-methods/current"
    },
    "billing-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/billing-address"
    },
    "shipping-address" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/ce252569-42e9-4085-9521-b7c16df1ca92/shipping-address"
    }
  },
  "_id" : "ce252569-42e9-4085-9521-b7c16df1ca92"
}

Show current cart shipping method details

A GET request is used to get the current shipping method. The shipping method type is documented here.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/810930b9-6599-455e-8d27-2b4de18d7b45/shipping-methods/current' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 512

{
  "name" : "Standard Shipping 1",
  "description" : "Standard Shipping",
  "taxClass" : "REGULAR",
  "position" : 0,
  "freeShippingValue" : null,
  "fixedPrice" : {
    "taxModel" : "GROSS",
    "currency" : "EUR",
    "amount" : 16.95
  },
  "weightBasedPrice" : null,
  "_id" : "ab77b1de-144d-4fd9-8f91-744496b4fda2",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/1fea0898-6a69-4e6f-989b-e16e4bdfcc3b/shipping-methods/ab77b1de-144d-4fd9-8f91-744496b4fda2"
    }
  }
}

Show applicable cart shipping method details

A GET request is used to get the applicable shipping method of a cart. The shipping method type is documented here

The selectable field indicates if a shipping method is currently selectable. Non-selectable shipping methods are currently restricted because of rules that apply to a cart. Trying to set such a shipping method as the current one of the cart will fail.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/carts/401d6b40-7846-41b9-b4e3-27a81e1ca4aa/shipping-methods' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_embedded.shipping-methods[].selectable

Boolean

Indicates if the shipping method can be selected for the current cart. A shipping method can be become non-selectable if the cart is modified, so that the maximum weight for weight based price is exceeded. A cart with a non-selectable shipping method cannot be ordered.

_embedded.shipping-methods[].lineItemPrice

Object

The calculated price for this shipping method on the current cart.

_embedded.shipping-methods[]._embedded.shipping-method._id

String

The immutable, unique identifier of the requested resource.

_embedded.shipping-methods[]._embedded.shipping-method.weightBasedPrice

Null

The price depending on the package weight.

_embedded.shipping-methods[]._embedded.shipping-method.fixedPrice

Object

The fixed price for the shipping method irrespective of weight, dimensions, etc.

_embedded.shipping-methods[]._embedded.shipping-method.position

Number

The sorting position of the shipping method in the merchant administration in relation to other shipping methods.

_embedded.shipping-methods[]._embedded.shipping-method.name

String

The name of the shipping method.

_embedded.shipping-methods[]._embedded.shipping-method.description

String

description

_embedded.shipping-methods[]._embedded.shipping-method.taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

_embedded.shipping-methods[]._embedded.shipping-method.freeShippingValue

Null

Once a customer reaches this amount (excluding payment fee) this shipping method is free of charge.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1065

{
  "_embedded" : {
    "shipping-methods" : [ {
      "lineItemPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 16.95
      },
      "selectable" : true,
      "_embedded" : {
        "shipping-method" : {
          "name" : "Standard Shipping 1",
          "description" : "Standard Shipping",
          "taxClass" : "REGULAR",
          "position" : 0,
          "freeShippingValue" : null,
          "fixedPrice" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 16.95
          },
          "weightBasedPrice" : null,
          "_id" : "b05a5497-ce80-44b6-9419-4240890651a8",
          "_links" : {
            "self" : {
              "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/37d10b15-cc6f-4084-9c52-75e5e2691b5a/shipping-methods/b05a5497-ce80-44b6-9419-4240890651a8"
            }
          }
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/carts/401d6b40-7846-41b9-b4e3-27a81e1ca4aa/shipping-methods"
    }
  }
}

Categories

The categories resource is used to manage categories of a shop.

List categories

A GET request will list all of the categories in a paged manner.

Required scopes

catg:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.categories[]._id

String

The immutable, unique identifier of the requested resource.

_embedded.categories[].name

String

The name of the product collection.

_embedded.categories[].label

String

The label of the product collection.

_embedded.categories[].type

String

The type of the product collection. Can be SMART or MANUAL.

_embedded.categories[].query

Object

The JSON query to retrieve products according to Elasticsearch Query DSL.

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1435

{
  "_embedded" : {
    "categories" : [ {
      "name" : "manual category",
      "label" : "manual-category",
      "type" : "MANUAL",
      "query" : {"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}},
      "_id" : "fcdab54c-4d36-469e-96be-797e8dfc8e5a",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/fcdab54c-4d36-469e-96be-797e8dfc8e5a"
        },
        "category" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/fcdab54c-4d36-469e-96be-797e8dfc8e5a"
        }
      }
    }, {
      "name" : "smart category",
      "label" : "smart-category",
      "type" : "SMART",
      "query" : {"bool":{"filter":[{"term":{"tags":"Men"}}]}},
      "_id" : "7e9e1e22-6b33-4837-b6a6-7f9de582778e",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/7e9e1e22-6b33-4837-b6a6-7f9de582778e"
        },
        "category" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/7e9e1e22-6b33-4837-b6a6-7f9de582778e"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "https://api-shop.beyondshop.cloud/api/profile/categories"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Create category

A POST request is used to create a category.

Required scopes

catg:c

Request body properties

Path Type Description Constraints

name

String

The name of the product collection.

Must not be empty

label

String

The label of the product collection.

type

String

The type of the product collection. Can be SMART or MANUAL.

Must not be null

query

Object

The JSON query to retrieve products according to Elasticsearch Query DSL.

Must not be null

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{"name":"MyCategory","label":"my-label","type":"SMART","query":{"bool":{"filter":[{"term":{"tags":"Men"}}]}}}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/categories/72053d6e-cf4e-49b2-a18a-ef9accc1ead4
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 180

{
  "name" : "MyCategory",
  "label" : "my-label",
  "type" : "SMART",
  "query" : {"bool":{"filter":[{"term":{"tags":"Men"}}]}},
  "_id" : "72053d6e-cf4e-49b2-a18a-ef9accc1ead4"
}

Show category details

A GET request is used to retrieve the details of a category.

Required scopes

catg:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/11087a3d-ab64-41eb-8286-50e1fae3532d' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

name

String

The name of the product collection.

label

String

The label of the product collection.

type

String

The type of the product collection. Can be SMART or MANUAL.

query

Object

The JSON query to retrieve products according to Elasticsearch Query DSL.

_id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

Links

Relation Description

category

The templated self link of the category. Current representation of the resource. See Hypermedia.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:50:08 GMT
ETag: "1"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 437

{
  "name" : "smart category",
  "label" : "smart-category",
  "type" : "SMART",
  "query" : {"bool":{"filter":[{"term":{"tags":"Men"}}]}},
  "_id" : "11087a3d-ab64-41eb-8286-50e1fae3532d",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/11087a3d-ab64-41eb-8286-50e1fae3532d"
    },
    "category" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/11087a3d-ab64-41eb-8286-50e1fae3532d"
    }
  }
}

Update all category properties

A PUT request is issued to update all category properties with application/json content type.

Required scopes

catg:u

Request body properties

Path Type Description Constraints

name

String

The name of the product collection.

Must not be empty

label

String

The label of the product collection.

type

String

The type of the product collection. Can be SMART or MANUAL.

Must not be null

query

Object

The JSON query to retrieve products according to Elasticsearch Query DSL.

Must not be null

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/30658d78-0e5c-430a-8c1e-18667c57bf4e' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"name":"updated name","label":"updated-name","type":"MANUAL","query":{"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}}}'

Response body properties

Path Type Description

name

String

The name of the product collection.

label

String

The label of the product collection.

type

String

The type of the product collection. Can be SMART or MANUAL.

query

Object

The JSON query to retrieve products according to Elasticsearch Query DSL.

_id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 509

{
  "name" : "updated name",
  "label" : "smart-category",
  "type" : "MANUAL",
  "query" : {"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}},
  "_id" : "30658d78-0e5c-430a-8c1e-18667c57bf4e",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/30658d78-0e5c-430a-8c1e-18667c57bf4e"
    },
    "category" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/30658d78-0e5c-430a-8c1e-18667c57bf4e"
    }
  }
}

Update category partially (json patch)

A PATCH request is issued to update a category partially with json patch content type.

Required scopes

catg:u

Request body properties

Path Type Description

.[]

Array

A list of JSON Patch operations.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/0d3a2b97-610e-4b81-9ad7-14644d14f743' -i -X PATCH -H 'Content-Type: application/json-patch+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '[{"op":"test","path":"/name","value":"smart category"},{"op":"replace","path":"/name","value":"patched name"},{"op":"replace","path":"/type","value":"MANUAL"},{"op":"replace","path":"/query","value":{"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}}}]'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "2"
Last-Modified: Thu, 07 Dec 2017 13:50:20 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 509

{
  "name" : "patched name",
  "label" : "smart-category",
  "type" : "MANUAL",
  "query" : {"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}},
  "_id" : "0d3a2b97-610e-4b81-9ad7-14644d14f743",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/0d3a2b97-610e-4b81-9ad7-14644d14f743"
    },
    "category" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/0d3a2b97-610e-4b81-9ad7-14644d14f743"
    }
  }
}

Update category partially (json)

A PATCH request is issued to update a category partially with json content type.

Required scopes

catg:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/5f78df7c-91e5-4c3f-b8fc-2eecbbc275de' -i -X PATCH -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"name":"patched name","type":"MANUAL","query":{"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}}}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "2"
Last-Modified: Thu, 07 Dec 2017 13:50:22 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 509

{
  "name" : "patched name",
  "label" : "smart-category",
  "type" : "MANUAL",
  "query" : {"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}},
  "_id" : "5f78df7c-91e5-4c3f-b8fc-2eecbbc275de",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/5f78df7c-91e5-4c3f-b8fc-2eecbbc275de"
    },
    "category" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/5f78df7c-91e5-4c3f-b8fc-2eecbbc275de"
    }
  }
}

Delete category

A DELETE request is used to delete a category.

Required scopes

catg:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/dec10c29-140c-4839-888e-2a84d9499caf' -i -X DELETE -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

List category meta-information

The categories resource offers API meta-information if you follow the profile link.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/profile/categories' -i

Example response

HTTP/1.1 200 OK
Content-Type: application/alps+json;charset=UTF-8
Content-Length: 1931

{
  "alps" : {
    "version" : "1.0",
    "descriptors" : [ {
      "id" : "category-representation",
      "href" : "https://api-shop.beyondshop.cloud/api/profile/categories",
      "descriptors" : [ {
        "name" : "name",
        "type" : "SEMANTIC"
      }, {
        "name" : "label",
        "type" : "SEMANTIC"
      }, {
        "name" : "type",
        "doc" : {
          "value" : "SMART, MANUAL",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      }, {
        "name" : "_id",
        "type" : "SEMANTIC"
      } ]
    }, {
      "id" : "create-categories",
      "name" : "categories",
      "type" : "UNSAFE",
      "rt" : "#category-representation"
    }, {
      "id" : "get-categories",
      "name" : "categories",
      "type" : "SAFE",
      "rt" : "#category-representation",
      "descriptors" : [ {
        "name" : "page",
        "doc" : {
          "value" : "The page to return.",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      }, {
        "name" : "size",
        "doc" : {
          "value" : "The size of the page to return.",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      }, {
        "name" : "sort",
        "doc" : {
          "value" : "The sorting criteria to use to calculate the content of the page.",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      } ]
    }, {
      "id" : "patch-category",
      "name" : "category",
      "type" : "UNSAFE",
      "rt" : "#category-representation"
    }, {
      "id" : "delete-category",
      "name" : "category",
      "type" : "IDEMPOTENT",
      "rt" : "#category-representation"
    }, {
      "id" : "get-category",
      "name" : "category",
      "type" : "SAFE",
      "rt" : "#category-representation"
    }, {
      "id" : "update-category",
      "name" : "category",
      "type" : "IDEMPOTENT",
      "rt" : "#category-representation"
    } ]
  }
}

Show product category details

A GET request is used to retrieve the details of a product category.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/11087a3d-ab64-41eb-8286-50e1fae3532d' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

name

String

The name of the product collection.

label

String

The label of the product collection.

type

String

The type of the product collection. Can be SMART or MANUAL.

query

Object

The JSON query to retrieve products according to Elasticsearch Query DSL.

_id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

Links

Relation Description

category

The templated self link of the category. Current representation of the resource. See Hypermedia.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:50:08 GMT
ETag: "1"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 437

{
  "name" : "smart category",
  "label" : "smart-category",
  "type" : "SMART",
  "query" : {"bool":{"filter":[{"term":{"tags":"Men"}}]}},
  "_id" : "11087a3d-ab64-41eb-8286-50e1fae3532d",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/11087a3d-ab64-41eb-8286-50e1fae3532d"
    },
    "category" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/11087a3d-ab64-41eb-8286-50e1fae3532d"
    }
  }
}

Show enhanced view of product category details

A GET request is used to retrieve enhanced details of a product category .

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/89a7031f-1f91-4284-bc55-5d49abd8d687?projection=enhancedCategoryProjection' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_id

String

The unique identifier of the category.

_indexedAt

String

The time of storing this document in the search index.

name

String

The name of the category.

label

String

The label of the category.

type

String

The type of the category. Can be SMART or MANUAL.

_links

Object

See Hypermedia

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 578

{
  "_id" : "89a7031f-1f91-4284-bc55-5d49abd8d687",
  "_indexedAt" : "2017-12-07T13:51:33.776",
  "type" : "SMART",
  "name" : "Category A",
  "label" : "category-a",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/89a7031f-1f91-4284-bc55-5d49abd8d687"
    },
    "category" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/89a7031f-1f91-4284-bc55-5d49abd8d687{?projection}",
      "templated" : true
    },
    "products" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/89a7031f-1f91-4284-bc55-5d49abd8d687/products"
    }
  }
}

List product categories

A GET request will list all product categories.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.categories[]._id

String

The immutable, unique identifier of the requested resource.

_embedded.categories[].name

String

The name of the product collection.

_embedded.categories[].label

String

The label of the product collection.

_embedded.categories[].type

String

The type of the product collection. Can be SMART or MANUAL.

_embedded.categories[].query

Object

The JSON query to retrieve products according to Elasticsearch Query DSL.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1435

{
  "_embedded" : {
    "categories" : [ {
      "name" : "manual category",
      "label" : "manual-category",
      "type" : "MANUAL",
      "query" : {"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}},
      "_id" : "fcdab54c-4d36-469e-96be-797e8dfc8e5a",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/fcdab54c-4d36-469e-96be-797e8dfc8e5a"
        },
        "category" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/fcdab54c-4d36-469e-96be-797e8dfc8e5a"
        }
      }
    }, {
      "name" : "smart category",
      "label" : "smart-category",
      "type" : "SMART",
      "query" : {"bool":{"filter":[{"term":{"tags":"Men"}}]}},
      "_id" : "7e9e1e22-6b33-4837-b6a6-7f9de582778e",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/7e9e1e22-6b33-4837-b6a6-7f9de582778e"
        },
        "category" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/7e9e1e22-6b33-4837-b6a6-7f9de582778e"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "https://api-shop.beyondshop.cloud/api/profile/categories"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

List products

A GET request will list all products of a category.

Response structure See category list structure.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/1f96ef6c-b086-4d7e-be5c-93012acf7d03/products' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1503

{
  "_embedded" : {
    "products" : [ {
      "_id" : "83096b56-f316-4024-90eb-233d85b8560e",
      "sku" : "f3970cc2-62f8-4efc-93c7-7268f77af50d",
      "name" : "Funky Trousers",
      "salesPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "listPrice" : null,
      "onSale" : false,
      "listPriceText" : null,
      "shippingDimension" : {
        "length" : 16,
        "width" : 17,
        "height" : 18
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/83096b56-f316-4024-90eb-233d85b8560e"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/83096b56-f316-4024-90eb-233d85b8560e{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/1f96ef6c-b086-4d7e-be5c-93012acf7d03/products?page=0&size=40&sort=id,asc"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

List product categories assigned to product

A GET request returns a list of all product categories a product is part of.

Response structure See category list structure.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/search/find-by-product?productId=221f56bc-54ef-485b-8947-206f0e091238' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1578

{
  "_embedded" : {
    "categories" : [ {
      "type" : "SMART",
      "name" : "category that loves everyone",
      "label" : null,
      "_id" : "8b24f410-5a3c-475f-8892-4fdcbffdf7c1",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/8b24f410-5a3c-475f-8892-4fdcbffdf7c1"
        },
        "category" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/8b24f410-5a3c-475f-8892-4fdcbffdf7c1{?projection}",
          "templated" : true
        },
        "products" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/8b24f410-5a3c-475f-8892-4fdcbffdf7c1/products"
        }
      }
    }, {
      "type" : "MANUAL",
      "name" : "category that matches product 1 in a complicated way",
      "label" : null,
      "_id" : "34e55864-bbd0-43a2-8493-016cec9fb69a",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/34e55864-bbd0-43a2-8493-016cec9fb69a"
        },
        "category" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/34e55864-bbd0-43a2-8493-016cec9fb69a{?projection}",
          "templated" : true
        },
        "products" : {
          "href" : "https://api-shop.beyondshop.cloud/api/categories/34e55864-bbd0-43a2-8493-016cec9fb69a/products"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/search/find-by-product?productId=221f56bc-54ef-485b-8947-206f0e091238&page=0&size=40"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Find product category by label

A GET request is used to find a product category by its unique label.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/categories/search/find-by-label?label=category-a' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_id

String

The unique identifier of the category.

name

String

The name of the category.

label

String

The label of the category.

type

String

The type of the category. Can be SMART or MANUAL.

_links

Object

See Hypermedia

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 534

{
  "type" : "SMART",
  "name" : "Category A",
  "label" : "category-a",
  "_id" : "f7cd5466-c4f6-4467-b902-20527101f616",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/f7cd5466-c4f6-4467-b902-20527101f616"
    },
    "category" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/f7cd5466-c4f6-4467-b902-20527101f616{?projection}",
      "templated" : true
    },
    "products" : {
      "href" : "https://api-shop.beyondshop.cloud/api/categories/f7cd5466-c4f6-4467-b902-20527101f616/products"
    }
  }
}

Google Shopping

Access Data

Create access data

The access data is required by the service to authenticate against Google Shopping.

Use a POST request to create access data.

Required scopes

gsad:c

Request body properties

Path Type Description Constraints

merchantId

String

The unique identifier for the Google account that the merchant uses for Google Shopping.

redirectUri

String

The URI to which the merchant will be redirected after the confirmation of the Google API access consent dialog.

Not a valid URI

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/access-data' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "merchantId" : "1168736784",
  "redirectUri" : "http://2020.beyondshop.cloud/merchant-ui"
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/access-data/bbcfec5c-3747-47d5-a13e-a2a5ae692865
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 363

{
  "authorizeUrl" : "https://google-auth.com/o/oauth2/auth?access_type=offline&client_id=client_id&redirect_uri=http://system.epages.works/api/google-shopping/nonce&response_type=code&scope=https://www.googleapis.com/auth/content+https://www.googleapis.com/auth/siteverification&state=bd828178-d150-45bc-8ae4-6cf48bc880c2",
  "nonceExpirationDate" : 1512728961
}

Show access data details

Use a GET request to retrieve the access data details.

Required scopes

gsad:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/access-data' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

merchantId

String

The unique identifier for the Google account that the merchant uses for Google Shopping.

tokenExpirationDate

Number

The expiration date of the access token. Displayed in seconds since the start of the Epoch. Refer to RFC 7519.

hasRefreshToken

Boolean

Indicates if a refresh token for the Google API is stored. Can be true or false.

hasAccessToken

Boolean

Indicates if an access token for the Google API is stored. Can be true or false.

_id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

Links

Relation Description

access-data

The access data to authenticate with the Google Shopping API.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 433

{
  "merchantId" : "merchantId",
  "tokenExpirationDate" : 123456789,
  "_id" : "96276744-348e-4492-a9d0-504665fb793b",
  "hasAccessToken" : true,
  "hasRefreshToken" : true,
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/access-data/96276744-348e-4492-a9d0-504665fb793b"
    },
    "access-data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/access-data{?page,size,sort}",
      "templated" : true
    }
  }
}

Update access data (PUT)

Use a PUT request to update the access data.

Required scopes

gsad:u

Request body properties

Path Type Description Constraints

merchantId

String

The unique identifier for the Google account that the merchant uses for Google Shopping.

Must not be null

accessToken

String

The encoded access token retrieved from the Google Authorization Server to access the Google API.

refreshToken

String

The refresh token retrieved from the Google Authorization Server to obtain a renewed access token.

tokenExpirationDate

Number

The expiration date of the access token. Displayed in seconds since the start of the Epoch. Refer to RFC 7519.

Must be at least 0 and at most 9223372036854775807

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/access-data/cdf3dee2-cc1b-4318-bcd2-9804a53eee85' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "merchantId" : "123456789",
  "refreshToken" : "your refresh token",
  "accessToken" : "your access token",
  "tokenExpirationDate" : 123456789
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 433

{
  "merchantId" : "merchantId",
  "tokenExpirationDate" : 123456789,
  "_id" : "cdf3dee2-cc1b-4318-bcd2-9804a53eee85",
  "hasAccessToken" : true,
  "hasRefreshToken" : true,
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/access-data/cdf3dee2-cc1b-4318-bcd2-9804a53eee85"
    },
    "access-data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/access-data{?page,size,sort}",
      "templated" : true
    }
  }
}

Update access data partially (json patch)

Use a PATCH request to partially update the access data.

Required scopes

gsad:u

Request body properties

Path Type Description

op

String

The PATCH operation to perform to update the access data.

path

String

Contains the value that references the location where the operation is performed.

value

String

The new value to apply for the the given path.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/access-data/e8363767-563f-4a9e-803c-deefeed40542' -i -X PATCH -H 'Content-Type: application/json-patch+json' -H 'Authorization: Bearer <Access token>' -d '{
  "op" : "replace",
  "path" : "/merchantId",
  "value" : "12345789"
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 433

{
  "merchantId" : "merchantId",
  "tokenExpirationDate" : 123456789,
  "_id" : "e8363767-563f-4a9e-803c-deefeed40542",
  "hasAccessToken" : true,
  "hasRefreshToken" : true,
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/access-data/e8363767-563f-4a9e-803c-deefeed40542"
    },
    "access-data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/access-data{?page,size,sort}",
      "templated" : true
    }
  }
}

Delete access data

Use a DELETE request to delete the access data.

Required scopes

gsad:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/access-data' -i -X DELETE -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Products

Assign product to Google

In order to assign a product to Google, first a Google product has to be created.

Use a POST request to assign a product to Google.

Required scopes

gspr:c

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products' -i -X POST -H 'Content-Type: text/uri-list' -H 'Authorization: Bearer <Access token>' -d 'https://api-shop.beyondshop.cloud/api/api/products/c268db8c-5bd9-45c9-86d0-2de81932c591
https://api-shop.beyondshop.cloud/api/api/products/c8c4272c-d698-448b-b28a-599d1486b5a1
https://api-shop.beyondshop.cloud/api/api/products/c79f3789-08d7-4211-ba4d-749fba15ec4a
https://api-shop.beyondshop.cloud/api/api/products/c48c25e4-ed38-40fd-a546-46c1c20bb48e
https://api-shop.beyondshop.cloud/api/api/products/09294fb3-813a-45aa-9976-c2caed75a088
'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products

List products

Use a GET request to retrieve a list of all products assigned to Google Shopping.

Required scopes

gspr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

page

Object

See Pagination

_embedded.products[].visible

Boolean

Indicates if the product is visible in Google Shopping. Can be true or false.

_embedded.products[].category

Number

The category number as defined in the Google taxonomy.

_embedded.products[].status

Object

The status of the product upload process.

_embedded.products[].status.type

String

The status type of the product upload process. Can be START, INCOMPLETE, PENDING, ERROR, UPLOADED or UPLOADED_WITH_NOTIFICATIONS.

_embedded.products[].status.errorMessage

Null

The error message for an error that appears during the product upload process. Is null for INCOMPLETE, PENDING, UPLOADED.

_embedded.products[].parentId

String

The unique identifier of the related original product.

_embedded.products[]._id

String

The immutable, unique identifier of the requested resource.

_embedded.products[]._links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3654

{
  "_embedded" : {
    "products" : [ {
      "visible" : true,
      "category" : 123456,
      "status" : {
        "type" : "INCOMPLETE",
        "errorMessage" : null
      },
      "_id" : "0fbd52e3-911f-43a6-9e3e-16709ee52e77",
      "parentId" : "6edccd39-5023-43a2-9642-37234f4eaa53",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/0fbd52e3-911f-43a6-9e3e-16709ee52e77"
        },
        "products" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
          "templated" : true
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/products/27523224-44e7-4bda-b963-c771071f43a3"
        }
      }
    }, {
      "visible" : true,
      "category" : 123456,
      "status" : {
        "type" : "INCOMPLETE",
        "errorMessage" : null
      },
      "_id" : "1f1903a2-9063-4615-8bf5-3ccacd1cdfda",
      "parentId" : "0efd4036-4945-42b2-ac11-1d7d02a34b08",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/1f1903a2-9063-4615-8bf5-3ccacd1cdfda"
        },
        "products" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
          "templated" : true
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/products/8d713115-018b-4ebd-a6f5-19815190ee26"
        }
      }
    }, {
      "visible" : true,
      "category" : 123456,
      "status" : {
        "type" : "INCOMPLETE",
        "errorMessage" : null
      },
      "_id" : "51e4956a-9d62-44c6-a45a-92f256410234",
      "parentId" : "9db9a589-c992-488e-8394-c6195242a37d",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/51e4956a-9d62-44c6-a45a-92f256410234"
        },
        "products" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
          "templated" : true
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/products/f917b266-b4df-44bc-89fb-0c4331b55508"
        }
      }
    }, {
      "visible" : true,
      "category" : 123456,
      "status" : {
        "type" : "INCOMPLETE",
        "errorMessage" : null
      },
      "_id" : "6a1027e8-008b-43f2-b700-a2271ca57004",
      "parentId" : "25395f36-8d87-45d8-87f2-5ae6dfb7a914",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/6a1027e8-008b-43f2-b700-a2271ca57004"
        },
        "products" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
          "templated" : true
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/products/ee3082f1-63dd-48e7-b210-6b50b0680457"
        }
      }
    }, {
      "visible" : true,
      "category" : 123456,
      "status" : {
        "type" : "INCOMPLETE",
        "errorMessage" : null
      },
      "_id" : "cc4a5972-ceaa-4ca4-83f8-49e4f38561f6",
      "parentId" : "f47a76d5-34fc-470e-8384-eefd74849050",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/cc4a5972-ceaa-4ca4-83f8-49e4f38561f6"
        },
        "products" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
          "templated" : true
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/products/f2d8e9c9-d698-4d36-ae86-35bc08ab433a"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
      "templated" : true
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

Show product details

Use a GET request to retrieve the details of a product assigned to Google Shopping.

Required scopes

gspr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/3af1ec93-dac4-4721-86a0-87217c45082f' -i -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

visible

Boolean

Indicates if the product is visible in Google Shopping. Can be true or false.

category

Number

The category number as defined in the Google taxonomy.

status

Object

The status of the product upload process.

status.type

String

The status type of the product upload process. Can be START, INCOMPLETE, PENDING, ERROR, UPLOADED or UPLOADED_WITH_NOTIFICATIONS.

status.errorMessage

Null

The error message for an error that appears during the product upload process. Is null for INCOMPLETE, PENDING, UPLOADED.

parentId

String

The unique identifier of the related original product.

_id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

Links

Relation Description

product

The link to the original product.

products

The products that match a product to a Google offer.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 586

{
  "visible" : true,
  "category" : 123456,
  "status" : {
    "type" : "PENDING",
    "errorMessage" : null
  },
  "_id" : "3af1ec93-dac4-4721-86a0-87217c45082f",
  "parentId" : "141a53ab-0ce9-41ca-8761-e6643c5dc169",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/3af1ec93-dac4-4721-86a0-87217c45082f"
    },
    "products" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
      "templated" : true
    },
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/products/de4ffcb8-cc71-4fc9-9372-4e3d7cab36ae"
    }
  }
}

Update product

Use a PUT request to update a product in Google Shopping.

Required scopes

gspr:u

Request body properties

Path Type Description Constraints

visible

Boolean

Indicates if the product is visible in Google Shopping. Can be true or false.

category

Number

The category number as defined in the Google taxonomy.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/77ce0903-62d0-415c-85d1-dd2832197881' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "category" : 111,
  "visible" : true
}'

Response body properties

Path Type Description

visible

Boolean

Indicates if the product is visible in Google Shopping. Can be true or false.

category

Number

The category number as defined in the Google taxonomy.

status

Object

The status of the product upload process.

status.type

String

The status type of the product upload process. Can be START, INCOMPLETE, PENDING, ERROR, UPLOADED or UPLOADED_WITH_NOTIFICATIONS.

status.errorMessage

Null

The error message for an error that appears during the product upload process. Is null for INCOMPLETE, PENDING, UPLOADED.

parentId

String

The unique identifier of the related original product.

_id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 583

{
  "visible" : true,
  "category" : 111,
  "status" : {
    "type" : "PENDING",
    "errorMessage" : null
  },
  "_id" : "77ce0903-62d0-415c-85d1-dd2832197881",
  "parentId" : "7b8e834f-bf08-4ef1-bdf5-0f7503c829ff",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/77ce0903-62d0-415c-85d1-dd2832197881"
    },
    "products" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products{?page,size,sort}",
      "templated" : true
    },
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/products/30817973-750e-4bd9-bd23-1a9b114616c9"
    }
  }
}

Delete product

Use a PUT request to delete a product from Google Shopping.

Required scopes

gspr:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/d77ae773-fec8-40d2-850b-663f5416ffb6' -i -X DELETE -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Taxonomy

List taxonomy

The taxonomy contains the available Google categories to be assigned to a product to upload to Google.

Use a GET request to retrieve the current taxonomy from Google.

Request parameters

Parameter Description

locale

The locale determining the localization context, i.e. the language of the Google taxonomy.

Request header properties

Name Description

if-modified-since

The date of the last successful retrieval of the Google taxonomy. Optional. If not set the current version of the Google taxonomy is always returned.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/taxonomy?locale=de-DE' -i -H 'if-modified-since: Thu, 07 Dec 2016 01:00:57 GMT'

Response body properties

Path Type Description

_embedded.googleCategories

Array

The list of Google Shopping categories.

_embedded.googleCategories[].categoryId

Number

The Google Shopping category id.

_embedded.googleCategories[].categoryName

String

The Google Shopping category name.

_embedded.googleCategories[].children

Array

The subcategories of the Google Shopping category.

_links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
Last-Modified: Thu, 08 Dec 2016 01:00:57 GMT
Content-Type: application/json
Content-Length: 605

{
  "_embedded" : {
    "googleCategories" : [ {
      "categoryId" : 1,
      "categoryName" : "Category1",
      "children" : [ ]
    }, {
      "categoryId" : 2,
      "categoryName" : "Category2",
      "children" : [ ]
    }, {
      "categoryId" : 3,
      "categoryName" : "Category3",
      "children" : [ ]
    }, {
      "categoryId" : 4,
      "categoryName" : "Category4",
      "children" : [ ]
    }, {
      "categoryId" : 5,
      "categoryName" : "Category5",
      "children" : [ ]
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/taxonomy"
    }
  }
}

Site Verification Token

Retrieve site verification token

The site verification token required to verify that a shop really belongs to that specific merchant. The site verification token has to be available on the storefront, in order for Google to know that this site really belongs to the Google Shopping merchant.

Use a GET request to retrieve the site verification token.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/site-verification' -i

Response body properties

Path Type Description

token

String

The site verification token required to verify that a shop really belongs to that specific merchant.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 38

{
  "token" : "<verification token>"
}

Orders

Order number configuration

This resource gives the merchant control over the structure of order numbers.

A prefix can be defined for the order number as well as a numeric suffix to start counting from. The length of the numeric suffix can also be configured.

Such a configuration

  • prefix = 2017-shop-

  • next numeric suffix = 1000

  • numeric suffix length = 5

results in an order number like 2017-shop-01000. Where the numeric suffix is increased for every order.

Show order number configuration details

A GET request is used to retrieve the order number configuration for the current shop.

Required scopes

ordn:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/configuration/order-number' -i -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

stringPrefix

String

prefix attached to all order numbers

nextNumericSuffix

Number

the next numeric suffix used for the next order. This value is incremented after each order creation

numericSuffixLength

Number

the length of the numeric part of the order number. If the numeric value is shorter, the value is padded with zeros to the left. If the value is longer the numericSuffixLength is extended

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 195

{
  "stringPrefix" : "",
  "nextNumericSuffix" : 10001,
  "numericSuffixLength" : 5,
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/configuration/order-number"
    }
  }
}

Update complete order number configuration

A PUT request is used to update the complete order number configuration for the current shop.

Required scopes

ordn:u

Request body properties

Path Type Description Constraints

stringPrefix

String

prefix attached to all order numbers

Must not be null. Size must be between 0 and 20 inclusive

nextNumericSuffix

Number

the next numeric suffix used for the next order. This value is incremented after each order creation

Must be greater than 0 and less than 9223372036854775807

numericSuffixLength

Number

the length of the numeric part of the order number. If the numeric value is shorter, the value is padded with zeros to the left. If the value is longer the numericSuffixLength is extended

Must be greater than 0 and less than 20

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/configuration/order-number' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "stringPrefix" : "2017-shop-",
  "nextNumericSuffix" : 10000,
  "numericSuffixLength" : 4
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 205

{
  "stringPrefix" : "2017-shop-",
  "nextNumericSuffix" : 10000,
  "numericSuffixLength" : 4,
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/configuration/order-number"
    }
  }
}

Update order number configuration partially

A PATCH request is used to update parts of the order number configuration for the current shop.

Patch can be applied using json-patch or plain json.

All fields updatable via PUT can be updated using patch

Required scopes

ordn:u

Request body properties

Path Type Description

[]

Array

list of json patch operations as defined in https://tools.ietf.org/html/rfc6902.All fields updatable via PUT can be updated using patch

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/configuration/order-number' -i -X PATCH -H 'Content-Type: application/json-patch+json' -H 'Authorization: Bearer <Access token>' -d '[ {
  "op" : "replace",
  "path" : "/stringPrefix",
  "value" : "2017-shop-"
}, {
  "op" : "replace",
  "path" : "/nextNumericSuffix",
  "value" : 20000
} ]'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 205

{
  "stringPrefix" : "2017-shop-",
  "nextNumericSuffix" : 20000,
  "numericSuffixLength" : 5,
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/configuration/order-number"
    }
  }
}

Required scopes

ordn:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/configuration/order-number' -i -X PATCH -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "stringPrefix" : "2017-shop-",
  "nextNumericSuffix" : 20000
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 205

{
  "stringPrefix" : "2017-shop-",
  "nextNumericSuffix" : 20000,
  "numericSuffixLength" : 5,
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/configuration/order-number"
    }
  }
}

The orders resource is used to manage the orders of a shop.

List orders

A GET request will list all of the orders of the shop in a paged way. Each item in the response represents a summary of the order data.

Required scopes

ordr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.orders[]

Array

The list of orders as documented in Show order details.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 11548

{
  "_embedded" : {
    "orders" : [ {
      "_id" : "512a8ceb-67f0-4980-afdb-d07617619271",
      "createdAt" : "2017-12-06T12:10:29.936",
      "cartId" : "95c40dfb-2e65-4f54-b01d-cdb183d995c6",
      "currency" : "EUR",
      "taxModel" : "GROSS",
      "taxable" : false,
      "testOrder" : false,
      "productLineItems" : [ {
        "product" : {
          "sku" : "1004",
          "name" : "White Sofa",
          "essentialFeatures" : null,
          "shippingWeight" : null,
          "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "_id" : "9a8ba975-599c-46a8-a53a-3f387eec531c",
          "_links" : {
            "default-image-data" : {
              "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
              "templated" : true
            }
          }
        },
        "quantity" : {
          "value" : 3,
          "unit" : "PIECE"
        },
        "quantityInt" : 3,
        "initialQuantity" : 3,
        "unitPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 2.5
        },
        "lineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 7.5
        },
        "initialLineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 7.5
        },
        "lineItemTax" : {
          "taxClass" : "REGULAR",
          "taxRate" : 0.19,
          "currency" : "EUR",
          "amount" : 1.197
        },
        "unshipped" : {
          "quantity" : 3,
          "amount" : null
        },
        "shipped" : {
          "quantity" : 0,
          "amount" : null
        },
        "pending" : {
          "quantity" : 0,
          "amount" : null
        },
        "returned" : {
          "quantity" : 0,
          "amount" : {
            "currency" : "EUR",
            "amount" : 0
          }
        },
        "broken" : {
          "quantity" : 0,
          "amount" : {
            "currency" : "EUR",
            "amount" : 0
          }
        },
        "canceled" : {
          "quantity" : 0,
          "amount" : {
            "currency" : "EUR",
            "amount" : 0
          }
        },
        "_id" : "5dff1f4c-5204-47a3-b364-5995ea3944cb"
      }, {
        "product" : {
          "sku" : "1018",
          "name" : "Decorative Sand (2 kg Jumbo Pack)",
          "essentialFeatures" : "Not suitable for children under the age of 8.",
          "shippingWeight" : 2000,
          "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "_id" : "f6ffeb00-c611-4e1f-a653-d99ac6850867",
          "_links" : {
            "default-image-data" : {
              "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
              "templated" : true
            }
          }
        },
        "quantity" : {
          "value" : 5,
          "unit" : "PIECE"
        },
        "quantityInt" : 5,
        "initialQuantity" : 5,
        "unitPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 9.99
        },
        "lineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 49.95
        },
        "initialLineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 49.95
        },
        "lineItemTax" : {
          "taxClass" : "REGULAR",
          "taxRate" : 0.19,
          "currency" : "EUR",
          "amount" : 7.9743
        },
        "unshipped" : {
          "quantity" : 5,
          "amount" : null
        },
        "shipped" : {
          "quantity" : 0,
          "amount" : null
        },
        "pending" : {
          "quantity" : 0,
          "amount" : null
        },
        "returned" : {
          "quantity" : 0,
          "amount" : {
            "currency" : "EUR",
            "amount" : 0
          }
        },
        "broken" : {
          "quantity" : 0,
          "amount" : {
            "currency" : "EUR",
            "amount" : 0
          }
        },
        "canceled" : {
          "quantity" : 0,
          "amount" : {
            "currency" : "EUR",
            "amount" : 0
          }
        },
        "_id" : "cf127971-0db4-4640-9b1e-aad4a053883a"
      } ],
      "shippingLineItem" : {
        "lineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "initialLineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "taxClass" : "REGULAR",
        "shippingMethod" : {
          "name" : "Standard Shipping",
          "description" : "Standard Shipping",
          "freeShippingValue" : {
            "currency" : "EUR",
            "amount" : 100
          },
          "fixedPrice" : {
            "taxModel" : "GROSS",
            "currency" : "EUR",
            "amount" : 16.95
          },
          "weightBasedPrice" : null
        },
        "lineItemTaxes" : [ {
          "taxClass" : "REGULAR",
          "taxRate" : 0.19,
          "currency" : "EUR",
          "amount" : 2.7056
        } ]
      },
      "paymentLineItem" : {
        "lineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "initialLineItemPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "taxClass" : "REGULAR",
        "paymentMethod" : {
          "name" : "PayPal",
          "description" : "Pay with PayPal",
          "discountOrFee" : {
            "type" : "ABSOLUTE",
            "absoluteValue" : {
              "taxModel" : "GROSS",
              "currency" : "EUR",
              "amount" : 0
            },
            "percentageValue" : null
          },
          "onlinePayment" : false
        },
        "lineItemTaxes" : [ {
          "taxClass" : "REGULAR",
          "taxRate" : 0.19,
          "currency" : "EUR",
          "amount" : 0
        } ]
      },
      "subtotal" : {
        "currency" : "EUR",
        "amount" : 57.45
      },
      "grandTotal" : {
        "currency" : "EUR",
        "amount" : 74.4
      },
      "balanceDue" : {
        "currency" : "EUR",
        "amount" : 74.4
      },
      "netTotal" : {
        "currency" : "EUR",
        "amount" : 65.2287
      },
      "taxTotal" : {
        "currency" : "EUR",
        "amount" : 9.1713
      },
      "initialSubtotal" : {
        "currency" : "EUR",
        "amount" : 57.45
      },
      "initialGrandTotal" : {
        "currency" : "EUR",
        "amount" : 74.4
      },
      "initialBalanceDue" : {
        "currency" : "EUR",
        "amount" : 74.4
      },
      "initialNetTotal" : {
        "currency" : "EUR",
        "amount" : 65.2287
      },
      "initialTaxTotal" : {
        "currency" : "EUR",
        "amount" : 9.1713
      },
      "taxes" : [ {
        "taxClass" : "REGULAR",
        "taxRate" : 0.19,
        "currency" : "EUR",
        "amount" : 9.1713
      } ],
      "shippingAddress" : {
        "salutation" : "Mrs",
        "gender" : "FEMALE",
        "company" : "Astrid Alster GmbH",
        "title" : null,
        "firstName" : "Astrid",
        "middleName" : "Agnes",
        "lastName" : "Alster",
        "street" : "Alsterwasserweg",
        "houseNumber" : "2",
        "street2" : "1st floor",
        "addressExtension" : "c/o Astrid Alster",
        "postalCode" : "20999",
        "city" : "Alsterwasser",
        "country" : "DE",
        "state" : "Hamburg",
        "email" : "a@example.com",
        "phone" : "(800) 555-0100",
        "mobile" : "(800) 555-0101",
        "doorCode" : "456",
        "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
      },
      "billingAddress" : {
        "salutation" : "Mrs",
        "gender" : "FEMALE",
        "company" : "Astrid Alster GmbH",
        "title" : null,
        "firstName" : "Astrid",
        "middleName" : "Agnes",
        "lastName" : "Alster",
        "street" : "Alsterwasserweg",
        "houseNumber" : "2",
        "street2" : "1st floor",
        "addressExtension" : "c/o Astrid Alster",
        "postalCode" : "20999",
        "city" : "Alsterwasser",
        "country" : "DE",
        "state" : "Hamburg",
        "email" : "a@example.com",
        "phone" : "(800) 555-0100",
        "mobile" : "(800) 555-0101",
        "vatId" : "DE123456789",
        "taxNumber" : "HRE 987654/32123/864516",
        "birthDate" : "1985-05-11",
        "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
      },
      "orderStatus" : "OPEN",
      "paymentStatus" : "UNPAID",
      "fulfillmentStatus" : "OPEN",
      "orderNumber" : "10001",
      "customerComment" : null,
      "orderNote" : "not paid yet",
      "entryDate" : "2017-12-06T12:10:29.936",
      "totalReceived" : {
        "currency" : "EUR",
        "amount" : 0
      },
      "totalRefunded" : {
        "currency" : "EUR",
        "amount" : 0
      },
      "openAmount" : {
        "currency" : "EUR",
        "amount" : 74.4
      },
      "marketingChannel" : "Google shopping",
      "marketingSubchannel" : "Some category",
      "salesChannel" : "Storefront",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271"
        },
        "order" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271"
        },
        "order-status" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271/order-status"
        },
        "fulfillment-status" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271/fulfillment-status"
        },
        "payment-status" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271/payment-status"
        },
        "order-status-log" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271/order-status-log"
        },
        "order-note" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271/order-note"
        },
        "processes" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271/processes"
        },
        "events" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/512a8ceb-67f0-4980-afdb-d07617619271/events"
        },
        "order-receipt-pdf" : {
          "href" : "https://api-shop.beyondshop.cloud/api/order.receipt/uri.pdf"
        },
        "terms-and-conditions-pdf" : {
          "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
        },
        "right-of-withdrawal-pdf" : {
          "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Show order details

A GET request is used to retrieve the details of an order.

Required scopes

ordr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The unique identifier of the order.

cartId

String

The ID of the cart this order has been created from (if existing).

createdAt

String

The date and time the order was technically created in the system. According to ISO 8601. Can deviate from entryDate, e.g. because the order was originally created earlier/in another system.

entryDate

String

The date and time of the actual creation date of this order from a business perspective. Can deviate from createdAt.

currency

String

The currency in which the order was entered.

taxModel

String

The tax model that applies for this order.

taxable

Boolean

Indicates if a tax applies for this order. Can be true or false.

testOrder

Boolean

Indicates if this order is a test order. Can be true or false.

orderNumber

String

The order number generated by the order service.

customerComment

Null

A comment from the customer regarding their order.

salesChannel

String

The sales channel of this order.

marketingChannel

String

The marketing channel of this order.

marketingSubchannel

String

The marketing subchannel of this order.

productLineItems[].quantity.value

Number

The value of the quantity for the product line item.

productLineItems[].quantity.unit

String

The unit corresponding to the quantity for the product line item.

productLineItems[].quantityInt

Number

The value of the quantity for the product line item.

productLineItems[].initialQuantity

Number

The initial quantity for the product line item.

productLineItems[].unitPrice.amount

Number

The amount of the unit price for the product line item.

productLineItems[].unitPrice.currency

String

The currency of the single product line item price.

productLineItems[].unitPrice.taxModel

String

The tax model of the unit price for a product line item.

productLineItems[].lineItemPrice.amount

Number

The amount of the line item price for a product line item.

productLineItems[].lineItemPrice.currency

String

The currency of the line item price for a product line item.

productLineItems[].lineItemPrice.taxModel

String

The tax model of the line item price for a product line item.

productLineItems[].initialLineItemPrice.amount

Number

The initial amount of the line item price for a product line item.

productLineItems[].initialLineItemPrice.currency

String

The currency of the initial line item price for a product line item.

productLineItems[].initialLineItemPrice.taxModel

String

The tax model of the initial line item price for a product line item.

productLineItems[].lineItemTax.taxRate

Number

The tax rate of a product line item.

productLineItems[].lineItemTax.taxClass

String

The tax class of a product line item.

productLineItems[].lineItemTax.amount

Number

The tax amount of a product line item.

productLineItems[].lineItemTax.currency

String

The currency of the tax for a product line item.

productLineItems[].product._id

String

The ID of the product for this product line item.

productLineItems[].product.sku

String

The stock keeping unit (SKU) corresponding to the product in this product line item.

productLineItems[].product.name

String

The name of the product in this product line item.

productLineItems[].product.essentialFeatures

Varies

The essential product properties of the product in this product line item.

productLineItems[].product.shippingWeight

Varies

The shipping weight of the product in this product line item.

productLineItems[].product._links.default-image-data

Object

The link to the product default image.

productLineItems[].product.defaultImageDataUri

String

The relative product default image URI.

productLineItems[]._id

String

The ID of the product line item.

productLineItems[].unshipped.quantity

Number

The quantity of items of this product line item that are not yet dispatched.

productLineItems[].unshipped.amount

Null

The amount of the items of this product line item that are not yet dispatched.

productLineItems[].shipped.quantity

Number

The quantity of dispatched items of this product line item.

productLineItems[].shipped.amount

Null

The amount of the dispatched items of this product line item.

productLineItems[].pending.quantity

Number

The quantity of pending items of this product line item.

productLineItems[].pending.amount

Null

The amount of the pending items of this product line item.

productLineItems[].returned.quantity

Number

The quantity of returned items of this product line item.

productLineItems[].returned.amount

Object

The amount of the returned items of this product line item.

productLineItems[].broken.quantity

Number

The quantity of broken items of this product line item.

productLineItems[].broken.amount

Object

The amount of the broken items of this product line item.

productLineItems[].canceled.quantity

Number

The quantity of canceled items of this product line item.

productLineItems[].canceled.amount

Object

The amount of the canceled items of this product line item.

shippingLineItem.lineItemPrice.amount

Number

The amount of the line item price for the shipping line item.

shippingLineItem.lineItemPrice.currency

String

The currency of the price for the shipping line item.

shippingLineItem.lineItemPrice.taxModel

String

The tax model of the line item price for the shipping line item.

shippingLineItem.initialLineItemPrice.amount

Number

The amount of the initial line item price for the shipping line item.

shippingLineItem.initialLineItemPrice.currency

String

The currency of the initial price for the shipping line item.

shippingLineItem.initialLineItemPrice.taxModel

String

The tax model of the initial line item price for the shipping line item.

shippingLineItem.taxClass

String

The tax class of the shipping line item.

shippingLineItem.lineItemTaxes

Array

The tax information for the shipping line item. The array contains one item per tax class.

shippingLineItem.shippingMethod.name

String

The name of the shipping method in this shipping line item.

shippingLineItem.shippingMethod.description

String

The description of the shipping method in the shipping line item.

shippingLineItem.shippingMethod.freeShippingValue.amount

Number

The amount of the free shipping value of the shipping method in this shipping line item.

shippingLineItem.shippingMethod.freeShippingValue.currency

String

The currency of the free shipping amount of the shipping method.

shippingLineItem.shippingMethod.fixedPrice.amount

Number

The amount of the fixed price of the shipping method in this shipping line item (if set).

shippingLineItem.shippingMethod.fixedPrice.currency

String

The currency of the fixed price of the shipping method.

shippingLineItem.shippingMethod.fixedPrice.taxModel

String

The tax model of the fixed price of the shipping method in this shipping line item (if set).

shippingLineItem.shippingMethod.weightBasedPrice

Null

The weight-based price of the shipping method in this shipping line item (if set).

paymentLineItem.lineItemPrice.amount

Number

The amount of the product line item price for the payment line item.

paymentLineItem.lineItemPrice.currency

String

The currency of the payment line item price.

paymentLineItem.lineItemPrice.taxModel

String

The tax model of the product line item price for the payment line item.

paymentLineItem.initialLineItemPrice.amount

Number

The amount of the initial line item price for the payment line item.

paymentLineItem.initialLineItemPrice.currency

String

The currency of the initial payment line item price.

paymentLineItem.initialLineItemPrice.taxModel

String

The tax model of the initial line item price for the payment line item.

paymentLineItem.taxClass

String

The tax class of a payment line item. Can be {{values}}.

paymentLineItem.lineItemTaxes

Array

The tax information for the payment line item. The array contains one item per tax class.

paymentLineItem.paymentMethod.name

String

The name of the payment method.

paymentLineItem.paymentMethod.description

String

The description of the payment method in this payment line item.

paymentLineItem.paymentMethod.discountOrFee.type

String

The type of the discountOrFee for this payment method. Can be ABSOLUTE, PERCENTAGE or UNSUPPORTED.

paymentLineItem.paymentMethod.discountOrFee.absoluteValue.amount

Number

The amount of the absolute value of discountOrFee of the payment method in this payment line item.

paymentLineItem.paymentMethod.discountOrFee.absoluteValue.currency

String

The currency of the absolute price of the discountOrFee for this payment method.

paymentLineItem.paymentMethod.discountOrFee.absoluteValue.taxModel

String

The tax model of the absolute price of the discountOrFee for this payment method.

paymentLineItem.paymentMethod.discountOrFee.percentageValue

Null

The percentage value of the discountOrFee for this payment method.

paymentLineItem.paymentMethod.onlinePayment

Boolean

Indicates if this payment method is an online payment. Can be true or false.

initialSubtotal.amount

Number

The initial subtotal amount of the product line items.

initialSubtotal.currency

String

The currency of the initial subtotal amount.

initialGrandTotal.amount

Number

The initial total amount of the order.

initialGrandTotal.currency

String

The currency of the initial total amount of the order.

initialNetTotal.amount

Number

The initial amount of net total.

initialNetTotal.currency

String

The currency of the initial total net amount.

initialTaxTotal.amount

Number

The initial total tax amount.

initialTaxTotal.currency

String

The currency of the initial total tax amount.

initialBalanceDue.amount

Number

The initial total amount of the order.

initialBalanceDue.currency

String

The currency of the initial balance due.

subtotal.amount

Number

The subtotal amount of the product line items.

subtotal.currency

String

The currency of the subtotal amount.

grandTotal.amount

Number

The total amount of the order.

grandTotal.currency

String

The currency of the total order amount.

netTotal.amount

Number

The amount of net total.

netTotal.currency

String

The currency of the total net amount.

taxTotal.amount

Number

The total tax amount.

taxTotal.currency

String

The currency of the total tax amount.

totalReceived.amount

Number

The total payment amount received.

totalReceived.currency

String

The currency of the total payment amount received.

totalRefunded.amount

Number

The total refunded amount.

totalRefunded.currency

String

The currency of the total refunded amount.

openAmount.amount

Number

The outstanding amount to be paid.

openAmount.currency

String

The currency of the open amount.

balanceDue.amount

Number

The total amount of the order. Does not change when payments come in.

balanceDue.currency

String

The currency of the balance due.

orderNote

String

A merchant comment or note on the order.

taxes

Array

The taxes grouped by tax class.

taxes[*].taxClass

String

The tax class.

taxes[*].amount

Number

The tax amount.

taxes[*].taxRate

Number

The applied tax rate.

billingAddress

Object

The billing address of the cart. Refer to Set cart billing address for item documentation.

billingAddress.displayAddressLines

Array

The applicable billing address of the cart to be displayed.

shippingAddress

Object

The shipping address of the cart. Defaults to billing address if no shipping address is set. Refer to Set cart shipping address for item documentation.

shippingAddress.displayAddressLines

Array

The applicable shipping address of the cart to be displayed.

orderStatus

String

The overall order status.

paymentStatus

String

The current status of the payment associated with this order.

fulfillmentStatus

String

The current fulfilment status of this order. Can be OPEN, PACKED, SHIPPED, DELIVERED, PARTIALLY_SHIPPED, PARTIALLY_DELIVERED, RETURNED, PARTIALLY_RETURNED, FAILED or LOST.

_links

Object

See Hypermedia

Links

Relation Description

order

The link to the order.

order-status

The link to update the order status.

fulfillment-status

The link to update the fulfillment status.

payment-status

The link to update the payment status.

order-status-log

The link to retrieve the list of order status log entries.

order-note

The link to set an order note.

order-receipt-pdf

The link to the order receipt pdf (exists if the document has already been created).

right-of-withdrawal-pdf

Optional link to the pdf containing the right of withdrawal applicable for this order.

terms-and-conditions-pdf

Optional link to the pdf containing the terms and conditions applicable for this order.

processes

The link to order processes.

events

The link to the order events.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 9781

{
  "_id" : "01c23f61-77cf-41de-96b3-6ad5c5e4feb4",
  "createdAt" : "2017-12-06T12:10:28.69",
  "cartId" : "8526450e-3a6c-4822-aaaa-5d2c82053ce8",
  "currency" : "EUR",
  "taxModel" : "GROSS",
  "taxable" : false,
  "testOrder" : false,
  "productLineItems" : [ {
    "product" : {
      "sku" : "1004",
      "name" : "White Sofa",
      "essentialFeatures" : null,
      "shippingWeight" : null,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "024011e8-642b-4f70-aa2f-6515a6d03265",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 3,
      "unit" : "PIECE"
    },
    "quantityInt" : 3,
    "initialQuantity" : 3,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2.5
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 1.197
    },
    "unshipped" : {
      "quantity" : 3,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "a0479c6c-332c-44b3-b985-5c7de1a42b6b"
  }, {
    "product" : {
      "sku" : "1018",
      "name" : "Decorative Sand (2 kg Jumbo Pack)",
      "essentialFeatures" : "Not suitable for children under the age of 8.",
      "shippingWeight" : 2000,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "7710a468-063b-45ca-b7bd-f84f72b11aea",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 5,
      "unit" : "PIECE"
    },
    "quantityInt" : 5,
    "initialQuantity" : 5,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 9.99
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.9743
    },
    "unshipped" : {
      "quantity" : 5,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "b294deac-52a7-434d-963c-3071f0a0cf46"
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "taxClass" : "REGULAR",
    "shippingMethod" : {
      "name" : "Standard Shipping",
      "description" : "Standard Shipping",
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 100
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 16.95
      },
      "weightBasedPrice" : null
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 2.7056
    } ]
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "taxClass" : "REGULAR",
    "paymentMethod" : {
      "name" : "PayPal",
      "description" : "Pay with PayPal",
      "discountOrFee" : {
        "type" : "ABSOLUTE",
        "absoluteValue" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "percentageValue" : null
      },
      "onlinePayment" : false
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 0
    } ]
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "initialSubtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "initialGrandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialBalanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialNetTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "initialTaxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.19,
    "currency" : "EUR",
    "amount" : 9.1713
  } ],
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "doorCode" : "456",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "vatId" : "DE123456789",
    "taxNumber" : "HRE 987654/32123/864516",
    "birthDate" : "1985-05-11",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "orderStatus" : "OPEN",
  "paymentStatus" : "UNPAID",
  "fulfillmentStatus" : "OPEN",
  "orderNumber" : "10001",
  "customerComment" : null,
  "orderNote" : "not paid yet",
  "entryDate" : "2017-12-06T12:10:28.69",
  "totalReceived" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "totalRefunded" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "openAmount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "marketingChannel" : "Google shopping",
  "marketingSubchannel" : "Some category",
  "salesChannel" : "Storefront",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4"
    },
    "order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4"
    },
    "order-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4/order-status"
    },
    "fulfillment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4/fulfillment-status"
    },
    "payment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4/payment-status"
    },
    "order-status-log" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4/order-status-log"
    },
    "order-note" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4/order-note"
    },
    "processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4/processes"
    },
    "events" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/01c23f61-77cf-41de-96b3-6ad5c5e4feb4/events"
    },
    "order-receipt-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/order.receipt/uri.pdf"
    },
    "terms-and-conditions-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    },
    "right-of-withdrawal-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    }
  }
}

Update order fulfillment status

Warning
This function will be deprecated with the introduction of shipment processes.

A PUT request is used to change the fulfillment status of the order.

Request body properties

Path Type Description

status

String

The new order fulfillment status to set. Can be OPEN, PACKED, SHIPPED, DELIVERED, PARTIALLY_SHIPPED, PARTIALLY_DELIVERED, RETURNED, PARTIALLY_RETURNED, FAILED or LOST.

comment

String

The comment to this status change.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/fulfillment-status' -i -X PUT -H 'Content-Type: application/json' -d '{"status":"SHIPPED","comment":"nothing to do here anymore"}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 9786

{
  "_id" : "d14e3382-6f4d-4547-bbfc-5056420fc7a2",
  "createdAt" : "2017-12-06T12:07:13.856",
  "cartId" : "38c8607b-e8c8-4849-82ad-1e086ddcc31f",
  "currency" : "EUR",
  "taxModel" : "GROSS",
  "taxable" : false,
  "testOrder" : false,
  "productLineItems" : [ {
    "product" : {
      "sku" : "1004",
      "name" : "White Sofa",
      "essentialFeatures" : null,
      "shippingWeight" : null,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "d06cd9eb-39ef-4165-a1d1-59a7b05a1312",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 3,
      "unit" : "PIECE"
    },
    "quantityInt" : 3,
    "initialQuantity" : 3,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2.5
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 1.197
    },
    "unshipped" : {
      "quantity" : 3,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "c8ca8720-a410-4a01-8835-5a06046bccdb"
  }, {
    "product" : {
      "sku" : "1018",
      "name" : "Decorative Sand (2 kg Jumbo Pack)",
      "essentialFeatures" : "Not suitable for children under the age of 8.",
      "shippingWeight" : 2000,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "b4d2ec2a-bc15-4c4e-9583-fba83c9104ea",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 5,
      "unit" : "PIECE"
    },
    "quantityInt" : 5,
    "initialQuantity" : 5,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 9.99
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.9743
    },
    "unshipped" : {
      "quantity" : 5,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "d63f76e4-66cd-46a1-9905-c2f5c567103e"
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "taxClass" : "REGULAR",
    "shippingMethod" : {
      "name" : "Standard Shipping",
      "description" : "Standard Shipping",
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 100
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 16.95
      },
      "weightBasedPrice" : null
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 2.7056
    } ]
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "taxClass" : "REGULAR",
    "paymentMethod" : {
      "name" : "PayPal",
      "description" : "Pay with PayPal",
      "discountOrFee" : {
        "type" : "ABSOLUTE",
        "absoluteValue" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "percentageValue" : null
      },
      "onlinePayment" : false
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 0
    } ]
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "initialSubtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "initialGrandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialBalanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialNetTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "initialTaxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.19,
    "currency" : "EUR",
    "amount" : 9.1713
  } ],
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "doorCode" : "456",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "vatId" : "DE123456789",
    "taxNumber" : "HRE 987654/32123/864516",
    "birthDate" : "1985-05-11",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "orderStatus" : "OPEN",
  "paymentStatus" : "UNPAID",
  "fulfillmentStatus" : "SHIPPED",
  "orderNumber" : "10001",
  "customerComment" : null,
  "orderNote" : "not paid yet",
  "entryDate" : "2017-12-06T12:07:13.856",
  "totalReceived" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "totalRefunded" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "openAmount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "marketingChannel" : "Google shopping",
  "marketingSubchannel" : "Some category",
  "salesChannel" : "Storefront",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2"
    },
    "order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2"
    },
    "order-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/order-status"
    },
    "fulfillment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/fulfillment-status"
    },
    "payment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/payment-status"
    },
    "order-status-log" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/order-status-log"
    },
    "order-note" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/order-note"
    },
    "processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/processes"
    },
    "events" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/d14e3382-6f4d-4547-bbfc-5056420fc7a2/events"
    },
    "order-receipt-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/order.receipt/uri.pdf"
    },
    "terms-and-conditions-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    },
    "right-of-withdrawal-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    }
  }
}

Update order note

A PUT request is used to change the order note.

Required scopes

ordr:u

Request body properties

Path Type Description

orderNote

String

A merchant comment or note on the order.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/order-note' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "orderNote" : "not paid yet"
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 8521

{
  "createdAt" : "2017-12-06T12:10:32.539",
  "cartId" : "9712a1c0-5cb0-46eb-9193-34768c4998da",
  "currency" : "EUR",
  "taxModel" : "GROSS",
  "taxable" : false,
  "testOrder" : false,
  "productLineItems" : [ {
    "quantity" : {
      "value" : 3,
      "unit" : "PIECE"
    },
    "initialQuantity" : 3,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2.5
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "product" : {
      "sku" : "1004",
      "name" : "White Sofa",
      "essentialFeatures" : null,
      "shippingWeight" : null,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "bc4a299b-1e6b-42d9-b8a8-07f2f33e4257",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 1.197
    },
    "quantityInt" : 3
  }, {
    "quantity" : {
      "value" : 5,
      "unit" : "PIECE"
    },
    "initialQuantity" : 5,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 9.99
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "product" : {
      "sku" : "1018",
      "name" : "Decorative Sand (2 kg Jumbo Pack)",
      "essentialFeatures" : "Not suitable for children under the age of 8.",
      "shippingWeight" : 2000,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "cafa1367-5f68-44d0-bb5d-587da89799d9",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.9743
    },
    "quantityInt" : 5
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "taxClass" : "REGULAR",
    "shippingMethod" : {
      "name" : "Standard Shipping",
      "description" : "Standard Shipping",
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 100
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 16.95
      },
      "weightBasedPrice" : null
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 2.7056
    } ]
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "taxClass" : "REGULAR",
    "paymentMethod" : {
      "name" : "PayPal",
      "description" : "Pay with PayPal",
      "discountOrFee" : {
        "type" : "ABSOLUTE",
        "absoluteValue" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "percentageValue" : null
      },
      "onlinePayment" : false
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 0
    } ]
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "initialSubtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialGrandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialBalanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "initialNetTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "initialTaxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.19,
    "currency" : "EUR",
    "amount" : 9.1713
  } ],
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "doorCode" : "456",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "vatId" : "DE123456789",
    "taxNumber" : "HRE 987654/32123/864516",
    "birthDate" : "1985-05-11",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "orderStatus" : "OPEN",
  "paymentStatus" : "UNPAID",
  "fulfillmentStatus" : "OPEN",
  "customerComment" : null,
  "orderNote" : "not paid yet",
  "entryDate" : "2017-12-06T12:10:32.539",
  "marketingChannel" : "Google shopping",
  "marketingSubchannel" : "Some category",
  "salesChannel" : "Storefront",
  "totalReceived" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "totalRefunded" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "openAmount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "_id" : "9230bd7f-ee4b-4b21-a18e-632fdd7a966b",
  "orderNumber" : "10001",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b"
    },
    "order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b"
    },
    "order-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/order-status"
    },
    "fulfillment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/fulfillment-status"
    },
    "payment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/payment-status"
    },
    "order-status-log" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/order-status-log"
    },
    "order-note" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/order-note"
    },
    "processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/processes"
    },
    "events" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/9230bd7f-ee4b-4b21-a18e-632fdd7a966b/events"
    },
    "order-receipt-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/order.receipt/uri.pdf"
    },
    "terms-and-conditions-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    },
    "right-of-withdrawal-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    }
  }
}

Update billing address

A PUT request is used to change the customer’s billing address.

Required scopes

ordr:u

Request body properties

Path Type Description Constraints

address

Object

The billing address of the cart. Refer to Set cart billing address for item documentation.

comment

String

Optional comment that describes the event.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/billing-address' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "address" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserstraße",
    "houseNumber" : "3",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "vatId" : "DE123456789",
    "taxNumber" : "HRE 987654/32123/864516",
    "birthDate" : "1985-05-11",
    "displayAddressLines" : [ null, "null null null", "null null", null, "null null" ],
    "_id" : null
  },
  "comment" : "Updated billing address"
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 9791

{
  "_id" : "eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2",
  "createdAt" : "2017-12-06T12:10:25.863",
  "cartId" : "3809c110-7289-484d-9008-643290f41229",
  "currency" : "EUR",
  "taxModel" : "GROSS",
  "taxable" : false,
  "testOrder" : false,
  "productLineItems" : [ {
    "product" : {
      "sku" : "1018",
      "name" : "Decorative Sand (2 kg Jumbo Pack)",
      "essentialFeatures" : "Not suitable for children under the age of 8.",
      "shippingWeight" : 2000,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "24b65f55-6138-402e-b797-e16062d0883e",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 5,
      "unit" : "PIECE"
    },
    "quantityInt" : 5,
    "initialQuantity" : 5,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 9.99
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.9743
    },
    "unshipped" : {
      "quantity" : 5,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "169f9573-8df5-4808-a946-4c669ede5d57"
  }, {
    "product" : {
      "sku" : "1004",
      "name" : "White Sofa",
      "essentialFeatures" : null,
      "shippingWeight" : null,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "89b2ae14-213a-4d14-94be-bed5f3c7a42a",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 3,
      "unit" : "PIECE"
    },
    "quantityInt" : 3,
    "initialQuantity" : 3,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2.5
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 1.197
    },
    "unshipped" : {
      "quantity" : 3,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "d5eeb27a-8796-4346-bc29-6440c8615f12"
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "taxClass" : "REGULAR",
    "shippingMethod" : {
      "name" : "Standard Shipping",
      "description" : "Standard Shipping",
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 100
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 16.95
      },
      "weightBasedPrice" : null
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 2.7056
    } ]
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "taxClass" : "REGULAR",
    "paymentMethod" : {
      "name" : "PayPal",
      "description" : "Pay with PayPal",
      "discountOrFee" : {
        "type" : "ABSOLUTE",
        "absoluteValue" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "percentageValue" : null
      },
      "onlinePayment" : false
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 0
    } ]
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "initialSubtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "initialGrandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialBalanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialNetTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "initialTaxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.19,
    "currency" : "EUR",
    "amount" : 9.1713
  } ],
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "doorCode" : "456",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserstraße",
    "houseNumber" : "3",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "vatId" : "DE123456789",
    "taxNumber" : "HRE 987654/32123/864516",
    "birthDate" : "1985-05-11",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserstraße 3", "1st floor", "20999 Alsterwasser" ]
  },
  "orderStatus" : "OPEN",
  "paymentStatus" : "UNPAID",
  "fulfillmentStatus" : "OPEN",
  "orderNumber" : "10001",
  "customerComment" : null,
  "orderNote" : "not paid yet",
  "entryDate" : "2017-12-06T12:10:25.863",
  "totalReceived" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "totalRefunded" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "openAmount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "marketingChannel" : "Google shopping",
  "marketingSubchannel" : "Some category",
  "salesChannel" : "Storefront",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2"
    },
    "order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2"
    },
    "order-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/order-status"
    },
    "fulfillment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/fulfillment-status"
    },
    "payment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/payment-status"
    },
    "order-status-log" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/order-status-log"
    },
    "order-note" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/order-note"
    },
    "processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/processes"
    },
    "events" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/eb653b6e-ee3c-499d-8ed9-8dbc5fa747e2/events"
    },
    "order-receipt-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/order.receipt/uri.pdf"
    },
    "right-of-withdrawal-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    },
    "terms-and-conditions-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    }
  }
}

Update shipping address

A PUT request is used to change the customer’s shipping address.

Required scopes

ordr:u

Request body properties

Path Type Description Constraints

address

Object

The shipping address of the cart. Defaults to billing address if no shipping address is set. Refer to Set cart shipping address for item documentation.

comment

String

Optional comment that describes the event.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/shipping-address' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "address" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserstraße",
    "houseNumber" : "3",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "doorCode" : "456",
    "displayAddressLines" : [ null, "null null null", "null null", null, "null null" ],
    "_id" : null
  },
  "comment" : "Updated shipping address"
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 9787

{
  "_id" : "c002263f-7df7-4ddf-ad98-f7b06f4c98dc",
  "createdAt" : "2017-12-06T12:10:27.7",
  "cartId" : "af2e0296-627d-4645-a354-f10028f75ac2",
  "currency" : "EUR",
  "taxModel" : "GROSS",
  "taxable" : false,
  "testOrder" : false,
  "productLineItems" : [ {
    "product" : {
      "sku" : "1004",
      "name" : "White Sofa",
      "essentialFeatures" : null,
      "shippingWeight" : null,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "08e3667a-6c73-41d0-a402-2f61bcfb2521",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 3,
      "unit" : "PIECE"
    },
    "quantityInt" : 3,
    "initialQuantity" : 3,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2.5
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 1.197
    },
    "unshipped" : {
      "quantity" : 3,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "5743a4aa-ee1e-4721-a9a5-d55d9da5cab5"
  }, {
    "product" : {
      "sku" : "1018",
      "name" : "Decorative Sand (2 kg Jumbo Pack)",
      "essentialFeatures" : "Not suitable for children under the age of 8.",
      "shippingWeight" : 2000,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "47203434-f5e9-4c8e-b1ff-d3959b4fc155",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 5,
      "unit" : "PIECE"
    },
    "quantityInt" : 5,
    "initialQuantity" : 5,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 9.99
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 7.9743
    },
    "unshipped" : {
      "quantity" : 5,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "_id" : "6d555966-6f3f-4e1d-a817-df223b62d9eb"
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "taxClass" : "REGULAR",
    "shippingMethod" : {
      "name" : "Standard Shipping",
      "description" : "Standard Shipping",
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 100
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 16.95
      },
      "weightBasedPrice" : null
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 2.7056
    } ]
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "taxClass" : "REGULAR",
    "paymentMethod" : {
      "name" : "PayPal",
      "description" : "Pay with PayPal",
      "discountOrFee" : {
        "type" : "ABSOLUTE",
        "absoluteValue" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "percentageValue" : null
      },
      "onlinePayment" : false
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 0
    } ]
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "initialSubtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "initialGrandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialBalanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialNetTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "initialTaxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.19,
    "currency" : "EUR",
    "amount" : 9.1713
  } ],
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserstraße",
    "houseNumber" : "3",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "doorCode" : "456",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserstraße 3", "1st floor", "20999 Alsterwasser" ]
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "vatId" : "DE123456789",
    "taxNumber" : "HRE 987654/32123/864516",
    "birthDate" : "1985-05-11",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "orderStatus" : "OPEN",
  "paymentStatus" : "UNPAID",
  "fulfillmentStatus" : "OPEN",
  "orderNumber" : "10001",
  "customerComment" : null,
  "orderNote" : "not paid yet",
  "entryDate" : "2017-12-06T12:10:27.7",
  "totalReceived" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "totalRefunded" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "openAmount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "marketingChannel" : "Google shopping",
  "marketingSubchannel" : "Some category",
  "salesChannel" : "Storefront",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc"
    },
    "order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc"
    },
    "order-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/order-status"
    },
    "fulfillment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/fulfillment-status"
    },
    "payment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/payment-status"
    },
    "order-status-log" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/order-status-log"
    },
    "order-note" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/order-note"
    },
    "processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/processes"
    },
    "events" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c002263f-7df7-4ddf-ad98-f7b06f4c98dc/events"
    },
    "order-receipt-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/order.receipt/uri.pdf"
    },
    "right-of-withdrawal-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    },
    "terms-and-conditions-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    }
  }
}

List order processes

A GET request will list all of the processes of an order.

Required scopes

ordp:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.payment-processes

Array

All payment processes of the order.

_embedded.shipping-processes

Array

All shipping processes of the order.

_embedded.return-processes

Array

All return processes of the order.

_embedded.cancel-processes

Array

All cancelation processes of the order.

_embedded.refund-processes

Array

All refund processes of the order.

_links

Object

See Hypermedia

Links

Relation Description

processes

The link to order processes.

shipping-processes

The link to all shipping processes of the order.

payment-processes

The link to all payment processes of the order.

return-processes

The link to all return processes of the order.

cancel-processes

The link to all cancelation processes of the order.

refund-processes

The link to all refund processes of the order.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5210

{
  "_embedded" : {
    "refund-processes" : [ {
      "amount" : {
        "currency" : "EUR",
        "amount" : 19.98
      },
      "status" : "VOIDED",
      "completed" : true,
      "_id" : "242aa2cd-b1d4-493b-ad3b-4f053cdbd924",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/refunds/242aa2cd-b1d4-493b-ad3b-4f053cdbd924"
        },
        "refund-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/refunds/242aa2cd-b1d4-493b-ad3b-4f053cdbd924"
        }
      }
    }, {
      "amount" : {
        "currency" : "EUR",
        "amount" : 39.96
      },
      "status" : "PENDING",
      "completed" : false,
      "_id" : "b9c5246f-a68f-4000-a026-f220ef959348",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/refunds/b9c5246f-a68f-4000-a026-f220ef959348"
        },
        "refund-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/refunds/b9c5246f-a68f-4000-a026-f220ef959348"
        },
        "mark-paid" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/refunds/b9c5246f-a68f-4000-a026-f220ef959348/mark-paid"
        }
      }
    } ],
    "cancel-processes" : [ {
      "lineItems" : [ {
        "productLineItemId" : "d3ade70b-e977-4afd-901f-d7f9c86dfcec",
        "quantity" : 2
      } ],
      "_id" : "6edf8787-1b04-4030-8de5-7b84dfd3f2f1",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/cancelations/6edf8787-1b04-4030-8de5-7b84dfd3f2f1"
        },
        "cancel-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/cancelations/6edf8787-1b04-4030-8de5-7b84dfd3f2f1"
        }
      }
    } ],
    "shipping-processes" : [ {
      "status" : "SHIPPED",
      "trackingCode" : "lookAtMyTrackingCodeWow",
      "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
      "lineItems" : [ {
        "productLineItemId" : "d3ade70b-e977-4afd-901f-d7f9c86dfcec",
        "quantity" : 3
      } ],
      "_id" : "3ce2e05a-b846-4885-a3f1-18fec11c3ebe",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/shippings/3ce2e05a-b846-4885-a3f1-18fec11c3ebe"
        },
        "shipping-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/shippings/3ce2e05a-b846-4885-a3f1-18fec11c3ebe"
        },
        "mark-delivered" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/shippings/3ce2e05a-b846-4885-a3f1-18fec11c3ebe/mark-delivered"
        }
      }
    } ],
    "payment-processes" : [ {
      "amount" : {
        "currency" : "EUR",
        "amount" : 74.4
      },
      "status" : "PAID",
      "completed" : true,
      "_id" : "223385d6-6e6e-4b39-9611-0fb58ee02024",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/payments/223385d6-6e6e-4b39-9611-0fb58ee02024"
        },
        "payment-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/payments/223385d6-6e6e-4b39-9611-0fb58ee02024"
        }
      }
    } ],
    "return-processes" : [ {
      "lineItems" : [ {
        "productLineItemId" : "d3ade70b-e977-4afd-901f-d7f9c86dfcec",
        "quantity" : 2,
        "status" : "RETURNED"
      } ],
      "_id" : "49269053-41c6-4a72-9284-fa74277f7a2e",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/returns/49269053-41c6-4a72-9284-fa74277f7a2e"
        },
        "return-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/returns/49269053-41c6-4a72-9284-fa74277f7a2e"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes"
    },
    "processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes"
    },
    "payment-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/payments"
    },
    "shipping-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/shippings"
    },
    "return-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/returns"
    },
    "cancel-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/cancelations"
    },
    "refund-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/fb64a67e-6ad0-4bfa-8abf-81534454b3f7/processes/refunds"
    }
  }
}

List payment processes

A GET request will list all of the payment processes of an order in a paged way.

Required scopes

pypr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments?page=0&size=20' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

_embedded.payment-processes[].completed

Boolean

Indicates if the payment has been completed. Can be true or false.

_embedded.payment-processes[].status

String

The status of the payment process. Can be UNPAID, AUTHORIZED, PENDING, APPROVED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED, FAILED or EXECUTED.

_embedded.payment-processes[].amount.amount

Number

The amount due for this payment process.

_embedded.payment-processes[].amount.currency

String

The currency of the amount due in this payment process.

_embedded.payment-processes[]._id

String

The ID of the payment process.

page

Object

See Pagination

Links

Relation Description

payment-processes

The link to all payment processes of the order.

active

The link to the active payment process of the order.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1563

{
  "_embedded" : {
    "payment-processes" : [ {
      "amount" : {
        "currency" : "EUR",
        "amount" : 74.4
      },
      "status" : "PENDING",
      "completed" : false,
      "_id" : "207662ca-efe4-4a7e-9b28-9e373a7e6de7",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments/207662ca-efe4-4a7e-9b28-9e373a7e6de7"
        },
        "payment-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments/207662ca-efe4-4a7e-9b28-9e373a7e6de7"
        },
        "mark-voided" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments/207662ca-efe4-4a7e-9b28-9e373a7e6de7/mark-voided"
        },
        "mark-paid" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments/207662ca-efe4-4a7e-9b28-9e373a7e6de7/mark-paid"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments?page=0&size=20"
    },
    "payment-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments"
    },
    "active" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/5ac78daa-3a3f-4adb-b68d-b013609a0ce2/processes/payments/active"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Show payment process details

A GET request is used to retrieve the payment processes.

Required scopes

pypr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/e30bad01-e78f-4a9b-bfcd-94e377801d79/processes/payments/ec2a6324-b261-40ac-a591-7a4015e118dc' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

completed

Boolean

Indicates if the payment has been completed. Can be true or false.

status

String

The status of the payment process. Can be UNPAID, AUTHORIZED, PENDING, APPROVED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED, FAILED or EXECUTED.

amount.amount

Number

The amount due for this payment process.

amount.currency

String

The currency of the amount due in this payment process.

_id

String

The ID of the payment process.

_links

Object

See Hypermedia

Links

Relation Description

payment-process

The link to the current payment process.

mark-paid

The link to set the current payment process to paid.

mark-voided

The link to set the current payment process to voided.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 883

{
  "amount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "status" : "PENDING",
  "completed" : false,
  "_id" : "ec2a6324-b261-40ac-a591-7a4015e118dc",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/e30bad01-e78f-4a9b-bfcd-94e377801d79/processes/payments/ec2a6324-b261-40ac-a591-7a4015e118dc"
    },
    "payment-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/e30bad01-e78f-4a9b-bfcd-94e377801d79/processes/payments/ec2a6324-b261-40ac-a591-7a4015e118dc"
    },
    "mark-voided" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/e30bad01-e78f-4a9b-bfcd-94e377801d79/processes/payments/ec2a6324-b261-40ac-a591-7a4015e118dc/mark-voided"
    },
    "mark-paid" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/e30bad01-e78f-4a9b-bfcd-94e377801d79/processes/payments/ec2a6324-b261-40ac-a591-7a4015e118dc/mark-paid"
    }
  }
}

Show active payment process details

A GET request is used to retrieve the active payment processes. There is only one active payment process. See Show payment process details for more info about request and response structure.

Required scopes

pypr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/62ec9a43-5b4b-48b8-a872-599207a9e883/processes/payments/active' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 883

{
  "amount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "status" : "PENDING",
  "completed" : false,
  "_id" : "bde5feea-cf1c-4f7f-911e-1c8e27272b8f",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/62ec9a43-5b4b-48b8-a872-599207a9e883/processes/payments/bde5feea-cf1c-4f7f-911e-1c8e27272b8f"
    },
    "payment-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/62ec9a43-5b4b-48b8-a872-599207a9e883/processes/payments/bde5feea-cf1c-4f7f-911e-1c8e27272b8f"
    },
    "mark-voided" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/62ec9a43-5b4b-48b8-a872-599207a9e883/processes/payments/bde5feea-cf1c-4f7f-911e-1c8e27272b8f/mark-voided"
    },
    "mark-paid" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/62ec9a43-5b4b-48b8-a872-599207a9e883/processes/payments/bde5feea-cf1c-4f7f-911e-1c8e27272b8f/mark-paid"
    }
  }
}

Create payment processes

A POST request will create a new payment processes for an order.

Required scopes

pypr:c

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/f66ee1b6-f0d4-4461-9900-3d860500411a/processes/payments' -i -X POST -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/orders/f66ee1b6-f0d4-4461-9900-3d860500411a/processes/payments/5421761d-f85f-45cf-891b-0533a684859d
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 883

{
  "amount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "status" : "PENDING",
  "completed" : false,
  "_id" : "5421761d-f85f-45cf-891b-0533a684859d",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/f66ee1b6-f0d4-4461-9900-3d860500411a/processes/payments/5421761d-f85f-45cf-891b-0533a684859d"
    },
    "payment-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/f66ee1b6-f0d4-4461-9900-3d860500411a/processes/payments/5421761d-f85f-45cf-891b-0533a684859d"
    },
    "mark-voided" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/f66ee1b6-f0d4-4461-9900-3d860500411a/processes/payments/5421761d-f85f-45cf-891b-0533a684859d/mark-voided"
    },
    "mark-paid" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/f66ee1b6-f0d4-4461-9900-3d860500411a/processes/payments/5421761d-f85f-45cf-891b-0533a684859d/mark-paid"
    }
  }
}

Mark payment process as voided

A POST request will mark the payment process as voided.

Required scopes

pypr:u

Request body properties

Path Type Description

comment

String

The comment to this status change.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/ddb11ea6-f7c3-4f37-8a2e-637d92f742be/processes/payments/863b64d7-a4dd-43f5-9693-144b6bf49bac/mark-voided' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "comment"
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 519

{
  "amount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "status" : "VOIDED",
  "completed" : true,
  "_id" : "863b64d7-a4dd-43f5-9693-144b6bf49bac",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/ddb11ea6-f7c3-4f37-8a2e-637d92f742be/processes/payments/863b64d7-a4dd-43f5-9693-144b6bf49bac"
    },
    "payment-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/ddb11ea6-f7c3-4f37-8a2e-637d92f742be/processes/payments/863b64d7-a4dd-43f5-9693-144b6bf49bac"
    }
  }
}

Mark payment process as paid

A POST request will mark the payment process as paid.

Required scopes

pypr:u

Request body properties

Path Type Description

comment

String

The comment to this status change.

details.amount.amount

Number

The amount paid.

details.amount.currency

String

The currency of the amount paid.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/4c1d3742-607c-4697-8411-9de1cbb514a3/processes/payments/0a1a4ec8-8917-4714-b50d-79fe31c71d36/mark-paid' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "comment",
  "details" : {
    "amount" : {
      "currency" : "EUR",
      "amount" : 74.4
    }
  }
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 517

{
  "amount" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "status" : "PAID",
  "completed" : true,
  "_id" : "0a1a4ec8-8917-4714-b50d-79fe31c71d36",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/4c1d3742-607c-4697-8411-9de1cbb514a3/processes/payments/0a1a4ec8-8917-4714-b50d-79fe31c71d36"
    },
    "payment-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/4c1d3742-607c-4697-8411-9de1cbb514a3/processes/payments/0a1a4ec8-8917-4714-b50d-79fe31c71d36"
    }
  }
}

List shipping processes

A GET request will list all of the shipping processes of an order in a paged way.

Required scopes

shpr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/4c0d69ef-0355-47ad-b45d-b56152f33898/processes/shippings?page=0&size=20' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

_embedded.shipping-processes[].lineItems

Array

The line items that are included in this shipping process.

_embedded.shipping-processes[].status

String

The status of the shipping process. Can be {{values}}.

_embedded.shipping-processes[].trackingCode

String

The tracking code for this shipping process.

_embedded.shipping-processes[].trackingLink

String

The tracking link for this shipping process.

_embedded.shipping-processes[]._id

String

The ID of the shipping process.

page

Object

See Pagination

Links

Relation Description

shipping-processes

The link to all shipping processes of the order.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1597

{
  "_embedded" : {
    "shipping-processes" : [ {
      "status" : "PENDING",
      "trackingCode" : "lookAtMyTrackingCodeWow",
      "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
      "lineItems" : [ {
        "productLineItemId" : "5f3b3819-4de4-430e-a9ef-8707821e20ef",
        "quantity" : 3
      } ],
      "_id" : "445de8c2-0d78-423e-bb40-b5978f89a33a",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/4c0d69ef-0355-47ad-b45d-b56152f33898/processes/shippings/445de8c2-0d78-423e-bb40-b5978f89a33a"
        },
        "shipping-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/4c0d69ef-0355-47ad-b45d-b56152f33898/processes/shippings/445de8c2-0d78-423e-bb40-b5978f89a33a"
        },
        "mark-shipped" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/4c0d69ef-0355-47ad-b45d-b56152f33898/processes/shippings/445de8c2-0d78-423e-bb40-b5978f89a33a/mark-shipped"
        },
        "mark-delivered" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/4c0d69ef-0355-47ad-b45d-b56152f33898/processes/shippings/445de8c2-0d78-423e-bb40-b5978f89a33a/mark-delivered"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/4c0d69ef-0355-47ad-b45d-b56152f33898/processes/shippings?page=0&size=20"
    },
    "shipping-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/4c0d69ef-0355-47ad-b45d-b56152f33898/processes/shippings"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Show shipping process details

A GET request is used to retrieve the shipping processes.

Required scopes

shpr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/8d53ce9d-00a5-4b7d-9f1f-42d8edc8549d/processes/shippings/9952c5af-edb4-47c3-9f53-4714725ac1e2' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

lineItems

Array

The line items that are included in this shipping process.

status

String

The status of the shipping process. Can be {{values}}.

trackingCode

String

The tracking code for this shipping process.

trackingLink

String

The tracking link for this shipping process.

_id

String

The ID of the shipping process.

_links

Object

See Hypermedia

Links

Relation Description

shipping-process

The link to the current shipping process.

mark-shipped

The link to set the current shipping process to shipped.

mark-delivered

The link to set the current shipping process to delivered.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1045

{
  "status" : "PENDING",
  "trackingCode" : "lookAtMyTrackingCodeWow",
  "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
  "lineItems" : [ {
    "productLineItemId" : "961ac887-0c30-4c97-9dc0-02e4fc7385e5",
    "quantity" : 3
  } ],
  "_id" : "9952c5af-edb4-47c3-9f53-4714725ac1e2",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/8d53ce9d-00a5-4b7d-9f1f-42d8edc8549d/processes/shippings/9952c5af-edb4-47c3-9f53-4714725ac1e2"
    },
    "shipping-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/8d53ce9d-00a5-4b7d-9f1f-42d8edc8549d/processes/shippings/9952c5af-edb4-47c3-9f53-4714725ac1e2"
    },
    "mark-shipped" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/8d53ce9d-00a5-4b7d-9f1f-42d8edc8549d/processes/shippings/9952c5af-edb4-47c3-9f53-4714725ac1e2/mark-shipped"
    },
    "mark-delivered" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/8d53ce9d-00a5-4b7d-9f1f-42d8edc8549d/processes/shippings/9952c5af-edb4-47c3-9f53-4714725ac1e2/mark-delivered"
    }
  }
}

Create shipping processes

A POST request will create a new shipping processes for an order.

Required scopes

shpr:c

Request body properties

Path Type Description

comment

String

The comment to this status change.

sendMail

Boolean

Indicates if a mail is to be sent out with this shipping process transition.

trackingCode

String

The tracking code for this shipping process.

trackingLink

String

The tracking link for this shipping process.

lineItems[].productLineItemId

String

The ID of a product line item that is marked with a new status.

lineItems[].quantity

Number

The quantity of a product line item that is marked with a new status.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/c01d219e-c76d-4c58-8ca3-5bc54d934306/processes/shippings' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "This needs to be done fast!",
  "sendMail" : true,
  "trackingCode" : "lookAtMyTrackingCodeWow",
  "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
  "lineItems" : [ {
    "quantity" : 3,
    "productLineItemId" : "029a7d19-dc7e-4d94-958a-30881ad245bc"
  } ]
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/orders/c01d219e-c76d-4c58-8ca3-5bc54d934306/processes/shippings/5fb92c24-30a1-4766-a5bf-d7e36af40b43
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1045

{
  "status" : "PENDING",
  "trackingCode" : "lookAtMyTrackingCodeWow",
  "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
  "lineItems" : [ {
    "productLineItemId" : "029a7d19-dc7e-4d94-958a-30881ad245bc",
    "quantity" : 3
  } ],
  "_id" : "5fb92c24-30a1-4766-a5bf-d7e36af40b43",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c01d219e-c76d-4c58-8ca3-5bc54d934306/processes/shippings/5fb92c24-30a1-4766-a5bf-d7e36af40b43"
    },
    "shipping-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c01d219e-c76d-4c58-8ca3-5bc54d934306/processes/shippings/5fb92c24-30a1-4766-a5bf-d7e36af40b43"
    },
    "mark-shipped" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c01d219e-c76d-4c58-8ca3-5bc54d934306/processes/shippings/5fb92c24-30a1-4766-a5bf-d7e36af40b43/mark-shipped"
    },
    "mark-delivered" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/c01d219e-c76d-4c58-8ca3-5bc54d934306/processes/shippings/5fb92c24-30a1-4766-a5bf-d7e36af40b43/mark-delivered"
    }
  }
}

Mark shipping process as shipped

A POST request will mark the shipping process as shipped.

Required scopes

shpr:u

Request body properties

Path Type Description

comment

String

The comment to this status change.

details.trackingCode

String

The tracking code for this shipping process.

details.trackingLink

String

The tracking link for this shipping process.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/f4bb7d08-91f9-4b1c-a489-fd8286ea6768/processes/shippings/00f8fb58-113d-40fc-bdb1-fb99ccffbcf3/mark-shipped' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "This needs to be done fast!",
  "details" : {
    "trackingCode" : "lookAtMyTrackingCodeWow",
    "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow"
  }
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 859

{
  "status" : "SHIPPED",
  "trackingCode" : "lookAtMyTrackingCodeWow",
  "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
  "lineItems" : [ {
    "productLineItemId" : "25ab253e-ea7f-4755-81dc-f5dd239d7013",
    "quantity" : 3
  } ],
  "_id" : "00f8fb58-113d-40fc-bdb1-fb99ccffbcf3",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/f4bb7d08-91f9-4b1c-a489-fd8286ea6768/processes/shippings/00f8fb58-113d-40fc-bdb1-fb99ccffbcf3"
    },
    "shipping-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/f4bb7d08-91f9-4b1c-a489-fd8286ea6768/processes/shippings/00f8fb58-113d-40fc-bdb1-fb99ccffbcf3"
    },
    "mark-delivered" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/f4bb7d08-91f9-4b1c-a489-fd8286ea6768/processes/shippings/00f8fb58-113d-40fc-bdb1-fb99ccffbcf3/mark-delivered"
    }
  }
}

Mark shipping process as delivered

A POST request will mark the shipping process as delivered.

Required scopes

shpr:u

Request body properties

Path Type Description

comment

String

The comment to this status change.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/0f661c59-99c0-4f0c-964f-eaf240f989a7/processes/shippings/01e99a06-fbb4-41d3-9812-4f17878d81ec/mark-delivered' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "comment"
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 671

{
  "status" : "DELIVERED",
  "trackingCode" : "lookAtMyTrackingCodeWow",
  "trackingLink" : "http://tracking.is/fun?code=lookAtMyTrackingCodeWow",
  "lineItems" : [ {
    "productLineItemId" : "a138db41-fb0f-43ba-9212-2bdd0dc457d6",
    "quantity" : 3
  } ],
  "_id" : "01e99a06-fbb4-41d3-9812-4f17878d81ec",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/0f661c59-99c0-4f0c-964f-eaf240f989a7/processes/shippings/01e99a06-fbb4-41d3-9812-4f17878d81ec"
    },
    "shipping-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/0f661c59-99c0-4f0c-964f-eaf240f989a7/processes/shippings/01e99a06-fbb4-41d3-9812-4f17878d81ec"
    }
  }
}

List return processes

A GET request will list all of the return processes of an order in a paged way.

Required scopes

rtpr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/88b19f69-408f-4938-9d2b-cfacce34310f/processes/returns?page=0&size=20' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

_embedded.return-processes[].lineItems

Array

The product line items that are included in this return process.

_embedded.return-processes[]._id

String

The ID of the return process.

page

Object

See Pagination

Links

Relation Description

return-processes

The link to all return processes of the order.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1058

{
  "_embedded" : {
    "return-processes" : [ {
      "lineItems" : [ {
        "productLineItemId" : "a450c2e1-49a0-49be-ab1d-628bfc873dfe",
        "quantity" : 3,
        "status" : "RETURNED"
      } ],
      "_id" : "3b080f81-b2cc-481a-99e7-85f5c8aea91c",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/88b19f69-408f-4938-9d2b-cfacce34310f/processes/returns/3b080f81-b2cc-481a-99e7-85f5c8aea91c"
        },
        "return-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/88b19f69-408f-4938-9d2b-cfacce34310f/processes/returns/3b080f81-b2cc-481a-99e7-85f5c8aea91c"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/88b19f69-408f-4938-9d2b-cfacce34310f/processes/returns?page=0&size=20"
    },
    "return-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/88b19f69-408f-4938-9d2b-cfacce34310f/processes/returns"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Show return process details

A GET request is used to retrieve the return processes.

Required scopes

rtpr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/83b5808f-a279-4abc-9e35-2ba26af3675b/processes/returns/8a95dd7d-942b-4b34-98c7-dacfbd8c0194' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

lineItems

Array

The product line items that are included in this return process.

_id

String

The ID of the return process.

_links

Object

See Hypermedia

Links

Relation Description

return-process

The link to the current return process.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 546

{
  "lineItems" : [ {
    "productLineItemId" : "19320851-b392-4c3c-90f2-47080173a1ad",
    "quantity" : 3,
    "status" : "RETURNED"
  } ],
  "_id" : "8a95dd7d-942b-4b34-98c7-dacfbd8c0194",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/83b5808f-a279-4abc-9e35-2ba26af3675b/processes/returns/8a95dd7d-942b-4b34-98c7-dacfbd8c0194"
    },
    "return-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/83b5808f-a279-4abc-9e35-2ba26af3675b/processes/returns/8a95dd7d-942b-4b34-98c7-dacfbd8c0194"
    }
  }
}

Create return processes

A POST request will create a new return processes for an order.

Required scopes

rtpr:c

Request body properties

Path Type Description

comment

String

The comment to this status change.

lineItems[].productLineItemId

String

The ID of a specified product line item in this return process.

lineItems[].quantity

Number

The quantity of the product line item in this return process.

lineItems[].status

String

The status of the product line item in this return process.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/48fd1313-ce19-4546-a29e-b38de6d821b4/processes/returns' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "This needs to be done fast!",
  "lineItems" : [ {
    "quantity" : 3,
    "productLineItemId" : "bc48bc3f-2fa4-4dec-baaf-ea9f04e3eb50",
    "status" : "RETURNED"
  } ]
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/orders/48fd1313-ce19-4546-a29e-b38de6d821b4/processes/returns/d4cf6edc-1c5e-4b9e-be2b-89dcd0a4ed3e
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 546

{
  "lineItems" : [ {
    "productLineItemId" : "bc48bc3f-2fa4-4dec-baaf-ea9f04e3eb50",
    "quantity" : 3,
    "status" : "RETURNED"
  } ],
  "_id" : "d4cf6edc-1c5e-4b9e-be2b-89dcd0a4ed3e",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/48fd1313-ce19-4546-a29e-b38de6d821b4/processes/returns/d4cf6edc-1c5e-4b9e-be2b-89dcd0a4ed3e"
    },
    "return-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/48fd1313-ce19-4546-a29e-b38de6d821b4/processes/returns/d4cf6edc-1c5e-4b9e-be2b-89dcd0a4ed3e"
    }
  }
}

List cancel processes

A GET request will list all of the cancel processes of an order in a paged way.

Required scopes

clpr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/8a701727-f9cc-4542-a337-565290ab1b3d/processes/cancelations?page=0&size=20' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

_embedded.cancel-processes[].lineItems

Array

The product line items that are included in this cancelation process.

_embedded.cancel-processes[]._id

String

The ID of the cancelation process.

page

Object

See Pagination

Links

Relation Description

cancel-processes

The link to all cancelation processes of the order.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1047

{
  "_embedded" : {
    "cancel-processes" : [ {
      "lineItems" : [ {
        "productLineItemId" : "cd8833d2-cb64-45c2-b11b-755717296751",
        "quantity" : 3
      } ],
      "_id" : "3fbfb2fd-bf8d-4b7a-a90c-be01de454633",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/8a701727-f9cc-4542-a337-565290ab1b3d/processes/cancelations/3fbfb2fd-bf8d-4b7a-a90c-be01de454633"
        },
        "cancel-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/8a701727-f9cc-4542-a337-565290ab1b3d/processes/cancelations/3fbfb2fd-bf8d-4b7a-a90c-be01de454633"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/8a701727-f9cc-4542-a337-565290ab1b3d/processes/cancelations?page=0&size=20"
    },
    "cancel-processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/8a701727-f9cc-4542-a337-565290ab1b3d/processes/cancelations"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Show cancel process details

A GET request is used to retrieve the cancel processes.

Required scopes

clpr:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/2ad30eb8-fdc1-4245-8bd2-8e55a19e7a13/processes/cancelations/f75dba3f-2f51-4557-892c-5786b5f04e67' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

lineItems

Array

The product line items that are included in this cancelation process.

_id

String

The ID of the cancelation process.

_links

Object

See Hypermedia

Links

Relation Description

cancel-process

The link to the current cancelation process.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 529

{
  "lineItems" : [ {
    "productLineItemId" : "9450cc4c-e30b-4016-aa09-d05459a83140",
    "quantity" : 3
  } ],
  "_id" : "f75dba3f-2f51-4557-892c-5786b5f04e67",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/2ad30eb8-fdc1-4245-8bd2-8e55a19e7a13/processes/cancelations/f75dba3f-2f51-4557-892c-5786b5f04e67"
    },
    "cancel-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/2ad30eb8-fdc1-4245-8bd2-8e55a19e7a13/processes/cancelations/f75dba3f-2f51-4557-892c-5786b5f04e67"
    }
  }
}

Create cancel processes

A POST request will create a new cancel processes for an order.

Required scopes

clpr:c

Request body properties

Path Type Description

comment

String

The comment to this status change.

lineItems[].productLineItemId

String

The ID of a specified product line item in this cancelation process.

lineItems[].quantity

Number

The quantity of the product line item in this cancelation process.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/2e9619ae-3c65-482a-a14b-9562bfecf6b5/processes/cancelations' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "This needs to be done fast!",
  "lineItems" : [ {
    "quantity" : 3,
    "productLineItemId" : "186d6d8b-5635-48e4-9e64-289d9e7e88c4"
  } ]
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/orders/2e9619ae-3c65-482a-a14b-9562bfecf6b5/processes/cancelations/43602ced-c764-4af2-a321-291b4808625e
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 529

{
  "lineItems" : [ {
    "productLineItemId" : "186d6d8b-5635-48e4-9e64-289d9e7e88c4",
    "quantity" : 3
  } ],
  "_id" : "43602ced-c764-4af2-a321-291b4808625e",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/2e9619ae-3c65-482a-a14b-9562bfecf6b5/processes/cancelations/43602ced-c764-4af2-a321-291b4808625e"
    },
    "cancel-process" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/2e9619ae-3c65-482a-a14b-9562bfecf6b5/processes/cancelations/43602ced-c764-4af2-a321-291b4808625e"
    }
  }
}

Cancel order

A POST request will cancel an order.

Required scopes

clpr:c

Request body properties

Path Type Description

comment

String

The comment to this status change.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/cancel' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "comment" : "This needs to be done fast!"
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 9747

{
  "_id" : "51e5ca9f-a63b-412f-85d2-05a9f86dfab7",
  "createdAt" : "2017-12-06T12:08:48.054",
  "cartId" : "909d9250-0780-43dc-97f2-45df7775ffde",
  "currency" : "EUR",
  "taxModel" : "GROSS",
  "taxable" : true,
  "testOrder" : false,
  "productLineItems" : [ {
    "product" : {
      "sku" : "1018",
      "name" : "Decorative Sand (2 kg Jumbo Pack)",
      "essentialFeatures" : "Not suitable for children under the age of 8.",
      "shippingWeight" : 2000,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "328fa791-e8ce-40df-9ba1-9a2dca0f76ea",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 0,
      "unit" : "PIECE"
    },
    "quantityInt" : 0,
    "initialQuantity" : 5,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 9.99
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 49.95
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 0
    },
    "unshipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 5,
      "amount" : {
        "currency" : "EUR",
        "amount" : 49.95
      }
    },
    "_id" : "151667e8-73f2-4d85-8c5d-e7315e26eb4e"
  }, {
    "product" : {
      "sku" : "1004",
      "name" : "White Sofa",
      "essentialFeatures" : null,
      "shippingWeight" : null,
      "defaultImageDataUri" : "/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "_id" : "40ab3c05-b51b-4358-a103-f47112d15198",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        }
      }
    },
    "quantity" : {
      "value" : 0,
      "unit" : "PIECE"
    },
    "quantityInt" : 0,
    "initialQuantity" : 3,
    "unitPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2.5
    },
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 7.5
    },
    "lineItemTax" : {
      "taxClass" : "REGULAR",
      "taxRate" : 0.19,
      "currency" : "EUR",
      "amount" : 0
    },
    "unshipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "shipped" : {
      "quantity" : 0,
      "amount" : null
    },
    "pending" : {
      "quantity" : 0,
      "amount" : null
    },
    "returned" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "broken" : {
      "quantity" : 0,
      "amount" : {
        "currency" : "EUR",
        "amount" : 0
      }
    },
    "canceled" : {
      "quantity" : 3,
      "amount" : {
        "currency" : "EUR",
        "amount" : 7.5
      }
    },
    "_id" : "8df320de-c0a4-4f2c-8358-0e66ef68061a"
  } ],
  "shippingLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "taxClass" : "REGULAR",
    "shippingMethod" : {
      "name" : "Standard Shipping",
      "description" : "Standard Shipping",
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 100
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 16.95
      },
      "weightBasedPrice" : null
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ]
  },
  "paymentLineItem" : {
    "lineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "initialLineItemPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 0
    },
    "taxClass" : "REGULAR",
    "paymentMethod" : {
      "name" : "PayPal",
      "description" : "Pay with PayPal",
      "discountOrFee" : {
        "type" : "ABSOLUTE",
        "absoluteValue" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 0
        },
        "percentageValue" : null
      },
      "onlinePayment" : false
    },
    "lineItemTaxes" : [ {
      "taxClass" : "REGULAR",
      "taxRate" : 0.0,
      "currency" : "EUR",
      "amount" : 0
    } ]
  },
  "subtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "grandTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "balanceDue" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "netTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "taxTotal" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "initialSubtotal" : {
    "currency" : "EUR",
    "amount" : 57.45
  },
  "initialGrandTotal" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialBalanceDue" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "initialNetTotal" : {
    "currency" : "EUR",
    "amount" : 65.2287
  },
  "initialTaxTotal" : {
    "currency" : "EUR",
    "amount" : 9.1713
  },
  "taxes" : [ {
    "taxClass" : "REGULAR",
    "taxRate" : 0.0,
    "currency" : "EUR",
    "amount" : 0
  } ],
  "shippingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "doorCode" : "456",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "billingAddress" : {
    "salutation" : "Mrs",
    "gender" : "FEMALE",
    "company" : "Astrid Alster GmbH",
    "title" : null,
    "firstName" : "Astrid",
    "middleName" : "Agnes",
    "lastName" : "Alster",
    "street" : "Alsterwasserweg",
    "houseNumber" : "2",
    "street2" : "1st floor",
    "addressExtension" : "c/o Astrid Alster",
    "postalCode" : "20999",
    "city" : "Alsterwasser",
    "country" : "DE",
    "state" : "Hamburg",
    "email" : "a@example.com",
    "phone" : "(800) 555-0100",
    "mobile" : "(800) 555-0101",
    "vatId" : "DE123456789",
    "taxNumber" : "HRE 987654/32123/864516",
    "birthDate" : "1985-05-11",
    "displayAddressLines" : [ "Astrid Alster GmbH", "Astrid Agnes Alster", "Alsterwasserweg 2", "1st floor", "20999 Alsterwasser" ]
  },
  "orderStatus" : "CANCELED",
  "paymentStatus" : "UNPAID",
  "fulfillmentStatus" : "OPEN",
  "orderNumber" : "10001",
  "customerComment" : null,
  "orderNote" : "not paid yet",
  "entryDate" : "2017-12-06T12:08:48.054",
  "totalReceived" : {
    "currency" : "EUR",
    "amount" : 74.4
  },
  "totalRefunded" : {
    "currency" : "EUR",
    "amount" : 0
  },
  "openAmount" : {
    "currency" : "EUR",
    "amount" : -74.4
  },
  "marketingChannel" : "Google shopping",
  "marketingSubchannel" : "Some category",
  "salesChannel" : "Storefront",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7"
    },
    "order" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7"
    },
    "order-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/order-status"
    },
    "fulfillment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/fulfillment-status"
    },
    "payment-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/payment-status"
    },
    "order-status-log" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/order-status-log"
    },
    "order-note" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/order-note"
    },
    "processes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/processes"
    },
    "events" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/51e5ca9f-a63b-412f-85d2-05a9f86dfab7/events"
    },
    "order-receipt-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/order.receipt/uri.pdf"
    },
    "terms-and-conditions-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    },
    "right-of-withdrawal-pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/pdf-storage/attachments/some.pdf?hash=23213"
    }
  }
}

List order events

A GET request will list all of the events of an order in a paged way.

Required scopes

orde:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/orders/32d53abd-0681-4103-b636-5e33043c2d00/events' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.order-events[].triggeredBy

Varies

The user or client that triggered the order event.

_embedded.order-events[].comment

Varies

Optional comment that describes the event.

_embedded.order-events[].createdAt

String

The date and time the order event was created. According to ISO 8601.

_embedded.order-events[].details.type

String

The type of the order event. Can be ORDER_CREATED, ORDER_SHIPPED, ITEMS_RETURNED, ITEMS_CANCELED, PAYMENT_CREATED, PAYMENT_VOIDED, PAYMENT_PAID, PAYMENT_EXECUTED, PAYMENT_FAILED, PAYMENT_EXECUTION_TEMPORARILY_FAILED, ORDER_SHIPPING_ADDRESS_CHANGED, ORDER_BILLING_ADDRESS_CHANGED, SHIPPING_SHIPPED, SHIPPING_DELIVERED, SHIPPING_PENDING, REFUND_CREATED, REFUND_VOIDED or REFUND_PAID.

_embedded.order-events[]._links.payment-process.href

String

The link to the corresponding payment process.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2051

{
  "_embedded" : {
    "order-events" : [ {
      "triggeredBy" : "user",
      "comment" : "comment",
      "createdAt" : "2017-12-06T12:05:47.323",
      "details" : {
        "paymentProcessId" : "67a72353-fb1f-4c60-bd52-2133c5cfb699",
        "type" : "payment-voided"
      },
      "_links" : {
        "payment-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/32d53abd-0681-4103-b636-5e33043c2d00/processes/payments/67a72353-fb1f-4c60-bd52-2133c5cfb699"
        }
      }
    }, {
      "triggeredBy" : null,
      "comment" : null,
      "createdAt" : "2017-12-06T12:05:47.17",
      "details" : {
        "amount" : {
          "currency" : "EUR",
          "amount" : 0
        },
        "paymentProcessId" : null,
        "type" : "payment-created"
      }
    }, {
      "triggeredBy" : "user",
      "comment" : "customer transfer",
      "createdAt" : "2017-12-06T12:05:46.942",
      "details" : {
        "amount" : {
          "currency" : "EUR",
          "amount" : 74.4
        },
        "paymentProcessId" : "42ffb05e-445e-4d3f-8750-6938fd6556e2",
        "type" : "payment-paid"
      },
      "_links" : {
        "payment-process" : {
          "href" : "https://api-shop.beyondshop.cloud/api/orders/32d53abd-0681-4103-b636-5e33043c2d00/processes/payments/42ffb05e-445e-4d3f-8750-6938fd6556e2"
        }
      }
    }, {
      "triggeredBy" : null,
      "comment" : null,
      "createdAt" : "2017-12-06T12:05:46.614",
      "details" : {
        "amount" : {
          "currency" : "EUR",
          "amount" : 74.4
        },
        "paymentProcessId" : null,
        "type" : "payment-created"
      }
    }, {
      "triggeredBy" : null,
      "comment" : null,
      "createdAt" : "2017-12-06T12:05:46.438",
      "details" : {
        "type" : "order-created"
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/orders/32d53abd-0681-4103-b636-5e33043c2d00/events"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

Payment Methods

The payment-methods resources is used to get information about payment methods of this shop.

Show payment method details

A GET request is used to retrieve the details of a payment method.

Required scopes

pymt:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/1a1686fd-0dc3-4b98-93dd-581b4d6357bf' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The immutable, unique identifier of the requested resource.

position

Number

The sorting position of the payment method in the merchant administration in relation to other payment methods.

officialName

String

The official name of the payment method chosen by the merchant during setup.

officialDescription

String

The official description of the payment method chosen by the merchant during setup.

name

String

The name of the payment method that is used during checkout.

description

String

Description of the payment method that is used during checkout.

activated

Boolean

Indicates if a payment method is active. Can be true or false.

taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

discountOrFee

Object

The details about the fee to be payed or discount to be granted for this payment method.

discountOrFee.type

String

The discount or fee can be an absolute or a percentage based value. Can be one of PERCENTAGE or ABSOLUTE. ABSOLUTE contains another attribute absoluteValue with a positive or negative price. PERCENTAGE contains another attribute percentageValue with a negative or positive percentage value.

serviceableCountries

Array

The list of target countries this payment method can be used in.

minimumOrderValue

Object

The mininmum value of the cart so that this payment method can be used.

onlinePayment

Boolean

Indicates if the payment method is an online payment. Can be true or false.

activatable

Boolean

Indicates if a payment method can be activated (feature enabled for the shop). Can be true or false.

activeLogoSet

Null

The name of the currently selected logo set. Can be TILE, DETAILS, LIST or STOREFRONT. (official is always the fallback).

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 10:32:32 GMT
ETag: "2"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1572

{
  "name" : "PayPal",
  "description" : "Pay with PayPal",
  "officialName" : "PayPal",
  "officialDescription" : "Pay with PayPal",
  "taxClass" : "REGULAR",
  "discountOrFee" : {
    "type" : "ABSOLUTE",
    "absoluteValue" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2
    },
    "percentageValue" : null
  },
  "position" : 1,
  "serviceableCountries" : [ "DE" ],
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 10
  },
  "activated" : true,
  "activeLogoSet" : null,
  "onlinePayment" : true,
  "activatable" : true,
  "_id" : "1a1686fd-0dc3-4b98-93dd-581b4d6357bf",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1a1686fd-0dc3-4b98-93dd-581b4d6357bf"
    },
    "payment-method" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1a1686fd-0dc3-4b98-93dd-581b4d6357bf"
    },
    "logo-details" : {
      "href" : "http://details-logo.com"
    },
    "logo-storefront" : {
      "href" : "http://storefront-logo.com"
    },
    "logo-list" : {
      "href" : "http://list-logo.com"
    },
    "logo-tile" : {
      "href" : "http://tile-logo.com"
    },
    "integration-status" : {
      "href" : "https://api-shop.beyondshop.cloud/api/paypal/merchant-account-status"
    },
    "deactivate-payment-method" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1a1686fd-0dc3-4b98-93dd-581b4d6357bf/deactivate"
    },
    "payment-integration" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1a1686fd-0dc3-4b98-93dd-581b4d6357bf/payment-integration"
    }
  }
}

List payment methods

A GET request will list all of the payment methods in a paged manner.

Required scopes

pymt:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3048

{
  "_embedded" : {
    "payment-methods" : [ {
      "name" : "PayPal",
      "description" : "Pay with PayPal",
      "officialName" : "PayPal",
      "officialDescription" : "Pay with PayPal",
      "taxClass" : "REGULAR",
      "discountOrFee" : {
        "type" : "ABSOLUTE",
        "absoluteValue" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 2
        },
        "percentageValue" : null
      },
      "position" : 1,
      "serviceableCountries" : [ "DE" ],
      "minimumOrderValue" : null,
      "activated" : true,
      "activeLogoSet" : null,
      "onlinePayment" : false,
      "activatable" : true,
      "_id" : "1cc616d1-b48b-43e0-9da5-7dadb0dd0fd0",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1cc616d1-b48b-43e0-9da5-7dadb0dd0fd0"
        },
        "payment-method" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1cc616d1-b48b-43e0-9da5-7dadb0dd0fd0"
        },
        "deactivate-payment-method" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1cc616d1-b48b-43e0-9da5-7dadb0dd0fd0/deactivate"
        },
        "payment-integration" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/1cc616d1-b48b-43e0-9da5-7dadb0dd0fd0/payment-integration"
        }
      }
    }, {
      "name" : "Credit Card",
      "description" : "Pay with CreditCard",
      "officialName" : "Credit Card",
      "officialDescription" : "Pay with CreditCard",
      "taxClass" : "REGULAR",
      "discountOrFee" : {
        "type" : "PERCENTAGE",
        "absoluteValue" : null,
        "percentageValue" : 0.02
      },
      "position" : 2,
      "serviceableCountries" : [ "DE", "GB" ],
      "minimumOrderValue" : {
        "currency" : "EUR",
        "amount" : 20
      },
      "activated" : true,
      "activeLogoSet" : null,
      "onlinePayment" : false,
      "activatable" : true,
      "_id" : "10033472-158e-4833-b1b8-43ee15d5f6b0",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/10033472-158e-4833-b1b8-43ee15d5f6b0"
        },
        "payment-method" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/10033472-158e-4833-b1b8-43ee15d5f6b0"
        },
        "deactivate-payment-method" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/10033472-158e-4833-b1b8-43ee15d5f6b0/deactivate"
        },
        "payment-integration" : {
          "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/10033472-158e-4833-b1b8-43ee15d5f6b0/payment-integration"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "https://api-shop.beyondshop.cloud/api/profile/payment-methods"
    },
    "search" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Create payment method

A POST request is used to create a payment method.

Required scopes

pymt:c

Request body properties

Path Type Description Constraints

officialName

String

The official name of the payment method chosen by the merchant during setup.

Must not be empty

officialDescription

String

The official description of the payment method chosen by the merchant during setup.

name

String

The name of the payment method that is used during checkout.

Must not be empty

description

String

Description of the payment method that is used during checkout.

discountOrFee

Object

The details about the fee to be payed or discount to be granted for this payment method.

discountOrFee.type

String

The discount or fee can be an absolute or a percentage based value. Can be one of PERCENTAGE or ABSOLUTE. ABSOLUTE contains another attribute absoluteValue with a positive or negative price. PERCENTAGE contains another attribute percentageValue with a negative or positive percentage value.

serviceableCountries

Array

The list of target countries this payment method can be used in.

Each country code must be officially assigned (see ISO 3166-1 Alpha-2)

minimumOrderValue

Object

The mininmum value of the cart so that this payment method can be used.

position

Number

The sorting position of the payment method in the merchant administration in relation to other payment methods.

taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

Must not be null

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "name" : "A Payment Method",
  "description" : "Description of A Payment Method",
  "officialName" : "Official Name",
  "officialDescription" : "Official description of method",
  "taxClass" : "REGULAR",
  "discountOrFee" : {
    "type" : "ABSOLUTE",
    "absoluteValue" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 12.34
    }
  },
  "position" : 0,
  "serviceableCountries" : [ "DE", "GB" ],
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 19.99
  }
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "1"
Last-Modified: Thu, 07 Dec 2017 10:32:42 GMT
Location: https://api-shop.beyondshop.cloud/api/payment-methods/469b8e1a-4e8d-4225-8d49-394fe5a89b8f
Content-Type: application/json;charset=UTF-8
Content-Length: 1244

{
  "name" : "A Payment Method",
  "description" : "Description of A Payment Method",
  "officialName" : "Official Name",
  "officialDescription" : "Official description of method",
  "taxClass" : "REGULAR",
  "discountOrFee" : {
    "type" : "ABSOLUTE",
    "absoluteValue" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 12.34
    },
    "percentageValue" : null
  },
  "position" : 1,
  "serviceableCountries" : [ "DE", "GB" ],
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 19.99
  },
  "activated" : false,
  "activeLogoSet" : null,
  "onlinePayment" : false,
  "activatable" : true,
  "_id" : "469b8e1a-4e8d-4225-8d49-394fe5a89b8f",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/469b8e1a-4e8d-4225-8d49-394fe5a89b8f"
    },
    "payment-method" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/469b8e1a-4e8d-4225-8d49-394fe5a89b8f"
    },
    "activate-payment-method" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/469b8e1a-4e8d-4225-8d49-394fe5a89b8f/activate"
    },
    "payment-integration" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/469b8e1a-4e8d-4225-8d49-394fe5a89b8f/payment-integration"
    }
  }
}

Update payment method

A PUT request is used to update a payment method.

Required scopes

pymt:u

Request body properties

Path Type Description Constraints

officialName

String

The official name of the payment method chosen by the merchant during setup.

Must not be empty

officialDescription

String

The official description of the payment method chosen by the merchant during setup.

name

String

The name of the payment method that is used during checkout.

Must not be empty

description

String

Description of the payment method that is used during checkout.

discountOrFee

Object

The details about the fee to be payed or discount to be granted for this payment method.

discountOrFee.type

String

The discount or fee can be an absolute or a percentage based value. Can be one of PERCENTAGE or ABSOLUTE. ABSOLUTE contains another attribute absoluteValue with a positive or negative price. PERCENTAGE contains another attribute percentageValue with a negative or positive percentage value.

serviceableCountries

Array

The list of target countries this payment method can be used in.

Each country code must be officially assigned (see ISO 3166-1 Alpha-2)

minimumOrderValue

Object

The mininmum value of the cart so that this payment method can be used.

position

Number

The sorting position of the payment method in the merchant administration in relation to other payment methods.

taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

Must not be null

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/324b802a-ad7a-42f4-88fc-0dd52159fb4e' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "name" : "Another name",
  "description" : "Pay with PayPal",
  "officialName" : "PayPal",
  "officialDescription" : "Pay with PayPal",
  "taxClass" : "REGULAR",
  "discountOrFee" : {
    "type" : "ABSOLUTE",
    "absoluteValue" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 2.0
    }
  },
  "position" : 0,
  "serviceableCountries" : [ "DE" ],
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 10.0
  }
}'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "1"
Last-Modified: Thu, 07 Dec 2017 10:32:38 GMT
Location: https://api-shop.beyondshop.cloud/api/payment-methods/324b802a-ad7a-42f4-88fc-0dd52159fb4e

Delete payment method

A DELETE request is used to delete a payment method.

Required scopes

pymt:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/f2013c56-dd56-4e8b-a591-3ce21f35225f' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Sort payment methods

A PUT request is used to sort payment methods.

Required scopes

pymt:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods' -i -X PUT -H 'Content-Type: text/uri-list' -H 'Authorization: Bearer <Access token>' -d 'https://api-shop.beyondshop.cloud/api/payment-methods/203935a8-1ae3-41ea-b4b8-ac39472c48eb
https://api-shop.beyondshop.cloud/api/payment-methods/d0f2e01f-4073-4251-bf7a-d84f4549ec5d
https://api-shop.beyondshop.cloud/api/payment-methods/29286e4d-2c90-4e0f-a854-204e15e149f4
https://api-shop.beyondshop.cloud/api/payment-methods/b4e5bf52-043b-497f-94cb-c7876c0c28a1'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/payment-methods

Activate a payment method

A POST request is used to activate a payment method.

Required scopes

pymt:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/a9d775ba-88a3-4484-ab76-29cd39d6587e/activate' -i -X POST -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 968

{
  "name" : "A Payment Method",
  "description" : "Description of A Payment Method",
  "officialName" : "Official Name",
  "officialDescription" : "Official description of method",
  "taxClass" : "REGULAR",
  "discountOrFee" : {
    "type" : "ABSOLUTE",
    "absoluteValue" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 12.34
    },
    "percentageValue" : null
  },
  "position" : 1,
  "serviceableCountries" : [ "DE", "GB" ],
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 19.99
  },
  "activated" : true,
  "activeLogoSet" : null,
  "onlinePayment" : false,
  "activatable" : true,
  "_id" : "a9d775ba-88a3-4484-ab76-29cd39d6587e",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/a9d775ba-88a3-4484-ab76-29cd39d6587e"
    },
    "deactivate-payment-method" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/a9d775ba-88a3-4484-ab76-29cd39d6587e/deactivate"
    }
  }
}

Dectivate a payment method

Required scopes

pymt:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/d5ed56ba-19f1-4cf9-aabd-b1d317fa67f3/deactivate' -i -X POST -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 965

{
  "name" : "A Payment Method",
  "description" : "Description of A Payment Method",
  "officialName" : "Official Name",
  "officialDescription" : "Official description of method",
  "taxClass" : "REGULAR",
  "discountOrFee" : {
    "type" : "ABSOLUTE",
    "absoluteValue" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 12.34
    },
    "percentageValue" : null
  },
  "position" : 1,
  "serviceableCountries" : [ "DE", "GB" ],
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 19.99
  },
  "activated" : false,
  "activeLogoSet" : null,
  "onlinePayment" : false,
  "activatable" : true,
  "_id" : "d5ed56ba-19f1-4cf9-aabd-b1d317fa67f3",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/d5ed56ba-19f1-4cf9-aabd-b1d317fa67f3"
    },
    "activate-payment-method" : {
      "href" : "https://api-shop.beyondshop.cloud/api/payment-methods/d5ed56ba-19f1-4cf9-aabd-b1d317fa67f3/activate"
    }
  }
}

Products

The products resource is used to manage products of a shop.

List products

A GET request will list all of the products in a paged manner. The returned data is an excerpt projection, which includes a small subset of product properties.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products?locale=en-US' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.products[].name

String

The name of the product.

_embedded.products[].sku

String

The stock keeping unit (SKU) corresponding to the product.

_embedded.products[].salesPrice

Object

The current sales price of the product.

_embedded.products[].listPrice

Object

The original sales price of the product.

_embedded.products[]._embedded.availability

Object

The information about the availability of the product.

_embedded.products[]._id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

search

The link to product search endpoints.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3199

{
  "_embedded" : {
    "products" : [ {
      "_id" : "278386db-64d3-4eea-8849-ea53ec83c91f",
      "sku" : "123456789-001",
      "name" : "My product name",
      "salesPrice" : {
        "taxModel" : "NET",
        "currency" : "EUR",
        "amount" : 49.99,
        "derivedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 54.989,
          "taxRate" : 0.011
        }
      },
      "listPrice" : {
        "taxModel" : "NET",
        "currency" : "EUR",
        "amount" : 69.99,
        "derivedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 76.989,
          "taxRate" : 0.011
        }
      },
      "_embedded" : {
        "availability" : {
          "availabilityState" : "IN_STOCK",
          "availableStock" : 20,
          "stockThreshold" : 2,
          "purchasable" : true,
          "_links" : {
            "self" : {
              "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f/availability"
            }
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f"
        },
        "self-localized" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f?locale=en-US"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f{?locale}",
          "templated" : true
        },
        "attributes" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f/attributes{?locale}",
          "templated" : true
        },
        "attachments" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f/attachments"
        },
        "images" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f/images"
        },
        "amazon" : {
          "href" : "http://amazon/amazon-products/278386db-64d3-4eea-8849-ea53ec83c91f"
        },
        "google-shopping" : {
          "href" : "http://google-shopping/google-products/278386db-64d3-4eea-8849-ea53ec83c91f"
        },
        "default-image" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/278386db-64d3-4eea-8849-ea53ec83c91f/default-image"
        },
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        },
        "default-image-metadata" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998&download=no"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products?page=0&size=20"
    },
    "profile" : {
      "href" : "https://api-shop.beyondshop.cloud/api/profile/products"
    },
    "search" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Create product

A POST request is used to create a product.

Required scopes

prod:c

Request body properties

Path Type Description Constraints

sku

String

The stock keeping unit (SKU) corresponding to the product.

Must not be empty

name

String

The name of the product.

description

String

The description of the product.

manufacturer

String

The manufacturer of the product.

visible

Boolean

Indicates if the product visible in the online shop. Can be true or false.

salesPrice

Object

The current sales price of the product.

Must match the shop’s tax model. Must not be null

salesPrice.taxModel

String

The tax model of the sales price. Can be GROSS or NET.

salesPrice.amount

Number

Th amount of the sales price.

salesPrice.currency

String

The currency of the sales price.

listPrice

Object

The original sales price of the product.

listPrice.taxModel

String

The tax model of the list price. Can be GROSS or NET.

listPrice.amount

Number

The amount of the list price.

listPrice.currency

String

The currency of the list price.

onSale

Boolean

Indicates if the product is on offer. Can be true or false.

productIdentifiers[].type

String

The product code to identify and classify the product. Can be EAN, UPC, ISBN or MPN.

productIdentifiers[].value

String

The actual value of the product identifier.

essentialFeatures

String

The essential features of the product. Shown in the cart and checkout. In Germany mandatory field in online shops according to §312j Abs. 2 BGB (German Civil Code).

tags

Array

The tags assigned to a product.

taxClass

String

The tax class. Can be REGULAR, REDUCED or EXEMPT.

Must not be null

shippingWeight

Number

The weight of the product including packaging in g.

maxOrderQuantity

Number

Displays how often this product can be ordered at maximum in one order.

shippingPeriod.minDays

Number

The minimum required days for shipping.

shippingPeriod.maxDays

Number

The maximum required days for shipping.

shippingPeriod.displayUnit

String

The unit to show the shipping period. Use DAYS or WEEKS.

shippingDimension.length

Number

The length of the product including packaging in mm.

shippingDimension.width

Number

The width of the product including packaging in mm.

shippingDimension.height

Number

The height of the product including packaging in mm.

refPrice.refQuantity

Number

The reference quantity of the product.

refPrice.quantity

Number

The quantity in the product.

refPrice.unit

String

The unit of the quantity.

refPrice.price

Null

The price information scaled to a standardised base unit, according to the German base price regulation “Preisangabenverordnung” (PAngV), e.g. 1 l = 1.20 EUR. Is null if no reference amount is specified for the product.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products?locale=en-US' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{"sku":"123456789-001","name":"My product name","description":"My product description.","manufacturer":"The Manufacturer","essentialFeatures":"Some essential information","tags":["tag1","tag2"],"productIdentifiers":[{"type":"MPN","value":"ABC-123"},{"type":"EAN","value":"12345678"}],"salesPrice":{"taxModel":"NET","amount":49.99,"currency":"EUR"},"listPrice":{"taxModel":"NET","amount":29.99,"currency":"EUR"},"onSale":true,"visible":true,"taxClass":"REGULAR","shippingWeight":1000,"maxOrderQuantity":100,"shippingDimension":{"length":100,"width":100,"height":100},"refPrice":{"refQuantity":100,"unit":"GRAM","quantity":200,"price":null},"shippingPeriod":{"minDays":14,"maxDays":21,"displayUnit":"WEEKS"}}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2451

{
  "sku" : "123456789-001",
  "salesPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 49.99,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 54.989,
      "taxRate" : 0.1
    }
  },
  "listPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 29.99,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 32.989,
      "taxRate" : 0.1
    }
  },
  "onSale" : true,
  "tags" : [ "tag1", "tag2" ],
  "productIdentifiers" : [ {
    "type" : "MPN",
    "value" : "ABC-123"
  }, {
    "type" : "EAN",
    "value" : "12345678"
  } ],
  "visible" : true,
  "taxClass" : "REGULAR",
  "shippingWeight" : 1000,
  "maxOrderQuantity" : 100,
  "shippingDimension" : {
    "length" : 100,
    "width" : 100,
    "height" : 100
  },
  "refPrice" : {
    "refQuantity" : 100,
    "unit" : "GRAM",
    "quantity" : 200,
    "price" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 24.995,
      "derivedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 27.495,
        "taxRate" : 0.1
      }
    }
  },
  "shippingPeriod" : {
    "minDays" : 14,
    "maxDays" : 21,
    "displayUnit" : "WEEKS"
  },
  "attributes" : [ ],
  "description" : "My product description.",
  "manufacturer" : "The Manufacturer",
  "essentialFeatures" : "Some essential information",
  "name" : "My product name",
  "_id" : "2a9eca49-272e-4afa-be72-b72772b30ead",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead"
    },
    "self-localized" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead?locale=en-US"
    },
    "availability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead/availability"
    },
    "attributes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead/attributes{?locale}",
      "templated" : true
    },
    "attachments" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead/attachments"
    },
    "images" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead/images"
    },
    "default-image" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2a9eca49-272e-4afa-be72-b72772b30ead/default-image"
    }
  }
}

Show product details

A GET request is used to retrieve the details of a product.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88?locale=en-US' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

sku

String

The stock keeping unit (SKU) corresponding to the product.

name

String

The name of the product.

description

String

The description of the product.

manufacturer

String

The manufacturer of the product.

visible

Boolean

Indicates if the product visible in the online shop. Can be true or false.

salesPrice

Object

The current sales price of the product.

salesPrice.taxModel

String

The tax model of the sales price. Can be GROSS or NET.

salesPrice.amount

Number

Th amount of the sales price.

salesPrice.currency

String

The currency of the sales price.

listPrice

Object

The original sales price of the product.

listPrice.taxModel

String

The tax model of the list price. Can be GROSS or NET.

listPrice.amount

Number

The amount of the list price.

listPrice.currency

String

The currency of the list price.

onSale

Boolean

Indicates if the product is on offer. Can be true or false.

productIdentifiers[].type

String

The product code to identify and classify the product. Can be EAN, UPC, ISBN or MPN.

productIdentifiers[].value

String

The actual value of the product identifier.

essentialFeatures

String

The essential features of the product. Shown in the cart and checkout. In Germany mandatory field in online shops according to §312j Abs. 2 BGB (German Civil Code).

tags

Array

The tags assigned to a product.

taxClass

String

The tax class. Can be REGULAR, REDUCED or EXEMPT.

shippingWeight

Number

The weight of the product including packaging in g.

maxOrderQuantity

Number

Displays how often this product can be ordered at maximum in one order.

shippingPeriod.minDays

Number

The minimum required days for shipping.

shippingPeriod.maxDays

Null

The maximum required days for shipping.

shippingPeriod.displayUnit

String

The unit to show the shipping period. Use DAYS or WEEKS.

shippingDimension.length

Number

The length of the product including packaging in mm.

shippingDimension.width

Number

The width of the product including packaging in mm.

shippingDimension.height

Number

The height of the product including packaging in mm.

refPrice.refQuantity

Number

The reference quantity of the product.

refPrice.quantity

Number

The quantity in the product.

refPrice.unit

String

The unit of the quantity.

refPrice.price

Object

The price information scaled to a standardised base unit, according to the German base price regulation “Preisangabenverordnung” (PAngV), e.g. 1 l = 1.20 EUR. Is null if no reference amount is specified for the product.

_id

String

The immutable, unique identifier of the requested resource.

attributes

Array

The list of product attributes.

salesPrice.amount

Number

The amount of the list price.

salesPrice.derivedPrice

Object

The calculated price with taxes applied (read-only).

salesPrice.currency

String

The currency of the list price.

salesPrice.taxModel

String

The tax model of the list price. Can be GROSS or NET.

listPrice.amount

Number

The amount of the list price.

listPrice.derivedPrice

Object

The calculated price with taxes applied (read-only).

listPrice.currency

String

The currency of the list price.

listPrice.taxModel

String

The tax model of the list price. Can be GROSS or NET.

_links

Object

See Hypermedia

Links

Relation Description

product

The templated self link of the product. Current representation of the resource. See Hypermedia.

self-localized

The templated self link to the product with the relevant localized parameters. See Hypermedia.

availability

The link to the information about product availability.

images

The link to the product image.

attributes

The link to the product properties.

attachments

The link to the product attachments.

default-image

The link to the default product image.

default-image-data

Download URL of the default image.

default-image-metadata

The URL to the image metadata of the default image.

google-shopping

The link to a product relation to Google Shopping.

amazon

The link to a product relation to Amazon.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:52:01 GMT
ETag: "2"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3476

{
  "sku" : "123456789-001",
  "salesPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 49.99,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 54.989,
      "taxRate" : 0.011
    }
  },
  "listPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 69.99,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 76.989,
      "taxRate" : 0.011
    }
  },
  "onSale" : true,
  "tags" : [ "car", "dog", "cool" ],
  "productIdentifiers" : [ {
    "type" : "MPN",
    "value" : "ABC-123"
  }, {
    "type" : "EAN",
    "value" : "12345678"
  } ],
  "visible" : true,
  "taxClass" : "REGULAR",
  "shippingWeight" : 100,
  "maxOrderQuantity" : 4,
  "shippingDimension" : {
    "length" : 10,
    "width" : 50,
    "height" : 150
  },
  "refPrice" : {
    "refQuantity" : 100,
    "unit" : "GRAM",
    "quantity" : 200,
    "price" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 24.995,
      "derivedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 27.495,
        "taxRate" : 0.011
      }
    }
  },
  "shippingPeriod" : {
    "minDays" : 14,
    "maxDays" : null,
    "displayUnit" : "WEEKS"
  },
  "attributes" : [ {
    "namespace" : "custom",
    "name" : "size",
    "locale" : "en-US",
    "type" : "STRING",
    "value" : "L"
  }, {
    "namespace" : "seo",
    "name" : "slug",
    "locale" : "en-US",
    "type" : "STRING",
    "value" : "my-product"
  } ],
  "description" : "My product description.",
  "manufacturer" : "The Manufacturer",
  "essentialFeatures" : "Some essential information",
  "name" : "My product name",
  "_id" : "d1d41e55-ef1f-41c6-b817-84e420c2ac88",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88"
    },
    "self-localized" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88?locale=en-US"
    },
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88{?locale}",
      "templated" : true
    },
    "availability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88/availability"
    },
    "attributes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88/attributes{?locale}",
      "templated" : true
    },
    "attachments" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88/attachments"
    },
    "images" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88/images"
    },
    "amazon" : {
      "href" : "http://amazon/amazon-products/d1d41e55-ef1f-41c6-b817-84e420c2ac88"
    },
    "google-shopping" : {
      "href" : "http://google-shopping/google-products/d1d41e55-ef1f-41c6-b817-84e420c2ac88"
    },
    "default-image" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/d1d41e55-ef1f-41c6-b817-84e420c2ac88/default-image"
    },
    "default-image-data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "templated" : true
    },
    "default-image-metadata" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998&download=no"
    }
  }
}

Update product partially (json patch)

A PATCH request is issued to update a product partially with json patch content type.

Required scopes

prod:u

Request body properties

Path Type Description

.[]

Array

A list of JSON Patch operations.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2?locale=en-US' -i -X PATCH -H 'Content-Type: application/json-patch+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '[{"op":"test","path":"/name","value":"My product name"},{"op":"replace","path":"/name","value":"patched name"},{"op":"replace","path":"/manufacturer","value":"patched manufacturer"},{"op":"add","path":"/tags/-","value":"new tag"},{"op":"remove","path":"/productIdentifiers"},{"op":"replace","path":"/salesPrice","value":{"taxModel":"NET","amount":999.0,"currency":"EUR"}}]'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "3"
Last-Modified: Thu, 07 Dec 2017 13:51:53 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2756

{
  "sku" : "123456789-001",
  "salesPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 999,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 1098.9,
      "taxRate" : 0.1
    }
  },
  "listPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 69.99,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 76.989,
      "taxRate" : 0.1
    }
  },
  "onSale" : true,
  "tags" : [ "car", "dog", "cool", "new tag" ],
  "productIdentifiers" : [ ],
  "visible" : true,
  "taxClass" : "REGULAR",
  "shippingWeight" : 100,
  "maxOrderQuantity" : 4,
  "shippingDimension" : {
    "length" : 10,
    "width" : 50,
    "height" : 150
  },
  "refPrice" : {
    "refQuantity" : 100,
    "unit" : "GRAM",
    "quantity" : 200,
    "price" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 499.5,
      "derivedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 549.45,
        "taxRate" : 0.1
      }
    }
  },
  "shippingPeriod" : {
    "minDays" : 14,
    "maxDays" : null,
    "displayUnit" : "WEEKS"
  },
  "attributes" : [ {
    "namespace" : "custom",
    "name" : "size",
    "locale" : "en-US",
    "type" : "STRING",
    "value" : "L"
  }, {
    "namespace" : "seo",
    "name" : "slug",
    "locale" : "en-US",
    "type" : "STRING",
    "value" : "my-product"
  } ],
  "description" : "My product description.",
  "manufacturer" : "patched manufacturer",
  "essentialFeatures" : "Some essential information",
  "name" : "patched name",
  "_id" : "ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2"
    },
    "self-localized" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2?locale=en-US"
    },
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2{?locale}",
      "templated" : true
    },
    "availability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2/availability"
    },
    "attributes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2/attributes{?locale}",
      "templated" : true
    },
    "attachments" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2/attachments"
    },
    "images" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2/images"
    },
    "default-image" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/ba8f4a67-fbfd-4ebc-932a-c08ea05ba9b2/default-image"
    }
  }
}

Update product partially (json)

A PATCH request is issued to update a product partially with json content type.

Required scopes

prod:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99?locale=en-US' -i -X PATCH -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"name":"patched name","description":"patched description.","productIdentifiers":null,"manufacturer":"patched manufacturer"}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "3"
Last-Modified: Thu, 07 Dec 2017 13:51:59 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2745

{
  "sku" : "123456789-001",
  "salesPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 49.99,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 54.989,
      "taxRate" : 0.1
    }
  },
  "listPrice" : {
    "taxModel" : "NET",
    "currency" : "EUR",
    "amount" : 69.99,
    "derivedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 76.989,
      "taxRate" : 0.1
    }
  },
  "onSale" : true,
  "tags" : [ "car", "dog", "cool" ],
  "productIdentifiers" : [ ],
  "visible" : true,
  "taxClass" : "REGULAR",
  "shippingWeight" : 100,
  "maxOrderQuantity" : 4,
  "shippingDimension" : {
    "length" : 10,
    "width" : 50,
    "height" : 150
  },
  "refPrice" : {
    "refQuantity" : 100,
    "unit" : "GRAM",
    "quantity" : 200,
    "price" : {
      "taxModel" : "NET",
      "currency" : "EUR",
      "amount" : 24.995,
      "derivedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 27.495,
        "taxRate" : 0.1
      }
    }
  },
  "shippingPeriod" : {
    "minDays" : 14,
    "maxDays" : null,
    "displayUnit" : "WEEKS"
  },
  "attributes" : [ {
    "namespace" : "custom",
    "name" : "size",
    "locale" : "en-US",
    "type" : "STRING",
    "value" : "L"
  }, {
    "namespace" : "seo",
    "name" : "slug",
    "locale" : "en-US",
    "type" : "STRING",
    "value" : "my-product"
  } ],
  "description" : "patched description.",
  "manufacturer" : "patched manufacturer",
  "essentialFeatures" : "Some essential information",
  "name" : "patched name",
  "_id" : "a5ec9169-ebf1-4709-b140-31d33cbecf99",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99"
    },
    "self-localized" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99?locale=en-US"
    },
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99{?locale}",
      "templated" : true
    },
    "availability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99/availability"
    },
    "attributes" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99/attributes{?locale}",
      "templated" : true
    },
    "attachments" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99/attachments"
    },
    "images" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99/images"
    },
    "default-image" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/a5ec9169-ebf1-4709-b140-31d33cbecf99/default-image"
    }
  }
}

Delete product

A DELETE request is used to delete a product.

Required scopes

prod:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/99c08237-ee16-4088-b83a-e3d621ea2257' -i -X DELETE -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

A search resource is used as entry-point for links to sub-resources offering dedicated product-related finders. Currently the following finders are offered:

Find existing attribute values

A GET request is issued to search for the attribute values that already exist for an attribute name. This is intended to be able to offer auto-suggestion functionality when adding custom attributes to a product.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search/find-attribute-string-values?namespace=seo&attributeName=slug&query=my-' -i -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.attributes

Array

The list of product attributes.

_links

Object

See Hypermedia

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 530

{
  "_embedded" : {
    "attributes" : [ {
      "attributeType" : "STRING",
      "booleanValue" : null,
      "stringValue" : "my-product",
      "numericValue" : null,
      "longValue" : null,
      "doubleValue" : null,
      "dateTimeValue" : null,
      "moneyValue" : null,
      "dataValue" : null,
      "attributeValue" : "my-product"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-attribute-string-values?namespace=seo&attributeName=slug&query=my-"
    }
  }
}

Find used tags

A GET request is issued to search used tags by a starting string. All strings are sorted by usage, beginning with the biggest.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search/tags?startsWith=c' -i -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.tags

Array

The tags used with a product ordered by usage.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 421

{
  "_embedded" : {
    "tags" : [ {
      "tag" : "car",
      "count" : 1
    }, {
      "tag" : "cool",
      "count" : 2
    }, {
      "tag" : "curious",
      "count" : 1
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/tags?startsWith=c&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

List product search meta-information

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search' -i -H 'Authorization: Bearer <Access token>'

Links

Relation Description

find-by-sku

The link to find products by SKU.

find-attribute-string-values

The link to search existing attribute values for a given attribute name and search string.

tags

The link to find products by tags. Ordered by number of usage.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 577

{
  "_links" : {
    "tags" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/tags{?startsWith,page,size,sort}",
      "templated" : true
    },
    "find-by-sku" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-by-sku{?sku}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search"
    },
    "find-attribute-string-values" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-attribute-string-values{?namespace,attributeName,query,page,size,sort}",
      "templated" : true
    }
  }
}

List products meta-information

The products resource offers API meta-information if you follow the profile link.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/profile/products' -i

Example response

HTTP/1.1 200 OK
Content-Type: application/alps+json;charset=UTF-8
Content-Length: 2580

{
  "alps" : {
    "version" : "1.0",
    "descriptors" : [ {
      "id" : "product-representation",
      "href" : "https://api-shop.beyondshop.cloud/api/profile/products",
      "descriptors" : [ {
        "name" : "sku",
        "type" : "SEMANTIC"
      }, {
        "name" : "onSale",
        "type" : "SEMANTIC"
      }, {
        "name" : "tags",
        "type" : "SEMANTIC"
      }, {
        "name" : "productIdentifiers",
        "type" : "SEMANTIC"
      }, {
        "name" : "visible",
        "type" : "SEMANTIC"
      }, {
        "name" : "taxClass",
        "doc" : {
          "value" : "REGULAR, REDUCED, EXEMPT",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      }, {
        "name" : "shippingWeight",
        "type" : "SEMANTIC"
      }, {
        "name" : "maxOrderQuantity",
        "type" : "SEMANTIC"
      }, {
        "name" : "_id",
        "type" : "SEMANTIC"
      } ]
    }, {
      "id" : "create-products",
      "name" : "products",
      "type" : "UNSAFE",
      "rt" : "#product-representation"
    }, {
      "id" : "get-products",
      "name" : "products",
      "type" : "SAFE",
      "rt" : "#product-representation",
      "descriptors" : [ {
        "name" : "page",
        "doc" : {
          "value" : "The page to return.",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      }, {
        "name" : "size",
        "doc" : {
          "value" : "The size of the page to return.",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      }, {
        "name" : "sort",
        "doc" : {
          "value" : "The sorting criteria to use to calculate the content of the page.",
          "format" : "TEXT"
        },
        "type" : "SEMANTIC"
      } ]
    }, {
      "id" : "patch-product",
      "name" : "product",
      "type" : "UNSAFE",
      "rt" : "#product-representation"
    }, {
      "id" : "delete-product",
      "name" : "product",
      "type" : "IDEMPOTENT",
      "rt" : "#product-representation"
    }, {
      "id" : "get-product",
      "name" : "product",
      "type" : "SAFE",
      "rt" : "#product-representation"
    }, {
      "id" : "update-product",
      "name" : "product",
      "type" : "IDEMPOTENT",
      "rt" : "#product-representation"
    }, {
      "name" : "tags",
      "type" : "SAFE",
      "descriptors" : [ {
        "name" : "startsWith",
        "type" : "SEMANTIC"
      } ]
    }, {
      "name" : "find-by-sku",
      "type" : "SAFE",
      "descriptors" : [ {
        "name" : "sku",
        "type" : "SEMANTIC"
      } ]
    } ]
  }
}

Show product details

A GET request is used to retrieve the details of a product.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/cf5f6dca-b8c8-4439-bfb9-7f40e4ba2850' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_id

String

The unique identifier of the product.

sku

String

The stock keeping unit (SKU) corresponding to the product.

name

String

The name of the product.

description

String

The description of the product.

salesPrice

Object

The current sales price of the product.

listPrice

Object

The original sales price of the product.

onSale

Boolean

Indicates if the product is on offer. Can be true or false.

manufacturer

String

The manufacturer of the product.

essentialFeatures

String

The essential features of the product. Shown in the cart and checkout. In Germany mandatory field in online shops according to §312j Abs. 2 BGB (German Civil Code).

tags

Array

The tags assigned to a product.

shippingDimension

Object

The shipping dimensions of the product displayed in mm.

shippingDimension.length

Number

The length of the product including packaging in mm.

shippingDimension.width

Number

The width of the product including packaging in mm.

shippingDimension.height

Number

The height of the product including packaging in mm.

shippingPeriod

Object

The shipping period for this particular product.

attributes[]

Array

The product properties. Identified by a qualified name consisting of namespace and name.

attributes[].namespace

String

The namespace of the product property. Groups all attribute names belonging to the same application in order to prevent name clashes. Example: a SEO app uses the namespace seo, whereas an Enterprise Management System uses ems. Both applications can use the same product property name, e.g. category by using another namespace. Examples: seo:category, ems:category.

attributes[].name

String

The name of the product property.

attributes[].displayName

String

The displayed name of the product property.

attributes[].value

Varies

The value of the product property.

attributes[].format

Null

The format of the attribute value.

attributes[].formattedValue

Varies

The formatted value of the product property.

refPrice

Object

The price information scaled to a standardised base unit.

refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

refPrice.quantity

Number

The actual quantity in the product.

refPrice.unit

String

The unit corresponding to the quanity.

refPrice.price

Object

The actual reference price.

availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

Links

Relation Description

default-image-data

A link relation to the default image URL. See also Hypermedia.

additional-image-data

A link relation to additional image URLs. See also Hypermedia.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2681

{
  "_id" : "cf5f6dca-b8c8-4439-bfb9-7f40e4ba2850",
  "sku" : "1234567-7-7-7",
  "name" : "Cardigan - bordeaux",
  "salesPrice" : {
    "amount" : 1.0,
    "currency" : "EUR"
  },
  "listPrice" : {
    "amount" : 1.0,
    "currency" : "EUR"
  },
  "onSale" : false,
  "listPriceText" : "Old Price",
  "shippingDimension" : {
    "length" : 18,
    "width" : 17,
    "height" : 16
  },
  "refPrice" : {
    "refQuantity" : 100,
    "unit" : "GRAM",
    "quantity" : 200,
    "price" : {
      "amount" : 12.0,
      "currency" : "EUR"
    }
  },
  "availabilityState" : "IN_STOCK",
  "description" : "This product unifies comfortable materials and has a nice wear comfort. Slim-fit",
  "manufacturer" : "Posh Brand",
  "essentialFeatures" : "essential information shown during checkout",
  "tags" : [ "tag 2", "tag3", "tag_1" ],
  "attributes" : [ {
    "namespace" : "seo",
    "name" : "slug",
    "value" : "cardigan-bordeaux",
    "displayName" : "slug",
    "format" : null,
    "formattedValue" : "cardigan-bordeaux"
  }, {
    "namespace" : "seo",
    "name" : "title",
    "value" : "Cardigan, bordeaux",
    "displayName" : "title",
    "format" : null,
    "formattedValue" : "Cardigan, bordeaux"
  }, {
    "namespace" : "test",
    "name" : "half-life",
    "value" : 4468300.0,
    "displayName" : "half-life",
    "format" : null,
    "formattedValue" : 4468300.0
  }, {
    "namespace" : "test",
    "name" : "long",
    "value" : 1,
    "displayName" : "long",
    "format" : null,
    "formattedValue" : 1
  } ],
  "shippingPeriod" : {
    "minDays" : null,
    "maxDays" : 14,
    "displayUnit" : "WEEKS"
  },
  "_links" : {
    "default-image-data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/cf5f6dca-b8c8-4439-bfb9-7f40e4ba2850"
    },
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/cf5f6dca-b8c8-4439-bfb9-7f40e4ba2850{?projection}",
      "templated" : true
    },
    "additional-image-data" : [ {
      "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "templated" : true
    }, {
      "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/P7120105.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225999{&width,height,upscale}",
      "templated" : true
    }, {
      "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/P7120106.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281226000{&width,height,upscale}",
      "templated" : true
    } ]
  }
}

Show enhanced view of product details

A GET request is used to retrieve enhanced details of a product.

Request parameters

Parameter Description

projection

The projection to apply in order to show an enhanced view of product details. Use enhancedProductProjection.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/cfac04bc-2fcb-4404-aa45-2fb31bea123d?projection=enhancedProductProjection' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_id

String

The unique identifier of the product.

_indexedAt

String

The time of storing this document in the search index.

sku

String

The stock keeping unit (SKU) corresponding to the product.

salesPrice

Object

The current sales price of the product.

listPrice

Object

The original sales price of the product.

onSale

Boolean

Indicates if the product is on offer. Can be true or false.

name

String

The name of the product.

description

String

The description of the product.

manufacturer

String

The manufacturer of the product.

essentialFeatures

Null

The essential features of the product. Shown in the cart and checkout. In Germany mandatory field in online shops according to §312j Abs. 2 BGB (German Civil Code).

tags

Array

The tags assigned to a product.

shippingDimension

Object

The shipping dimensions of the product displayed in mm.

shippingDimension.length

Number

The length of the product including packaging in mm.

shippingDimension.width

Number

The width of the product including packaging in mm.

shippingDimension.height

Number

The height of the product including packaging in mm.

attributes

Array

The product properties. Identified by a qualified name consisting of namespace and name.

refPrice

Object

The price information scaled to a standardised base unit.

refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

refPrice.quantity

Number

The actual quantity in the product.

refPrice.unit

String

The unit corresponding to the quanity.

refPrice.price

Object

The actual reference price.

shippingPeriod

Object

The shipping period for this particular product.

availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

Links

Relation Description

default-image-data

A link relation to the default image URL. See also Hypermedia.

additional-image-data

A link relation to additional image URLs. See also Hypermedia.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1582

{
  "_id" : "cfac04bc-2fcb-4404-aa45-2fb31bea123d",
  "_indexedAt" : "2017-12-07T13:50:08.235",
  "sku" : "1234568-9-9-9",
  "name" : "Blue Jeans",
  "salesPrice" : {
    "amount" : 2.0,
    "currency" : "EUR"
  },
  "listPrice" : {
    "amount" : 2.0,
    "currency" : "EUR"
  },
  "onSale" : true,
  "listPriceText" : "Old Price",
  "shippingDimension" : {
    "length" : 17,
    "width" : 16,
    "height" : 15
  },
  "refPrice" : {
    "refQuantity" : 100,
    "unit" : "GRAM",
    "quantity" : 200,
    "price" : {
      "amount" : 12.0,
      "currency" : "EUR"
    }
  },
  "availabilityState" : "IN_STOCK",
  "description" : "Classic stone-washed blue-jeans. Slim-fit",
  "manufacturer" : "Posh Brand",
  "essentialFeatures" : null,
  "tags" : [ "tag6" ],
  "attributes" : [ ],
  "shippingPeriod" : {
    "minDays" : null,
    "maxDays" : 14,
    "displayUnit" : "WEEKS"
  },
  "_links" : {
    "default-image-data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/blue_jeans_1.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e699999{&width,height,upscale}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/cfac04bc-2fcb-4404-aa45-2fb31bea123d"
    },
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/cfac04bc-2fcb-4404-aa45-2fb31bea123d{?projection}",
      "templated" : true
    },
    "additional-image-data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "templated" : true
    }
  }
}

List products

A GET request is issued to list all products.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_embedded.products[]._id

String

The unique identifier of the product.

_embedded.products[].sku

String

The stock keeping unit (SKU) corresponding to the product.

_embedded.products[].salesPrice

Object

The current sales price of the product.

_embedded.products[].listPrice

Object

The original sales price of the product.

_embedded.products[].onSale

Boolean

Indicates if the product is on offer. Can be true or false.

_embedded.products[].name

String

The name of the product.

_embedded.products[].shippingDimension.length

Number

The length of the product including packaging in mm.

_embedded.products[].shippingDimension.width

Number

The width of the product including packaging in mm.

_embedded.products[].shippingDimension.height

Number

The height of the product including packaging in mm.

_embedded.products[]._links

Object

The links to receive further information related to the product.

_embedded.products[]._links.default-image-data.href

String

A link relation to the default image URL. See also Hypermedia.

_embedded.products[].refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

_embedded.products[].refPrice.quantity

Number

The actual quantity in the product.

_embedded.products[].refPrice.unit

String

The unit corresponding to the quanity.

_embedded.products[].refPrice.price

Object

The actual reference price.

_embedded.products[].availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

_embedded.products[].listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3730

{
  "_embedded" : {
    "products" : [ {
      "_id" : "bce50aba-6d1f-4346-9aa4-bede63792a07",
      "sku" : "1234567-7-7-7",
      "name" : "Cardigan - bordeaux",
      "salesPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 18,
        "width" : 17,
        "height" : 16
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/bce50aba-6d1f-4346-9aa4-bede63792a07"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/bce50aba-6d1f-4346-9aa4-bede63792a07{?projection}",
          "templated" : true
        }
      }
    }, {
      "_id" : "434c6b02-9af3-4869-9420-138d370e88d4",
      "sku" : "1234568-8-8-8",
      "name" : "Beanie - olive",
      "salesPrice" : {
        "amount" : 3.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 3.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 19,
        "width" : 18,
        "height" : 17
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/434c6b02-9af3-4869-9420-138d370e88d4"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/434c6b02-9af3-4869-9420-138d370e88d4{?projection}",
          "templated" : true
        }
      }
    }, {
      "_id" : "fba11c35-feb2-43b9-a2c3-88c4f26817c8",
      "sku" : "1234568-9-9-9",
      "name" : "Blue Jeans",
      "salesPrice" : {
        "amount" : 2.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 2.0,
        "currency" : "EUR"
      },
      "onSale" : true,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 17,
        "width" : 16,
        "height" : 15
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/blue_jeans_1.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e699999{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/fba11c35-feb2-43b9-a2c3-88c4f26817c8"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/fba11c35-feb2-43b9-a2c3-88c4f26817c8{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products?page=0&size=40"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

List products by tags

A GET request is issued to search for products matching any tag of the list given by a client. This is intended to be able to offer product search capabilities for the Storefront.

Request parameters

Parameter Description

tag

The tags assigned to a product that MUST be matched for the search request.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search/find-by-tags?tag=tag3' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_embedded.products[]._id

String

The unique identifier of the product.

_embedded.products[].sku

String

The stock keeping unit (SKU) corresponding to the product.

_embedded.products[].salesPrice

Object

The current sales price of the product.

_embedded.products[].listPrice

Object

The original sales price of the product.

_embedded.products[].onSale

Boolean

Indicates if the product is on offer. Can be true or false.

_embedded.products[].name

String

The name of the product.

_embedded.products[].shippingDimension.length

Number

The length of the product including packaging in mm.

_embedded.products[].shippingDimension.width

Number

The width of the product including packaging in mm.

_embedded.products[].shippingDimension.height

Number

The height of the product including packaging in mm.

_embedded.products[]._links

Object

The links to receive further information related to the product.

_embedded.products[]._links.default-image-data.href

String

A link relation to the default image URL. See also Hypermedia.

_embedded.products[].refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

_embedded.products[].refPrice.quantity

Number

The actual quantity in the product.

_embedded.products[].refPrice.unit

String

The unit corresponding to the quanity.

_embedded.products[].refPrice.price

Object

The actual reference price.

_embedded.products[].availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

_embedded.products[].listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2551

{
  "_embedded" : {
    "products" : [ {
      "_id" : "55ade3c6-af70-4963-b6af-3388c055de58",
      "sku" : "1234568-8-8-8",
      "name" : "Beanie - olive",
      "salesPrice" : {
        "amount" : 3.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 3.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 19,
        "width" : 18,
        "height" : 17
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/55ade3c6-af70-4963-b6af-3388c055de58"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/55ade3c6-af70-4963-b6af-3388c055de58{?projection}",
          "templated" : true
        }
      }
    }, {
      "_id" : "4763a9dd-9c07-4015-b50f-4243fa231f48",
      "sku" : "1234567-7-7-7",
      "name" : "Cardigan - bordeaux",
      "salesPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 18,
        "width" : 17,
        "height" : 16
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/4763a9dd-9c07-4015-b50f-4243fa231f48"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/4763a9dd-9c07-4015-b50f-4243fa231f48{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-by-tags?page=0&size=40&sort=createdAt,desc&sort=id,asc"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

List products by term

A GET request is issued to search for products using a search query.

Request parameters

Parameter Description

query

The search term for the search request. If empty an unfiltered result is returned.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search/find-by-search-term?query=slim+fit' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_embedded.products[]._id

String

The unique identifier of the product.

_embedded.products[].sku

String

The stock keeping unit (SKU) corresponding to the product.

_embedded.products[].salesPrice

Object

The current sales price of the product.

_embedded.products[].listPrice

Object

The original sales price of the product.

_embedded.products[].onSale

Boolean

Indicates if the product is on offer. Can be true or false.

_embedded.products[].name

String

The name of the product.

_embedded.products[].shippingDimension.length

Number

The length of the product including packaging in mm.

_embedded.products[].shippingDimension.width

Number

The width of the product including packaging in mm.

_embedded.products[].shippingDimension.height

Number

The height of the product including packaging in mm.

_embedded.products[]._links

Object

The links to receive further information related to the product.

_embedded.products[]._links.default-image-data.href

String

A link relation to the default image URL. See also Hypermedia.

_embedded.products[].refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

_embedded.products[].refPrice.quantity

Number

The actual quantity in the product.

_embedded.products[].refPrice.unit

String

The unit corresponding to the quanity.

_embedded.products[].refPrice.price

Object

The actual reference price.

_embedded.products[].availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

_embedded.products[].listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2758

{
  "_embedded" : {
    "products" : [ {
      "_id" : "c1f99b37-f84e-46b8-8250-fdcc362bf8fc",
      "sku" : "1234568-9-9-9",
      "name" : "Blue Jeans",
      "salesPrice" : {
        "amount" : 2.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 2.0,
        "currency" : "EUR"
      },
      "onSale" : true,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 17,
        "width" : 16,
        "height" : 15
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/blue_jeans_1.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e699999{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/c1f99b37-f84e-46b8-8250-fdcc362bf8fc"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/c1f99b37-f84e-46b8-8250-fdcc362bf8fc{?projection}",
          "templated" : true
        }
      }
    }, {
      "_id" : "d4a73fe9-6069-40fb-b6ae-0f2ad48ae54d",
      "sku" : "1234567-7-7-7",
      "name" : "Cardigan - bordeaux",
      "salesPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 18,
        "width" : 17,
        "height" : 16
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/d4a73fe9-6069-40fb-b6ae-0f2ad48ae54d"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/d4a73fe9-6069-40fb-b6ae-0f2ad48ae54d{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-by-search-term?page=0&size=40&sort=id,asc"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

List products by category

A GET request is issued to search for products using a category id.

Request parameters

Parameter Description

categoryId

The unique identifier of the category a product is assigned to. Can be used to query products.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search/find-by-category?categoryId=1305018e-1470-44f7-a1b8-5e01e14d2441' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_embedded.products[]._id

String

The unique identifier of the product.

_embedded.products[].sku

String

The stock keeping unit (SKU) corresponding to the product.

_embedded.products[].salesPrice

Object

The current sales price of the product.

_embedded.products[].listPrice

Object

The original sales price of the product.

_embedded.products[].onSale

Boolean

Indicates if the product is on offer. Can be true or false.

_embedded.products[].name

String

The name of the product.

_embedded.products[].shippingDimension.length

Number

The length of the product including packaging in mm.

_embedded.products[].shippingDimension.width

Number

The width of the product including packaging in mm.

_embedded.products[].shippingDimension.height

Number

The height of the product including packaging in mm.

_embedded.products[]._links

Object

The links to receive further information related to the product.

_embedded.products[]._links.default-image-data.href

String

A link relation to the default image URL. See also Hypermedia.

_embedded.products[].refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

_embedded.products[].refPrice.quantity

Number

The actual quantity in the product.

_embedded.products[].refPrice.unit

String

The unit corresponding to the quanity.

_embedded.products[].refPrice.price

Object

The actual reference price.

_embedded.products[].availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

_embedded.products[].listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1572

{
  "_embedded" : {
    "products" : [ {
      "_id" : "79ae157c-5971-4cc3-b73d-c5237e13445a",
      "sku" : "1234567-7-7-7",
      "name" : "Cardigan - bordeaux",
      "salesPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 18,
        "width" : 17,
        "height" : 16
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/79ae157c-5971-4cc3-b73d-c5237e13445a"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/79ae157c-5971-4cc3-b73d-c5237e13445a{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-by-category?categoryId=1305018e-1470-44f7-a1b8-5e01e14d2441&page=0&size=40&sort=id,asc"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

List products by query using request parameter

A GET request is issued to search for products using a query provided as request parameter.

Request parameters

Parameter Description

query

The Elasticsearch query to use for the search request.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search/find-by-query?query=%7B%22bool%22:%7B%22filter%22:[%7B%22term%22:%7B%22tags%22:%22tag_1%22%7D%7D,%7B%22range%22:%7B%22salesPrice.amount%22:%7B%22lte%22:2.0%7D%7D%7D,%7B%22range%22:%7B%22createdAt%22:%7B%22gte%22:%22now-1h%22%7D%7D%7D]%7D%7D' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json'

Response body properties

Path Type Description

_embedded.products[]._id

String

The unique identifier of the product.

_embedded.products[].sku

String

The stock keeping unit (SKU) corresponding to the product.

_embedded.products[].salesPrice

Object

The current sales price of the product.

_embedded.products[].listPrice

Object

The original sales price of the product.

_embedded.products[].onSale

Boolean

Indicates if the product is on offer. Can be true or false.

_embedded.products[].name

String

The name of the product.

_embedded.products[].shippingDimension.length

Number

The length of the product including packaging in mm.

_embedded.products[].shippingDimension.width

Number

The width of the product including packaging in mm.

_embedded.products[].shippingDimension.height

Number

The height of the product including packaging in mm.

_embedded.products[]._links

Object

The links to receive further information related to the product.

_embedded.products[]._links.default-image-data.href

String

A link relation to the default image URL. See also Hypermedia.

_embedded.products[].refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

_embedded.products[].refPrice.quantity

Number

The actual quantity in the product.

_embedded.products[].refPrice.unit

String

The unit corresponding to the quanity.

_embedded.products[].refPrice.price

Object

The actual reference price.

_embedded.products[].availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

_embedded.products[].listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1748

{
  "_embedded" : {
    "products" : [ {
      "_id" : "34c14db4-d03f-45ba-87a0-8a439af521c9",
      "sku" : "1234567-7-7-7",
      "name" : "Cardigan - bordeaux",
      "salesPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 18,
        "width" : 17,
        "height" : 16
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/34c14db4-d03f-45ba-87a0-8a439af521c9"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/34c14db4-d03f-45ba-87a0-8a439af521c9{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-by-query?query=%7B%22bool%22:%7B%22filter%22:[%7B%22term%22:%7B%22tags%22:%22tag_1%22%7D%7D,%7B%22range%22:%7B%22salesPrice.amount%22:%7B%22lte%22:2.0%7D%7D%7D,%7B%22range%22:%7B%22createdAt%22:%7B%22gte%22:%22now-1h%22%7D%7D%7D]%7D%7D&page=0&size=40&sort=id,asc"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

List products by query using request body

A POST request is issued to search for products using a query provided as request body.

Request body properties

Path Type Description

bool

Object

The Elasticsearch query.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/search/find-by-query' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -d '{"bool":{"filter":[{"term":{"tags":"tag_1"}},{"range":{"salesPrice.amount":{"lte":2.0}}},{"range":{"createdAt":{"gte":"now-1h"}}}]}}'

Response body properties

Path Type Description

_embedded.products[]._id

String

The unique identifier of the product.

_embedded.products[].sku

String

The stock keeping unit (SKU) corresponding to the product.

_embedded.products[].salesPrice

Object

The current sales price of the product.

_embedded.products[].listPrice

Object

The original sales price of the product.

_embedded.products[].onSale

Boolean

Indicates if the product is on offer. Can be true or false.

_embedded.products[].name

String

The name of the product.

_embedded.products[].shippingDimension.length

Number

The length of the product including packaging in mm.

_embedded.products[].shippingDimension.width

Number

The width of the product including packaging in mm.

_embedded.products[].shippingDimension.height

Number

The height of the product including packaging in mm.

_embedded.products[]._links

Object

The links to receive further information related to the product.

_embedded.products[]._links.default-image-data.href

String

A link relation to the default image URL. See also Hypermedia.

_embedded.products[].refPrice.refQuantity

Number

The reference quantity the product’s reference price is calculated on.

_embedded.products[].refPrice.quantity

Number

The actual quantity in the product.

_embedded.products[].refPrice.unit

String

The unit corresponding to the quanity.

_embedded.products[].refPrice.price

Object

The actual reference price.

_embedded.products[].availabilityState

String

The current availability state for the product. Can be IN_STOCK, LOW_STOCK or OUT_OF_STOCK.

_embedded.products[].listPriceText

String

The text that comes along with the list price.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1521

{
  "_embedded" : {
    "products" : [ {
      "_id" : "0dc41740-040a-4a83-9d89-920b4c4d138e",
      "sku" : "1234567-7-7-7",
      "name" : "Cardigan - bordeaux",
      "salesPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "listPrice" : {
        "amount" : 1.0,
        "currency" : "EUR"
      },
      "onSale" : false,
      "listPriceText" : "Old Price",
      "shippingDimension" : {
        "length" : 18,
        "width" : 17,
        "height" : 16
      },
      "refPrice" : {
        "refQuantity" : 100,
        "unit" : "GRAM",
        "quantity" : 200,
        "price" : {
          "amount" : 12.0,
          "currency" : "EUR"
        }
      },
      "availabilityState" : "IN_STOCK",
      "_links" : {
        "default-image-data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/storage-api/images/Cardigan.jpg?hash=e9a1ce5c0c6abfebec8fb1f6faf77dca7e6e7777{&width,height,upscale}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/0dc41740-040a-4a83-9d89-920b4c4d138e"
        },
        "product" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/0dc41740-040a-4a83-9d89-920b4c4d138e{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/search/find-by-query?page=0&size=40&sort=id,asc"
    }
  },
  "page" : {
    "size" : 40,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Example queries

A query for products having either tag cupcake or cake and a price greater or equal than 3.

{
  "bool": {
    "filter": [
      {
        "terms": {
          "tags": [
            "cupcake",
            "cake"
          ]
        }
      },
      {
        "term": {
          "salesPrice.amount": {
            "gte": 3
          }
        }
      }
    ]
  }
}

A query for products having a custom integer attribute vol with a value less or equal than 14 and having either tag beer or wine.

{
  "bool": {
    "filter": [
      { "nested": {
          "path": "attributes",
          "query": {
            "bool": {
              "filter": [
                { "term": { "attributes.name": "vol" } },
                { "range": { "attributes.longValue": { "lte": 14 } } }
              ]
            }
          }
        }
      },
      { "terms": { "tags": [ "beer", "wine" ] } }
    ]
  }
}

A query for products having three custom attributes length, width and height each being less than 300.

{
  "bool": {
    "filter": [
      { "nested": {
          "path": "attributes",
          "query": {
            "bool": {
              "filter": [
                { "term": { "attributes.name": "length" } },
                { "range": { "attributes.longValue": { "lt": 300 } } }
              ]
            }
          }
        }
      },
      { "nested": {
          "path": "attributes",
          "query": {
            "bool": {
              "filter": [
                { "term": { "attributes.name": "width" } },
                { "range": { "attributes.longValue": { "lt": 300 } } }
              ]
            }
          }
        }
      },
      { "nested": {
          "path": "attributes",
          "query": {
            "bool": {
              "filter": [
                { "term": { "attributes.name": "height" } },
                { "range": { "attributes.longValue": { "lt": 300 } } }
              ]
            }
          }
        }
      }
    ]
  }
}

Product Attachments

List product attachments

A GET request is used to retrieve the attachments of a product.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/aaebdc90-1b0e-49a0-ae59-70ebd85fff3c/attachments' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2065

{
  "_embedded" : {
    "attachments" : [ {
      "mimeType" : "application/pdf",
      "length" : 1,
      "label" : "Handbuch",
      "_id" : "80585a0d-a530-45d1-acda-c3709d5f6208",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/aaebdc90-1b0e-49a0-ae59-70ebd85fff3c/attachments/80585a0d-a530-45d1-acda-c3709d5f6208"
        },
        "data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/1_my_attachment.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225801"
        },
        "metadata" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/1_my_attachment.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225801&download=no"
        },
        "attachment" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/aaebdc90-1b0e-49a0-ae59-70ebd85fff3c/attachments/80585a0d-a530-45d1-acda-c3709d5f6208"
        }
      }
    }, {
      "mimeType" : "application/pdf",
      "length" : 1,
      "label" : "Handbuch",
      "_id" : "dedb12dc-3a0b-4a3f-afbe-7eee6baee4e2",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/aaebdc90-1b0e-49a0-ae59-70ebd85fff3c/attachments/dedb12dc-3a0b-4a3f-afbe-7eee6baee4e2"
        },
        "data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/2_my_attachment.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225802"
        },
        "metadata" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/2_my_attachment.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225802&download=no"
        },
        "attachment" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/aaebdc90-1b0e-49a0-ae59-70ebd85fff3c/attachments/dedb12dc-3a0b-4a3f-afbe-7eee6baee4e2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/aaebdc90-1b0e-49a0-ae59-70ebd85fff3c/attachments?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Show product attachment details

A GET request is used to retrieve a single attachment of a product.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/dc339720-8e26-4640-89a7-cf1c2a06932c/attachments/3a7afc44-6ea9-4688-a204-c9f02bc761b7' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The immutable, unique identifier of the requested resource.

mimeType

String

The media type of the product attachment.

length

Number

The length of the product attachment.

label

String

The label of the product attachment.

_links

Object

See Hypermedia

Links

Relation Description

data

Absolute URI to retrieve the binary data.

metadata

Absolute URI to retrieve the metadata.

attachment

The templated self link of the product attachment. Current representation of the resource. See Hypermedia.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 803

{
  "mimeType" : "application/pdf",
  "length" : 1,
  "label" : "Handbuch",
  "_id" : "3a7afc44-6ea9-4688-a204-c9f02bc761b7",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/dc339720-8e26-4640-89a7-cf1c2a06932c/attachments/3a7afc44-6ea9-4688-a204-c9f02bc761b7"
    },
    "data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/1_my_attachment.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225801"
    },
    "metadata" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/1_my_attachment.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225801&download=no"
    },
    "attachment" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/dc339720-8e26-4640-89a7-cf1c2a06932c/attachments/3a7afc44-6ea9-4688-a204-c9f02bc761b7"
    }
  }
}

Add product attachment

A POST request is used to create an attachment and add it to a product.

Required scopes

prod:u

Request body properties

Path Type Description Constraints

dataUri

String

The templated relative download URL of the product attachment.

Must be a valid storage service URI (must contain a hash query parameter). Must not be null

mimeType

String

The media type of the product attachment.

Must not be null

length

Number

The length of the product attachment.

Must be greater than 1 and less than 9223372036854775807. Must not be null

label

String

The label of the product attachment.

Must not be null

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/1e3f009e-48a0-4635-838e-ad5c510dd533/attachments' -i -X POST -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"mimeType":"application/pdf","length":1,"label":"Handbuch","dataUri":"my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666"}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/1e3f009e-48a0-4635-838e-ad5c510dd533/attachments/93ae947d-aec8-4d39-ab77-1695aa410fd3
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 799

{
  "mimeType" : "application/pdf",
  "length" : 1,
  "label" : "Handbuch",
  "_id" : "93ae947d-aec8-4d39-ab77-1695aa410fd3",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1e3f009e-48a0-4635-838e-ad5c510dd533/attachments/93ae947d-aec8-4d39-ab77-1695aa410fd3"
    },
    "data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666"
    },
    "metadata" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/attachments/my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666&download=no"
    },
    "attachment" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1e3f009e-48a0-4635-838e-ad5c510dd533/attachments/93ae947d-aec8-4d39-ab77-1695aa410fd3"
    }
  }
}

Delete product attachment

A DELETE request is used to delete a product attachment.

Required scopes

prod:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/278f7cf9-541b-4611-803c-27be738f7c98/attachments/bb4dbc3b-655a-4784-89af-187c4927ea6c' -i -X DELETE -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Product Attribute Definitions

Attribute definitions provide meta-data for attributes. An attribute definitions is a precondition to create custom attributes

List product attribute definitions

Required scopes

prad:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions?locale=en-US' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.product-attribute-definitions

Array

The list of product attribute definitions.

page

Object

See Pagination

_links

Object

See Hypermedia

Links

Relation Description

search

The link to product property definiton search endpoints.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1062

{
  "_embedded" : {
    "product-attribute-definitions" : [ {
      "name" : "colour",
      "namespace" : "custom",
      "format" : null,
      "type" : "STRING",
      "displayName" : "Color",
      "_id" : "827ee9ce-2e89-49de-bcc0-08f58a04e020",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/827ee9ce-2e89-49de-bcc0-08f58a04e020"
        },
        "product-attribute-definition" : {
          "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/827ee9ce-2e89-49de-bcc0-08f58a04e020"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "https://api-shop.beyondshop.cloud/api/profile/product-attribute-definitions"
    },
    "search" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Show product attribute definition details

A GET request is used to retrieve a single attribute definitions by id.

Required scopes

prad:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions/84b45a85-04d7-428a-8be2-6d5601b310b5?locale=en-US' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The immutable, unique identifier of the requested resource.

namespace

String

The namespace of the product attribute definiton.

name

String

The name of the product attribute definition.

type

String

The type product attribute definition. Optional. Defaults to STRING.

format

Null

(Optional) A format pattern that is applied to the value of each attribute instance.

displayName

String

The displayed name of the product attribute.

_links

Object

See Hypermedia

Links

Relation Description

product-attribute-definition

The templated self link of the product property definition. Current representation of the resource. See Hypermedia.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:51:23 GMT
ETag: "1"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 471

{
  "name" : "colour",
  "namespace" : "custom",
  "format" : null,
  "type" : "STRING",
  "displayName" : "Color",
  "_id" : "84b45a85-04d7-428a-8be2-6d5601b310b5",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/84b45a85-04d7-428a-8be2-6d5601b310b5"
    },
    "product-attribute-definition" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/84b45a85-04d7-428a-8be2-6d5601b310b5"
    }
  }
}

Create product attribute definition

A POST request is used to create an attribute definition.

Required scopes

prad:c

Request body properties

Path Type Description Constraints

namespace

String

The namespace of the product attribute definiton.

Must not be null

name

String

The name of the product attribute definition.

Must not be null

displayName

String

The displayed name of the product attribute.

type

String

The type product attribute definition. Optional. Defaults to STRING.

Must not be null

format

String

(Optional) A format pattern that is applied to the value of each attribute instance.

Format pattern is not applicable for decimal numbers

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions?locale=en-US' -i -X POST -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"namespace":"custom","name":"filling_capacity","type":"NUMBER","displayName":"Filling Capacity","format":"#,###.## ml"}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "1"
Last-Modified: Thu, 07 Dec 2017 13:51:28 GMT
Location: https://api-shop.beyondshop.cloud/api/product-attribute-definitions/1c4ec380-d5dc-408d-848a-25648ac188ce
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 501

{
  "name" : "filling_capacity",
  "namespace" : "custom",
  "format" : "#,###.## ml",
  "type" : "NUMBER",
  "displayName" : "Filling Capacity",
  "_id" : "1c4ec380-d5dc-408d-848a-25648ac188ce",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/1c4ec380-d5dc-408d-848a-25648ac188ce"
    },
    "product-attribute-definition" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/1c4ec380-d5dc-408d-848a-25648ac188ce"
    }
  }
}

Delete product attribute definition

A DELETE request is used to delete a product attribute definition. Only attribute definitions that are not used in any product can be deleted.

Required scopes

prad:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions/5035ec8a-1cf2-4126-968c-a54feb72a1f5' -i -X DELETE -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Update product attribute definition

A Patch request can be used to update a product attribute definitions. The namespace, name and type fields cannot be changed. The displayName that is updated depends on the locale parameter.

Required scopes

prad:u

Request body properties

Path Type Description

displayName

String

The displayed name of the product attribute.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions/a9e6e26b-f5ea-4ae9-b8c7-55cc40ec43a4?locale=en-US' -i -X PATCH -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"displayName":"Color of the item"}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "2"
Last-Modified: Thu, 07 Dec 2017 13:51:16 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 483

{
  "name" : "colour",
  "namespace" : "custom",
  "format" : null,
  "type" : "STRING",
  "displayName" : "Color of the item",
  "_id" : "a9e6e26b-f5ea-4ae9-b8c7-55cc40ec43a4",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/a9e6e26b-f5ea-4ae9-b8c7-55cc40ec43a4"
    },
    "product-attribute-definition" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/a9e6e26b-f5ea-4ae9-b8c7-55cc40ec43a4"
    }
  }
}

A search resource is used as entry-point for links to sub-resources offering attribute definition searches. Currently the following finders are offered:

Find existing attribute definitions by namespace and name

A GET request is issued to search for the one attribute definition by namespace and name.

Required scopes

prad:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions/search/find-by-namespace-and-name?namespace=custom&name=colour' -i -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:51:19 GMT
ETag: "1"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 471

{
  "name" : "colour",
  "namespace" : "custom",
  "format" : null,
  "type" : "STRING",
  "displayName" : "Color",
  "_id" : "e155de97-0dcf-4e6a-bddb-7e9c297fc342",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/e155de97-0dcf-4e6a-bddb-7e9c297fc342"
    },
    "product-attribute-definition" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/e155de97-0dcf-4e6a-bddb-7e9c297fc342"
    }
  }
}

Find existing attribute definitions by namespace and query

A GET request is issued to search for the attribute definitions that already exist by namespace and prefix of the name.

Required scopes

prad:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions/search/find-by-namespace-and-query?namespace=custom&query=col' -i -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.product-attribute-definitions

Array

The list of product attribute definitions.

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 888

{
  "_embedded" : {
    "product-attribute-definitions" : [ {
      "name" : "colour",
      "namespace" : "custom",
      "format" : null,
      "type" : "STRING",
      "displayName" : "Color",
      "_id" : "01522c9c-a959-4b84-b955-ef4d6d109290",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/01522c9c-a959-4b84-b955-ef4d6d109290"
        },
        "product-attribute-definition" : {
          "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/01522c9c-a959-4b84-b955-ef4d6d109290"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/product-attribute-definitions/search/find-by-namespace-and-query?namespace=custom&query=col&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Product Availability

Show product availability details

A GET request is used to retrieve the availability of a product.

Required scopes

prda:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/7af16f20-68cc-42df-8424-8a9f7d49c3c5/availability?locale=en-US' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

availableStock

Number

The number of products available in stock.

stockThreshold

Number

The threshold of the available stock level.

purchasable

Boolean

Whether a product can be purchased or not.

availabilityState

String

The current availability state of the product. If the related product is not purchasable availability state will be NOT_AVAILABLE. If the stock level is equal or lower than this value the availability state is LOW_STOCK. Can be IN_STOCK, LOW_STOCK, NOT_AVAILABLE or OUT_OF_STOCK.

_links

Object

See Hypermedia

Links

Relation Description

product

The templated self link of the product. Current representation of the resource. See Hypermedia.

disable-purchasability

The link to disable purchasability.

disable-stock-management

The link to disable the stock management.

adjust-available-stock

The link to adjust the available stock.

update-stock-threshold

The link to update the stock threshold.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1026

{
  "availabilityState" : "IN_STOCK",
  "availableStock" : 20,
  "stockThreshold" : 2,
  "purchasable" : true,
  "_links" : {
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7af16f20-68cc-42df-8424-8a9f7d49c3c5"
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7af16f20-68cc-42df-8424-8a9f7d49c3c5/availability"
    },
    "disable-purchasability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7af16f20-68cc-42df-8424-8a9f7d49c3c5/availability/disable-purchasability"
    },
    "adjust-available-stock" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7af16f20-68cc-42df-8424-8a9f7d49c3c5/availability/adjust-available-stock"
    },
    "update-stock-threshold" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7af16f20-68cc-42df-8424-8a9f7d49c3c5/availability/update-stock-threshold"
    },
    "disable-stock-management" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7af16f20-68cc-42df-8424-8a9f7d49c3c5/availability/disable-stock-management"
    }
  }
}

Enable stock management

A POST request is used to enable stock management for a product.

Required scopes

prda:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7/availability/enable-stock-management?locale=en-US' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{ "initialAvailableStock" : 100, "stockThreshold" : 2 }'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7/availability
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1027

{
  "availabilityState" : "IN_STOCK",
  "availableStock" : 100,
  "stockThreshold" : 2,
  "purchasable" : true,
  "_links" : {
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7"
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7/availability"
    },
    "disable-purchasability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7/availability/disable-purchasability"
    },
    "adjust-available-stock" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7/availability/adjust-available-stock"
    },
    "update-stock-threshold" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7/availability/update-stock-threshold"
    },
    "disable-stock-management" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/23700dca-c702-4bc7-bf3f-f4616e02f4d7/availability/disable-stock-management"
    }
  }
}

Disable stock management

A POST request is used to disable stock management for a product.

Required scopes

prda:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/2e390b9b-dd14-47c0-835a-496c724aca43/availability/disable-stock-management' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d 'locale=en-US'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/2e390b9b-dd14-47c0-835a-496c724aca43/availability
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 701

{
  "availabilityState" : "IN_STOCK",
  "availableStock" : null,
  "stockThreshold" : null,
  "purchasable" : true,
  "_links" : {
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2e390b9b-dd14-47c0-835a-496c724aca43"
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2e390b9b-dd14-47c0-835a-496c724aca43/availability"
    },
    "disable-purchasability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2e390b9b-dd14-47c0-835a-496c724aca43/availability/disable-purchasability"
    },
    "enable-stock-management" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2e390b9b-dd14-47c0-835a-496c724aca43/availability/enable-stock-management"
    }
  }
}

Adjust stock level

A POST request is used to adjust the available stock of a product.

Required scopes

prda:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e/availability/adjust-available-stock?locale=en-US' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{ "relativeAmount" : -1 }'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e/availability
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1025

{
  "availabilityState" : "IN_STOCK",
  "availableStock" : 9,
  "stockThreshold" : 2,
  "purchasable" : true,
  "_links" : {
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e"
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e/availability"
    },
    "disable-purchasability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e/availability/disable-purchasability"
    },
    "adjust-available-stock" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e/availability/adjust-available-stock"
    },
    "update-stock-threshold" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e/availability/update-stock-threshold"
    },
    "disable-stock-management" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/1228dcb0-84cd-49c4-9d43-2cc59b668d8e/availability/disable-stock-management"
    }
  }
}

Update safety stock

A POST request is used to update the the stock threshold of a product.

Required scopes

prda:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37/availability/update-stock-threshold?locale=en-US' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{ "stockThreshold" : 5 }'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37/availability
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1026

{
  "availabilityState" : "IN_STOCK",
  "availableStock" : 10,
  "stockThreshold" : 5,
  "purchasable" : true,
  "_links" : {
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37"
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37/availability"
    },
    "disable-purchasability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37/availability/disable-purchasability"
    },
    "adjust-available-stock" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37/availability/adjust-available-stock"
    },
    "update-stock-threshold" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37/availability/update-stock-threshold"
    },
    "disable-stock-management" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/432d8b73-70aa-448e-a970-2477cbdf6a37/availability/disable-stock-management"
    }
  }
}

Enable purchasability

A POST request is used to enable purchasability for a product.

Required scopes

prda:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/7340c153-e4ba-495e-adb8-f9983bf86c3b/availability/enable-purchasability' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d 'locale=en-US'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/7340c153-e4ba-495e-adb8-f9983bf86c3b/availability
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 701

{
  "availabilityState" : "IN_STOCK",
  "availableStock" : null,
  "stockThreshold" : null,
  "purchasable" : true,
  "_links" : {
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7340c153-e4ba-495e-adb8-f9983bf86c3b"
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7340c153-e4ba-495e-adb8-f9983bf86c3b/availability"
    },
    "disable-purchasability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7340c153-e4ba-495e-adb8-f9983bf86c3b/availability/disable-purchasability"
    },
    "enable-stock-management" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7340c153-e4ba-495e-adb8-f9983bf86c3b/availability/enable-stock-management"
    }
  }
}

Disable purchasability

A POST request is used to disable purchasability for a product.

Required scopes

prda:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/f1bd9266-487a-42d5-b406-ff99c79341dd/availability/disable-purchasability' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d 'locale=en-US'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/f1bd9266-487a-42d5-b406-ff99c79341dd/availability
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 705

{
  "availabilityState" : "NOT_AVAILABLE",
  "availableStock" : null,
  "stockThreshold" : null,
  "purchasable" : false,
  "_links" : {
    "product" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/f1bd9266-487a-42d5-b406-ff99c79341dd"
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/f1bd9266-487a-42d5-b406-ff99c79341dd/availability"
    },
    "enable-purchasability" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/f1bd9266-487a-42d5-b406-ff99c79341dd/availability/enable-purchasability"
    },
    "enable-stock-management" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/f1bd9266-487a-42d5-b406-ff99c79341dd/availability/enable-stock-management"
    }
  }
}

Custom Product Attributes

The attributes resource is used to manage additional user-defined attributes on any type supporting this facility.

Attribute types

These are the basic types supported by the API.

Type Description

BOOLEAN

Boolean value (true,false)

STRING

String value (max. 4kb)

LONG

Long integer

DOUBLE

Double-precision floating number

DATE_TIME

Date and time without timezone information (UTC)

MONEY

Money value

DATA

Byte array

Localization

All attributes can be localized, so that you can assign one specific value per attribute name and locale. If you want non-localized attributes, just use an empty locale (""), which is equivalent to the "root locale".

Custom attributes

Request parameters for custom attributes endpoints

Parameter Description

locale

Optional LocaleCode parameter

Response structure for custom attributes endpoints

Path Type Description

_embedded.attributes[].namespace

String

Namespace

_embedded.attributes[].name

String

Name

_embedded.attributes[].locale

String

Locale

_embedded.attributes[].value

Boolean

Value

_embedded.attributes[].type

String

Type

Create custom product attribute

Required scopes

prod:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/7e62e994-ee03-4b9a-bb52-445d8172ce24/attributes' -i -X POST -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"namespace":"my_test_namespace111","name":"my_test_attr_name111","locale":"en_US","type":"STRING","value":"my_test_string_value"}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/7e62e994-ee03-4b9a-bb52-445d8172ce24/attributes

List custom product attributes

To receive product custom attributes list optional locale parameter can be specified.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes?locale=de-DE' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.attributes[].namespace

String

The namespace of the product attribute.

_embedded.attributes[].name

String

The name of the product attribute.

_embedded.attributes[].locale

String

The locale of the product attribute.

_embedded.attributes[].value

Varies

The value of the product attribute.

_embedded.attributes[].type

String

The type of the product attribute.

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

owner

The link to the owner of the product.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3289

{
  "_embedded" : {
    "attributes" : [ {
      "namespace" : "_dummy_namespace",
      "name" : "_dummy_attr_different_locale",
      "locale" : "de-DE",
      "type" : "STRING",
      "value" : "attrappe-produkt",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes/_dummy_namespace/_dummy_attr_different_locale?locale=de-DE"
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310"
        }
      }
    }, {
      "namespace" : "_dummy_namespace",
      "name" : "_dummy_attr_undefined_locale",
      "locale" : "",
      "type" : "BOOLEAN",
      "value" : true,
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes/_dummy_namespace/_dummy_attr_undefined_locale?locale="
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310"
        }
      }
    }, {
      "namespace" : "mbo",
      "name" : "flag",
      "locale" : "",
      "type" : "BOOLEAN",
      "value" : true,
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes/mbo/flag?locale="
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310"
        }
      }
    }, {
      "namespace" : "namespace_seo",
      "name" : "attr_different_locale",
      "locale" : "de-DE",
      "type" : "STRING",
      "value" : "mein-produkt",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes/namespace_seo/attr_different_locale?locale=de-DE"
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310"
        }
      }
    }, {
      "namespace" : "namespace_seo",
      "name" : "attr_undefined_locale",
      "locale" : "",
      "type" : "BOOLEAN",
      "value" : true,
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes/namespace_seo/attr_undefined_locale?locale="
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310"
        }
      }
    }, {
      "namespace" : "seo",
      "name" : "slug",
      "locale" : "de-DE",
      "type" : "STRING",
      "value" : "mein-produkt",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes/seo/slug?locale=de-DE"
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310/attributes?locale=de-DE"
    },
    "owner" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/700d33a0-1d83-4706-bdc1-ea66b4d95310"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 6,
    "totalPages" : 1,
    "number" : 0
  }
}

List custom product attributes by namespace

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/2822b083-ef3c-4ca4-8360-0864ad252df2/attributes/seo?locale=en-US' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.attributes[].namespace

String

The namespace of the product attribute.

_embedded.attributes[].name

String

The name of the product attribute.

_embedded.attributes[].locale

String

The locale of the product attribute.

_embedded.attributes[].value

String

The value of the product attribute.

_embedded.attributes[].type

String

The type of the product attribute.

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

owner

The link to the owner of the product.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 854

{
  "_embedded" : {
    "attributes" : [ {
      "namespace" : "seo",
      "name" : "slug",
      "locale" : "en-US",
      "type" : "STRING",
      "value" : "my-product",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/2822b083-ef3c-4ca4-8360-0864ad252df2/attributes/seo/slug?locale=en-US"
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/2822b083-ef3c-4ca4-8360-0864ad252df2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2822b083-ef3c-4ca4-8360-0864ad252df2/attributes?locale=en-US"
    },
    "owner" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/2822b083-ef3c-4ca4-8360-0864ad252df2"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

List custom product attributes by namespace and attribute name

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/951b3ed8-f7cf-412c-9e82-902d74fb9af0/attributes/namespace_seo/attr_different_locale?locale=de-DE' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.attributes[].namespace

String

The namespace of the product attribute.

_embedded.attributes[].name

String

The name of the product attribute.

_embedded.attributes[].locale

String

The locale of the product attribute.

_embedded.attributes[].value

String

The value of the product attribute.

_embedded.attributes[].type

String

The type of the product attribute.

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

owner

The link to the owner of the product.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 946

{
  "_embedded" : {
    "attributes" : [ {
      "namespace" : "namespace_seo",
      "name" : "attr_different_locale",
      "locale" : "de-DE",
      "type" : "STRING",
      "value" : "mein-produkt",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/951b3ed8-f7cf-412c-9e82-902d74fb9af0/attributes/namespace_seo/attr_different_locale?locale=de-DE"
        },
        "owner" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/951b3ed8-f7cf-412c-9e82-902d74fb9af0"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/951b3ed8-f7cf-412c-9e82-902d74fb9af0/attributes/namespace_seo/attr_different_locale?locale=de-DE"
    },
    "owner" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/951b3ed8-f7cf-412c-9e82-902d74fb9af0"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Delete custom product attribute

Required scopes

prod:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/145b6141-6467-435b-8d82-d73590763e8d/attributes/seo/slug' -i -X DELETE -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Product Images

List product images

A GET request is used to retrieve the images of a product.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/7170ea15-c85f-4bbc-9523-f0b49aa5f2d3/images' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1911

{
  "_embedded" : {
    "images" : [ {
      "_id" : "813f4828-2261-47ee-9228-da932e564659",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/7170ea15-c85f-4bbc-9523-f0b49aa5f2d3/images/813f4828-2261-47ee-9228-da932e564659"
        },
        "data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
          "templated" : true
        },
        "metadata" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998&download=no"
        },
        "image" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/7170ea15-c85f-4bbc-9523-f0b49aa5f2d3/images/813f4828-2261-47ee-9228-da932e564659"
        }
      }
    }, {
      "_id" : "a2d9cd84-dd60-4aeb-b2a9-fe87870bc93e",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/7170ea15-c85f-4bbc-9523-f0b49aa5f2d3/images/a2d9cd84-dd60-4aeb-b2a9-fe87870bc93e"
        },
        "data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120105.png?hash=8a627f655c68f56dfbbf217ab7d5563281225999{&width,height,upscale}",
          "templated" : true
        },
        "metadata" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120105.png?hash=8a627f655c68f56dfbbf217ab7d5563281225999&download=no"
        },
        "image" : {
          "href" : "https://api-shop.beyondshop.cloud/api/products/7170ea15-c85f-4bbc-9523-f0b49aa5f2d3/images/a2d9cd84-dd60-4aeb-b2a9-fe87870bc93e"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/7170ea15-c85f-4bbc-9523-f0b49aa5f2d3/images?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Show product image details

A GET request is used to retrieve a single image of a product.

Required scopes

prod:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/063f34ec-1d45-4bb1-899b-7394ea65aa03/images/9756dd9b-df1e-4d69-9ce9-beeb19dd56ac' -i -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The immutable, unique identifier of the requested resource.

_links

Object

See Hypermedia

Links

Relation Description

image

The link to the product image.

data

Download URL of the product image.

metadata

The URL to the image metadata of the product image.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 739

{
  "_id" : "9756dd9b-df1e-4d69-9ce9-beeb19dd56ac",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/063f34ec-1d45-4bb1-899b-7394ea65aa03/images/9756dd9b-df1e-4d69-9ce9-beeb19dd56ac"
    },
    "data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "templated" : true
    },
    "metadata" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998&download=no"
    },
    "image" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/063f34ec-1d45-4bb1-899b-7394ea65aa03/images/9756dd9b-df1e-4d69-9ce9-beeb19dd56ac"
    }
  }
}

Add product image

A POST request is used to create an image and add it to a product.

Required scopes

prod:u

Request body properties

Path Type Description Constraints

dataUri

String

The templated relative download URL of the product image.

Must be a valid storage service URI (must contain a hash query parameter). Must not be null

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/b5650e99-9e2a-4c2a-b761-314bc10b9ee7/images' -i -X POST -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{"dataUri":"P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998"}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/products/b5650e99-9e2a-4c2a-b761-314bc10b9ee7/images/6f5164df-8de7-4505-9d26-614ba871b351
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 739

{
  "_id" : "6f5164df-8de7-4505-9d26-614ba871b351",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/b5650e99-9e2a-4c2a-b761-314bc10b9ee7/images/6f5164df-8de7-4505-9d26-614ba871b351"
    },
    "data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998{&width,height,upscale}",
      "templated" : true
    },
    "metadata" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/P7120104.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998&download=no"
    },
    "image" : {
      "href" : "https://api-shop.beyondshop.cloud/api/products/b5650e99-9e2a-4c2a-b761-314bc10b9ee7/images/6f5164df-8de7-4505-9d26-614ba871b351"
    }
  }
}

Delete product image

A DELETE request is used to delete a product image.

Required scopes

prod:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/7dddbc0c-9589-422b-b471-b52f55e7f59d/images/744c5054-8878-49b2-b40e-59cca03cf782' -i -X DELETE -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Assign product image as default image

A PUT request is used to assign a product image as the default image. The request contains a single URI of the image to assign.

Required scopes

prod:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/products/7c69b8ce-1791-4676-bed6-c15882f4924f/default-image' -i -X PUT -H 'Content-Type: text/uri-list' -H 'Accept: application/json' -H 'Authorization: Bearer <Access token>' -d 'http://localhost/products/7c69b8ce-1791-4676-bed6-c15882f4924f/images/01c01cff-0577-4fd6-a6bc-0dac5503a272'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Shipping Zones

The shipping zones resource is used to get information about shipping zones of this shop.

Shipping zones hold shipping methods that are applicable inside this shipping zone.

Show shipping zone details

A GET request is used to retrieve the details of a shipping zone.

Required scopes

shpz:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/eb8f8d02-0719-45d6-b847-7a691f29bc42' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The immutable, unique identifier of the requested resource.

position

Number

The sorting position of the shipping zone in the merchant administration in relation to other shipping zones.

shippingMethods

Array

The shipping methods assigned to this shipping zone.

_links

Object

See Hypermedia

name

String

The name of the shipping zone.

serviceableCountries

Array

The list of countries this shipping zone applies to.

shippingMethods[]._id

String

The immutable, unique identifier of the requested resource.

shippingMethods[].weightBasedPrice

Null

The price depending on the package weight.

shippingMethods[].fixedPrice

Object

The fixed price for the shipping method irrespective of weight, dimensions, etc.

shippingMethods[].position

Number

The sorting position of the shipping method in the merchant administration in relation to other shipping methods.

shippingMethods[].name

String

The name of the shipping method.

shippingMethods[].description

String

description

shippingMethods[].taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

shippingMethods[].freeShippingValue

Object

Once a customer reaches this amount (excluding payment fee) this shipping method is free of charge.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1048

{
  "name" : "BE-NL-LU",
  "serviceableCountries" : [ "LU", "BE", "NL" ],
  "position" : 2,
  "shippingMethods" : [ {
    "name" : "Standard Shipping 2",
    "description" : "Standard Shipping",
    "taxClass" : "REGULAR",
    "position" : 0,
    "freeShippingValue" : {
      "currency" : "EUR",
      "amount" : 400
    },
    "fixedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 19.99
    },
    "weightBasedPrice" : null,
    "_id" : "432f238e-f415-4179-b315-2263bd6e712b",
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/eb8f8d02-0719-45d6-b847-7a691f29bc42/shipping-methods/432f238e-f415-4179-b315-2263bd6e712b"
      }
    }
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/eb8f8d02-0719-45d6-b847-7a691f29bc42"
    },
    "shipping-methods" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/eb8f8d02-0719-45d6-b847-7a691f29bc42/shipping-methods"
    }
  },
  "_id" : "eb8f8d02-0719-45d6-b847-7a691f29bc42"
}

Create shipping zone

A POST request is used to create a shipping zone.

Required scopes

shpz:c

Request body properties

Path Type Description

name

String

The name of the shipping zone.

serviceableCountries

Array

The list of countries this shipping zone applies to.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "name" : "BE-NL-LU",
  "serviceableCountries" : [ "BE", "NL", "LU" ]
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/shipping-zones/aab16900-bcac-4368-b772-403e52e55007
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 449

{
  "name" : "BE-NL-LU",
  "serviceableCountries" : [ "LU", "BE", "NL" ],
  "position" : 2,
  "shippingMethods" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/aab16900-bcac-4368-b772-403e52e55007"
    },
    "shipping-methods" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/aab16900-bcac-4368-b772-403e52e55007/shipping-methods"
    }
  },
  "_id" : "aab16900-bcac-4368-b772-403e52e55007"
}

Update shipping zone

A PUT request is used to update a shipping zone.

Required scopes

shpz:u

Request body properties

Path Type Description

name

String

The name of the shipping zone.

serviceableCountries

Array

The list of countries this shipping zone applies to.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/5d5fce07-6802-4a84-b1d8-2a7040cd1f60' -i -X PUT -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "name" : "BENELUX region",
  "serviceableCountries" : [ "BE", "NL", "LU", "DE" ]
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1060

{
  "name" : "BENELUX region",
  "serviceableCountries" : [ "LU", "DE", "BE", "NL" ],
  "position" : 2,
  "shippingMethods" : [ {
    "name" : "Standard Shipping 2",
    "description" : "Standard Shipping",
    "taxClass" : "REGULAR",
    "position" : 0,
    "freeShippingValue" : {
      "currency" : "EUR",
      "amount" : 400
    },
    "fixedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 19.99
    },
    "weightBasedPrice" : null,
    "_id" : "f7a4c59c-c1be-4b42-b851-7eeb239c1996",
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/5d5fce07-6802-4a84-b1d8-2a7040cd1f60/shipping-methods/f7a4c59c-c1be-4b42-b851-7eeb239c1996"
      }
    }
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/5d5fce07-6802-4a84-b1d8-2a7040cd1f60"
    },
    "shipping-methods" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/5d5fce07-6802-4a84-b1d8-2a7040cd1f60/shipping-methods"
    }
  },
  "_id" : "5d5fce07-6802-4a84-b1d8-2a7040cd1f60"
}

Delete shipping zone

A DELETE request is used to delete a shipping zone. You cannot delete the shipping zone containing the last shipping method of a shop.

Required scopes

shpz:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/cde8eeed-340f-45b5-94b7-89ab9c6b7e3f' -i -X DELETE -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

List shipping zones

A GET request will list all of the shipping zones in a paged manner.

Required scopes

shpz:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2548

{
  "_embedded" : {
    "shipping-zones" : [ {
      "name" : "DE",
      "serviceableCountries" : [ "DE" ],
      "position" : 1,
      "shippingMethods" : [ {
        "name" : "Standard Shipping 1",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : null,
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 16.95
        },
        "weightBasedPrice" : null,
        "_id" : "81535b28-1810-4954-8da9-7c7b1481f550",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/a60b5b76-f5a0-49b4-9e31-b1003f9bc3bf/shipping-methods/81535b28-1810-4954-8da9-7c7b1481f550"
          }
        }
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/a60b5b76-f5a0-49b4-9e31-b1003f9bc3bf"
        },
        "shipping-methods" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/a60b5b76-f5a0-49b4-9e31-b1003f9bc3bf/shipping-methods"
        }
      },
      "_id" : "a60b5b76-f5a0-49b4-9e31-b1003f9bc3bf"
    }, {
      "name" : "BE-NL-LU",
      "serviceableCountries" : [ "LU", "BE", "NL" ],
      "position" : 2,
      "shippingMethods" : [ {
        "name" : "Standard Shipping 2",
        "description" : "Standard Shipping",
        "taxClass" : "REGULAR",
        "position" : 0,
        "freeShippingValue" : {
          "currency" : "EUR",
          "amount" : 400
        },
        "fixedPrice" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 19.99
        },
        "weightBasedPrice" : null,
        "_id" : "28220918-94c0-4d65-8a10-392c76276062",
        "_links" : {
          "self" : {
            "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/39910caa-ed40-4247-b3b8-144175b74374/shipping-methods/28220918-94c0-4d65-8a10-392c76276062"
          }
        }
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/39910caa-ed40-4247-b3b8-144175b74374"
        },
        "shipping-methods" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/39910caa-ed40-4247-b3b8-144175b74374/shipping-methods"
        }
      },
      "_id" : "39910caa-ed40-4247-b3b8-144175b74374"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Sort shipping zones

Use a PUT request to sort the shipping zones. This is done by passing the self-links of the shipping zones in the desired order.

The request must contain uris for all shipping zones of the given page.

Required scopes

shpz:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones' -i -X PUT -H 'Content-Type: text/uri-list' -H 'Authorization: Bearer <Access token>' -d 'https://api-shop.beyondshop.cloud/api/shipping-zones/18eb906f-3b81-4f1f-92ff-fe3b69599168
https://api-shop.beyondshop.cloud/api/shipping-zones/e283cd80-a50d-4729-b51e-9c953b3a876b
https://api-shop.beyondshop.cloud/api/shipping-zones/99f134ee-8f0d-40a7-bbb8-a3bd53cb7a27'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/shipping-zones

Show details of shipping method in shipping zone

A GET request is used to retrieve the details of a shipping method.

Required scopes

shpz:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/9cc75e71-1ae5-4110-bdb4-81dc35702f6c/shipping-methods/9856b4dd-679d-4544-bb63-2f77bb2f2e26' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d 'https://api-shop.beyondshop.cloud/api/shipping-zones/9cc75e71-1ae5-4110-bdb4-81dc35702f6c/shipping-methods/9856b4dd-679d-4544-bb63-2f77bb2f2e26'

Response body properties

Path Type Description

_links

Object

See Hypermedia

_id

String

The immutable, unique identifier of the requested resource.

weightBasedPrice

Null

The price depending on the package weight.

fixedPrice

Object

The fixed price for the shipping method irrespective of weight, dimensions, etc.

position

Number

The sorting position of the shipping method in the merchant administration in relation to other shipping methods.

name

String

The name of the shipping method.

description

String

description

taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

freeShippingValue

Object

Once a customer reaches this amount (excluding payment fee) this shipping method is free of charge.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 556

{
  "name" : "Standard Shipping 2",
  "description" : "Standard Shipping",
  "taxClass" : "REGULAR",
  "position" : 0,
  "freeShippingValue" : {
    "currency" : "EUR",
    "amount" : 400
  },
  "fixedPrice" : {
    "taxModel" : "GROSS",
    "currency" : "EUR",
    "amount" : 19.99
  },
  "weightBasedPrice" : null,
  "_id" : "9856b4dd-679d-4544-bb63-2f77bb2f2e26",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/9cc75e71-1ae5-4110-bdb4-81dc35702f6c/shipping-methods/9856b4dd-679d-4544-bb63-2f77bb2f2e26"
    }
  }
}

Required scopes

shpz:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/2e5fd1a5-c60d-49c4-95c1-98edc23a7ca1/shipping-methods/c4e760a3-a597-4d0e-ab65-c2b2f74f0cf0' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d 'https://api-shop.beyondshop.cloud/api/shipping-zones/2e5fd1a5-c60d-49c4-95c1-98edc23a7ca1/shipping-methods/c4e760a3-a597-4d0e-ab65-c2b2f74f0cf0'

Response body properties

Path Type Description

_links

Object

See Hypermedia

_id

String

The immutable, unique identifier of the requested resource.

weightBasedPrice

Null

The price depending on the package weight.

fixedPrice

Object

The fixed price for the shipping method irrespective of weight, dimensions, etc.

position

Number

The sorting position of the shipping method in the merchant administration in relation to other shipping methods.

name

String

The name of the shipping method.

description

String

description

taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

freeShippingValue

Null

Once a customer reaches this amount (excluding payment fee) this shipping method is free of charge.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 512

{
  "name" : "Standard Shipping 1",
  "description" : "Standard Shipping",
  "taxClass" : "REGULAR",
  "position" : 0,
  "freeShippingValue" : null,
  "fixedPrice" : {
    "taxModel" : "GROSS",
    "currency" : "EUR",
    "amount" : 16.95
  },
  "weightBasedPrice" : null,
  "_id" : "c4e760a3-a597-4d0e-ab65-c2b2f74f0cf0",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/2e5fd1a5-c60d-49c4-95c1-98edc23a7ca1/shipping-methods/c4e760a3-a597-4d0e-ab65-c2b2f74f0cf0"
    }
  }
}

Create shipping method in shipping zone

A POST request is used to create a shipping method in a shipping zone.

Required scopes

shpz:u

Request body properties

Path Type Description

name

String

The name of the shipping method.

description

String

description

taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

freeShippingValue

Object

Once a customer reaches this amount (excluding payment fee) this shipping method is free of charge.

fixedPrice

Object

The fixed price for the shipping method irrespective of weight, dimensions, etc.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/ccba98de-ff4f-4bc9-a618-60bcff65a078/shipping-methods' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "name" : "Standard Shipping 2",
  "description" : "Standard Shipping",
  "taxClass" : "REGULAR",
  "freeShippingValue" : {
    "taxModel" : "GROSS",
    "currency" : "EUR",
    "amount" : 400
  },
  "fixedPrice" : {
    "taxModel" : "GROSS",
    "currency" : "EUR",
    "amount" : "19.99"
  }
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/shipping-zones/ccba98de-ff4f-4bc9-a618-60bcff65a078/shipping-methods/96ed611b-a18f-488d-86ff-8e3f93370dc4
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1580

{
  "name" : "DE",
  "serviceableCountries" : [ "DE" ],
  "position" : 1,
  "shippingMethods" : [ {
    "name" : "Standard Shipping 1",
    "description" : "Standard Shipping",
    "taxClass" : "REGULAR",
    "position" : 0,
    "freeShippingValue" : null,
    "fixedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "weightBasedPrice" : null,
    "_id" : "cec3ab42-a57a-423d-a2d9-c5c100d26d17",
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/ccba98de-ff4f-4bc9-a618-60bcff65a078/shipping-methods/cec3ab42-a57a-423d-a2d9-c5c100d26d17"
      }
    }
  }, {
    "name" : "Standard Shipping 2",
    "description" : "Standard Shipping",
    "taxClass" : "REGULAR",
    "position" : 0,
    "freeShippingValue" : {
      "currency" : "EUR",
      "amount" : 400
    },
    "fixedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 19.99
    },
    "weightBasedPrice" : null,
    "_id" : "96ed611b-a18f-488d-86ff-8e3f93370dc4",
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/ccba98de-ff4f-4bc9-a618-60bcff65a078/shipping-methods/96ed611b-a18f-488d-86ff-8e3f93370dc4"
      }
    }
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/ccba98de-ff4f-4bc9-a618-60bcff65a078"
    },
    "shipping-methods" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/ccba98de-ff4f-4bc9-a618-60bcff65a078/shipping-methods"
    }
  },
  "_id" : "ccba98de-ff4f-4bc9-a618-60bcff65a078"
}

Request body properties

Path Type Description

name

String

The name of the shipping method.

description

String

description

taxClass

String

The tax class. Can be REGULAR, REDUCED, or EXEMPT.

freeShippingValue

Object

Once a customer reaches this amount (excluding payment fee) this shipping method is free of charge.

weightBasedPrice

Object

The price depending on the package weight.

weightBasedPrice.unlimitedWeightPrice

Object

The price for the package if its weight exceeds the highest weight threshold. If this value is not available, the shipping method is not applicable.

weightBasedPrice.weightPriceThresholds

Array

A list of package prices that are valid up to the respective maximum weight.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/1a6bbc9f-f6b6-418e-aa31-ffeea745b908/shipping-methods' -i -X POST -H 'Content-Type: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "name" : "Standard Shipping 2",
  "description" : "Standard Shipping",
  "taxClass" : "REGULAR",
  "freeShippingValue" : {
    "taxModel" : "GROSS",
    "currency" : "EUR",
    "amount" : 400
  },
  "weightBasedPrice" : {
    "weightPriceThresholds" : [ {
      "maxWeight" : 1000,
      "price" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 4
      }
    }, {
      "maxWeight" : 5000,
      "price" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 9
      }
    } ],
    "unlimitedWeightPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 34
    }
  }
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/shipping-zones/1a6bbc9f-f6b6-418e-aa31-ffeea745b908/shipping-methods/6b717502-e026-4281-a084-5d24e20968d8
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1968

{
  "name" : "DE",
  "serviceableCountries" : [ "DE" ],
  "position" : 1,
  "shippingMethods" : [ {
    "name" : "Standard Shipping 1",
    "description" : "Standard Shipping",
    "taxClass" : "REGULAR",
    "position" : 0,
    "freeShippingValue" : null,
    "fixedPrice" : {
      "taxModel" : "GROSS",
      "currency" : "EUR",
      "amount" : 16.95
    },
    "weightBasedPrice" : null,
    "_id" : "35e962e5-39dd-4312-b8e4-76827ae62487",
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/1a6bbc9f-f6b6-418e-aa31-ffeea745b908/shipping-methods/35e962e5-39dd-4312-b8e4-76827ae62487"
      }
    }
  }, {
    "name" : "Standard Shipping 2",
    "description" : "Standard Shipping",
    "taxClass" : "REGULAR",
    "position" : 0,
    "freeShippingValue" : {
      "currency" : "EUR",
      "amount" : 400
    },
    "fixedPrice" : null,
    "weightBasedPrice" : {
      "weightPriceThresholds" : [ {
        "maxWeight" : 1000,
        "price" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 4
        }
      }, {
        "maxWeight" : 5000,
        "price" : {
          "taxModel" : "GROSS",
          "currency" : "EUR",
          "amount" : 9
        }
      } ],
      "unlimitedWeightPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 34
      }
    },
    "_id" : "6b717502-e026-4281-a084-5d24e20968d8",
    "_links" : {
      "self" : {
        "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/1a6bbc9f-f6b6-418e-aa31-ffeea745b908/shipping-methods/6b717502-e026-4281-a084-5d24e20968d8"
      }
    }
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/1a6bbc9f-f6b6-418e-aa31-ffeea745b908"
    },
    "shipping-methods" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/1a6bbc9f-f6b6-418e-aa31-ffeea745b908/shipping-methods"
    }
  },
  "_id" : "1a6bbc9f-f6b6-418e-aa31-ffeea745b908"
}

Delete shipping method in shipping zone

A DELETE request is used to delete a shipping method in a shipping zone. You cannot delete the last shipping method of a shop.

Required scopes

shpz:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/c0a7f73a-f06d-47ff-84bd-9ad107e7431c/shipping-methods/65771d98-22b2-4e84-b91e-a452c82a4058' -i -X DELETE -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 449

{
  "name" : "BE-NL-LU",
  "serviceableCountries" : [ "LU", "BE", "NL" ],
  "position" : 2,
  "shippingMethods" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c0a7f73a-f06d-47ff-84bd-9ad107e7431c"
    },
    "shipping-methods" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c0a7f73a-f06d-47ff-84bd-9ad107e7431c/shipping-methods"
    }
  },
  "_id" : "c0a7f73a-f06d-47ff-84bd-9ad107e7431c"
}

List shipping methods of shipping zone

A GET request will list all of the shipping-methods of a shipping zonein a paged manner.

Required scopes

shpz:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/c0ca20f0-b13d-4f28-887b-2dc741cf6ef4/shipping-methods' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 847

{
  "_embedded" : {
    "shipping-methods" : [ {
      "name" : "Standard Shipping 2",
      "description" : "Standard Shipping",
      "taxClass" : "REGULAR",
      "position" : 0,
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 400
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 19.99
      },
      "weightBasedPrice" : null,
      "_id" : "277d0523-4fc9-48d0-8ef5-afe786bb6651",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c0ca20f0-b13d-4f28-887b-2dc741cf6ef4/shipping-methods/277d0523-4fc9-48d0-8ef5-afe786bb6651"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c0ca20f0-b13d-4f28-887b-2dc741cf6ef4/shipping-methods"
    }
  }
}

Sort shipping methods in shipping zone

Use a PUT request to sort the shipping methods inside a shipping zone. This is done by passing the self-links of the shipping methods in the desired order.

The request must contain uris for all shipping methods of this shipping zone.

Required scopes

shpz:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/c21b4bbd-7609-4c0c-8d42-df94f6b1309a/shipping-methods' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3405

{
  "_embedded" : {
    "shipping-methods" : [ {
      "name" : "Standard Shipping 2-0",
      "description" : "Standard Shipping",
      "taxClass" : "REGULAR",
      "position" : 0,
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 400
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 2
      },
      "weightBasedPrice" : null,
      "_id" : "f7432606-a2ed-4824-9c32-5efd531b064c",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c21b4bbd-7609-4c0c-8d42-df94f6b1309a/shipping-methods/f7432606-a2ed-4824-9c32-5efd531b064c"
        }
      }
    }, {
      "name" : "Standard Shipping 2-3",
      "description" : "Standard Shipping",
      "taxClass" : "REGULAR",
      "position" : 1,
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 400
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 2
      },
      "weightBasedPrice" : null,
      "_id" : "f4a7ae54-9cb0-4e68-b1da-b893ba6a44c4",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c21b4bbd-7609-4c0c-8d42-df94f6b1309a/shipping-methods/f4a7ae54-9cb0-4e68-b1da-b893ba6a44c4"
        }
      }
    }, {
      "name" : "Standard Shipping 2-2",
      "description" : "Standard Shipping",
      "taxClass" : "REGULAR",
      "position" : 2,
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 400
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 2
      },
      "weightBasedPrice" : null,
      "_id" : "196dfc84-5e3d-418f-a728-0c33faadf890",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c21b4bbd-7609-4c0c-8d42-df94f6b1309a/shipping-methods/196dfc84-5e3d-418f-a728-0c33faadf890"
        }
      }
    }, {
      "name" : "Standard Shipping 2-4",
      "description" : "Standard Shipping",
      "taxClass" : "REGULAR",
      "position" : 3,
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 400
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 2
      },
      "weightBasedPrice" : null,
      "_id" : "ed252066-7f0d-405f-be27-e56395bf254d",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c21b4bbd-7609-4c0c-8d42-df94f6b1309a/shipping-methods/ed252066-7f0d-405f-be27-e56395bf254d"
        }
      }
    }, {
      "name" : "Standard Shipping 2-1",
      "description" : "Standard Shipping",
      "taxClass" : "REGULAR",
      "position" : 4,
      "freeShippingValue" : {
        "currency" : "EUR",
        "amount" : 400
      },
      "fixedPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 2
      },
      "weightBasedPrice" : null,
      "_id" : "bac4ef4b-35bc-4e9c-a03e-4a9856b5b35f",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c21b4bbd-7609-4c0c-8d42-df94f6b1309a/shipping-methods/bac4ef4b-35bc-4e9c-a03e-4a9856b5b35f"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/c21b4bbd-7609-4c0c-8d42-df94f6b1309a/shipping-methods"
    }
  }
}

Find serviceable countries

Required scopes

shpz:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shipping-zones/search/find-all-serviceable-countries' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.countryCodes

Array

The list of country codes that products can be shipped to.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 428

{
  "_embedded" : {
    "countryCodes" : [ {
      "countryCode" : "BE"
    }, {
      "countryCode" : "LU"
    }, {
      "countryCode" : "NL"
    }, {
      "countryCode" : "DE"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shipping-zones/search/find-all-serviceable-countries"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Shop

List shop images

A GET request is used to retrieve the images of a shop.

Required scopes

shim:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop/images' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded

Object

List of images

_links

Object

See Hypermedia

page

Object

See Pagination

Links

Relation Description

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 941

{
  "_embedded" : {
    "images" : [ {
      "label" : "logo",
      "_id" : "7f809c9e-19da-4113-bdca-53e008a79731",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shop/images/7f809c9e-19da-4113-bdca-53e008a79731"
        },
        "image" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shop/images/7f809c9e-19da-4113-bdca-53e008a79731"
        },
        "data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/file.png?hash=212-2323-4343{&width,height,upscale}",
          "templated" : true
        },
        "metadata" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/file.png?hash=212-2323-4343&download=no"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shop/images?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Show shop image details

A GET request is used to retrieve a single image.

Required scopes

shim:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop/images/b32794fd-86cf-4c50-a8bb-98ea21768480' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The unique identifier of the image.

_links

Object

See Hypermedia

label

String

The label of the image that is used to state the purpose of the image. The labels 'logo' and 'fav-icon' can only be assigned once, and have a special meaning. The image with label 'logo' is used as the shop logo. The image with label 'fav-icon' is used as the fav icon of the shop.

Links

Relation Description

image

The absolute URI to the image.

data

The absolute URI to retrieve the binary image.

metadata

The absolute URI to retrieve the metadata of the image.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 615

{
  "label" : "logo",
  "_id" : "b32794fd-86cf-4c50-a8bb-98ea21768480",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shop/images/b32794fd-86cf-4c50-a8bb-98ea21768480"
    },
    "image" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shop/images/b32794fd-86cf-4c50-a8bb-98ea21768480"
    },
    "data" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/file.png?hash=212-2323-4343{&width,height,upscale}",
      "templated" : true
    },
    "metadata" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/file.png?hash=212-2323-4343&download=no"
    }
  }
}

Create shop image

A POST request is used to create an image.

Required scopes

shim:c

Request body properties

Path Type Description Constraints

dataUri

String

The encoded relative URI of the image.

Must be a valid storage service URI (must contain a hash query parameter). Must not be null

label

String

The label of the image that is used to state the purpose of the image. The labels 'logo' and 'fav-icon' can only be assigned once, and have a special meaning. The image with label 'logo' is used as the shop logo. The image with label 'fav-icon' is used as the fav icon of the shop.

Must not be empty

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop/images' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "dataUri" : "file.png?hash=212-2323-4343",
  "label" : "logo"
}'

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/shop/images/79a502c3-dc3d-4a81-a0cd-f9a5d6214356

Delete shop image

A DELETE request is used to delete an image.

Required scopes

shim:d

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop/images/2a40aa19-6713-4962-8d7f-4f00da5926b9' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Find shop images by label

A GET request is issued to search images by label.

Required scopes

shim:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop/images/search/find-by-label?label=logo' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

page

Object

See Pagination

_embedded

Object

List of images

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 962

{
  "_embedded" : {
    "images" : [ {
      "label" : "logo",
      "_id" : "dc874b91-c1bc-4c2b-a71c-4eaae1022898",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shop/images/dc874b91-c1bc-4c2b-a71c-4eaae1022898"
        },
        "image" : {
          "href" : "https://api-shop.beyondshop.cloud/api/shop/images/dc874b91-c1bc-4c2b-a71c-4eaae1022898"
        },
        "data" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/file.png?hash=212-2323-4343{&width,height,upscale}",
          "templated" : true
        },
        "metadata" : {
          "href" : "https://api-shop.beyondshop.cloud/api/api/core-storage/images/file.png?hash=212-2323-4343&download=no"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shop/images/search/find-by-label?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

A GET request is used to retrieve the legal content of a shop.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/legal-content' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

Response body properties

Path Type Description

_embedded

Object

List of Legal Content excluding the content itself.

_links

Object

See Hypermedia

page

Object

See Pagination

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 2301

{
  "_embedded" : {
    "legal-content" : [ {
      "mandatory" : true,
      "type" : "terms-and-conditions",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/terms-and-conditions"
        },
        "legal-content" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/terms-and-conditions{?projection}",
          "templated" : true
        }
      }
    }, {
      "mandatory" : true,
      "type" : "legal-notice",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/legal-notice"
        },
        "legal-content" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/legal-notice{?projection}",
          "templated" : true
        }
      }
    }, {
      "mandatory" : true,
      "type" : "privacy-policy",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/privacy-policy"
        },
        "legal-content" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/privacy-policy{?projection}",
          "templated" : true
        }
      }
    }, {
      "mandatory" : true,
      "type" : "right-of-withdrawal",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/right-of-withdrawal"
        },
        "legal-content" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/right-of-withdrawal{?projection}",
          "templated" : true
        }
      }
    }, {
      "mandatory" : true,
      "type" : "shipping-information",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/shipping-information"
        },
        "legal-content" : {
          "href" : "https://api-shop.beyondshop.cloud/api/legal-content/shipping-information{?projection}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/legal-content{?page,size,sort,projection}",
      "templated" : true
    },
    "profile" : {
      "href" : "https://api-shop.beyondshop.cloud/api/profile/legal-content"
    },
    "search" : {
      "href" : "https://api-shop.beyondshop.cloud/api/legal-content/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

A GET request is used to retrieve a single legal content.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/legal-content/right-of-withdrawal' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

Response body properties

Path Type Description

_id

String

The unique identifier of the legal content.

type

String

The type of the legal content (cannot be changed).

content

String

The content the legal content page is supposed to show.

mandatory

Boolean

Indicates if legal content is necessary for the shop country (cannot be changed). Can be true or false.

_links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:47:29 GMT
ETag: "2"
Content-Type: application/json;charset=UTF-8
Content-Length: 500

{
  "type" : "right-of-withdrawal",
  "content" : "",
  "mandatory" : true,
  "_id" : "60adc304-6dbc-4759-b672-e210bee1bf45",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/legal-content/right-of-withdrawal"
    },
    "legal-content" : {
      "href" : "https://api-shop.beyondshop.cloud/api/legal-content/right-of-withdrawal{?projection}",
      "templated" : true
    },
    "pdf" : {
      "href" : "https://api-shop.beyondshop.cloud/api/api/pdf-storage/attachments/some.pdf?hash=23213"
    }
  }
}

A PUT request is used to update legal content. The only editable part is the content. Changes on type and mandatory will be ignored.

Required scopes

lcnt:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/legal-content/legal-notice' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <Access token>' -d '{
  "type" : "legal-notice",
  "content" : "Here comes your legal notice!"
}'

Response body properties

Path Type Description

_id

String

The unique identifier of the legal content.

type

String

The type of the legal content (cannot be changed).

content

String

The content the legal content page is supposed to show.

mandatory

Boolean

Indicates if legal content is necessary for the shop country (cannot be changed). Can be true or false.

_links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "2"
Last-Modified: Thu, 07 Dec 2017 13:47:31 GMT
Location: https://api-shop.beyondshop.cloud/api/legal-content/legal-notice
Content-Type: application/json;charset=UTF-8
Content-Length: 397

{
  "type" : "legal-notice",
  "content" : "Here comes your legal notice!",
  "mandatory" : true,
  "_id" : "68ece012-4c25-4464-944d-b9a9f269292c",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/legal-content/legal-notice"
    },
    "legal-content" : {
      "href" : "https://api-shop.beyondshop.cloud/api/legal-content/legal-notice{?projection}",
      "templated" : true
    }
  }
}

The shop resources are used to manage shops.

Show shop details

A GET request is used to retrieve the details of a shop.

Required scopes

shop:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_id

String

The unique identifier of the shop.

name

String

The name of the shop.

address

Object

The address of the shop.

address.company

Null

The company name related to the shop.

address.firstName

String

The first name of the shop owner.

address.lastName

String

The last name of the shop owner.

address.street

String

The street of the shop address.

address.street2

Null

Additional street field for the shop address.

address.city

String

The city of the shop address.

address.postalCode

String

The postal code of the shop address.

address.country

String

The country of the shop address.

address.state

String

The state of the shop address.

address.phone

Null

The phone number of the shop owner.

address.fax

Null

The fax number of the shop owner.

address.email

String

The email address of the shop owner.

address.vatId

Null

The VAT identifier of the shop.

address.commercialRegister

Null

The commercial register number for business customers.

defaultCurrency

String

The default currency of the shop.

currencies

Array

List of currencies that are supported by this shop. Defaults to defaultCurrency. The defaultCurrency is always included in this list.

defaultLocale

String

The default locale of the shop. Defaults to the locale of the corresponding site if not set.

locales

Array

List of locales that are supported by this shop. Defaults to defaultLocale. The defaultLocale is always included in this list.

taxModel

String

The tax model used for all product prices in this shop.

vatExempted

Boolean

Indicates if the merchant is exempted to declare VAT. Can be true or false.

closedByMerchant

Boolean

Indicates if the shop is closed by its owner. Can be true or false.

closedShopMessage

String

A message that is shown when the shop is closed by its owner.

listPriceText

Null

The text of the list price.

minimumOrderValue

Object

The minimum value a cart needs to have to be allowed to be purchased.

_links

Object

See Hypermedia

Links

Relation Description

shop

The link to the shop.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 929

{
  "name" : "myShop",
  "address" : {
    "company" : null,
    "firstName" : "Luke",
    "lastName" : "Skywalker",
    "email" : "some@me.de",
    "phone" : null,
    "fax" : null,
    "street" : "Somestreet 10",
    "street2" : null,
    "postalCode" : "12345",
    "city" : "Hamburg",
    "country" : "DE",
    "state" : "Tatooine",
    "vatId" : null,
    "commercialRegister" : null
  },
  "closedByMerchant" : true,
  "closedShopMessage" : "shop is currently closed for redesign",
  "currencies" : [ "EUR" ],
  "defaultCurrency" : "EUR",
  "locales" : [ "de-DE" ],
  "defaultLocale" : "de-DE",
  "vatExempted" : false,
  "taxModel" : "GROSS",
  "listPriceText" : null,
  "minimumOrderValue" : {
    "currency" : "EUR",
    "amount" : 29.99
  },
  "_id" : "9966c471-f42c-415e-b1d1-ba6528344858",
  "_links" : {
    "shop" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shop{?projection}",
      "templated" : true
    }
  }
}

Show reduced view of shop details

A GET request is used to retrieve a reduced set of attributes of a shop.

Required scopes

shop:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop?projection=shopExcerptProjection' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

name

String

The name of the shop.

closedByMerchant

Boolean

Indicates if the shop is closed by its owner. Can be true or false.

defaultCurrency

String

The default currency of the shop.

defaultLocale

String

The default locale of the shop. Defaults to the locale of the corresponding site if not set.

vatExempted

Boolean

Indicates if the merchant is exempted to declare VAT. Can be true or false.

taxModel

String

The tax model used for all product prices in this shop.

_links

Object

See Hypermedia

Links

Relation Description

shop

The link to the shop.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 286

{
  "closedByMerchant" : true,
  "defaultCurrency" : "EUR",
  "defaultLocale" : "de-DE",
  "vatExempted" : false,
  "taxModel" : "GROSS",
  "name" : "myShop",
  "_links" : {
    "shop" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shop{?projection}",
      "templated" : true
    }
  }
}

Show shop features

A GET request is used to retrieve the features of a shop.

Required scopes

shop:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop/features' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

features

Object

List of enabled features that are assigned to the shop.

features['core.auth.private-apps'].enabled

Boolean

Indicates if the feature is enabled. Can be true or false.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 167

{
  "features" : {
    "core.auth.private-apps" : {
      "enabled" : true
    },
    "marketing.google-shopping.product-export" : {
      "enabled" : true
    }
  }
}

Update shop

A PUT request is used to change attributes of a shop.

Required scopes

shop:u

Request body properties

Path Type Description Constraints

name

String

The name of the shop.

Length must be between 0 and 255 inclusive. Must not be empty

address

Object

The address of the shop.

Must not be null

address.company

Null

The company name related to the shop.

address.firstName

String

The first name of the shop owner.

address.lastName

String

The last name of the shop owner.

address.street

String

The street of the shop address.

address.street2

Null

Additional street field for the shop address.

address.city

String

The city of the shop address.

address.postalCode

String

The postal code of the shop address.

address.country

String

The country of the shop address.

address.state

String

The state of the shop address.

address.phone

Null

The phone number of the shop owner.

address.fax

Null

The fax number of the shop owner.

address.email

String

The email address of the shop owner.

address.vatId

Null

The VAT identifier of the shop.

address.commercialRegister

Null

The commercial register number for business customers.

defaultCurrency

String

The default currency of the shop.

Must not be null

currencies

Array

List of currencies that are supported by this shop. Defaults to defaultCurrency. The defaultCurrency is always included in this list.

defaultLocale

String

The default locale of the shop. Defaults to the locale of the corresponding site if not set.

locales

Array

List of locales that are supported by this shop. Defaults to defaultLocale. The defaultLocale is always included in this list.

taxModel

String

The tax model used for all product prices in this shop.

Must not be null

vatExempted

Boolean

Indicates if the merchant is exempted to declare VAT. Can be true or false.

closedByMerchant

Boolean

Indicates if the shop is closed by its owner. Can be true or false.

closedShopMessage

String

A message that is shown when the shop is closed by its owner.

Length must be between 0 and 65536 inclusive. Must be allowed markdown

listPriceText

Null

The text of the list price.

Length must be between 0 and 45 inclusive

minimumOrderValue

Object

The minimum value a cart needs to have to be allowed to be purchased.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/shop' -i -X PUT -H 'Content-Type: application/hal+json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>' -d '{
  "name" : "anotherName",
  "address" : {
    "company" : null,
    "firstName" : "Luke",
    "lastName" : "Skywalker",
    "email" : "some@me.de",
    "phone" : null,
    "fax" : null,
    "street" : "another street 1",
    "street2" : null,
    "postalCode" : "12345",
    "city" : "Hamburg",
    "country" : "DE",
    "state" : "Tatooine",
    "vatId" : null,
    "commercialRegister" : null
  },
  "closedByMerchant" : true,
  "closedShopMessage" : "shop is currently closed for redesign",
  "currencies" : [ "USD", "EUR" ],
  "defaultCurrency" : "USD",
  "locales" : [ "de-DE" ],
  "defaultLocale" : "de-DE",
  "vatExempted" : false,
  "taxModel" : "GROSS",
  "listPriceText" : null,
  "minimumOrderValue" : {
    "currency" : "USD",
    "amount" : 29.99
  }
}'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: https://api-shop.beyondshop.cloud/api/shop
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 944

{
  "name" : "anotherName",
  "address" : {
    "company" : null,
    "firstName" : "Luke",
    "lastName" : "Skywalker",
    "email" : "some@me.de",
    "phone" : null,
    "fax" : null,
    "street" : "another street 1",
    "street2" : null,
    "postalCode" : "12345",
    "city" : "Hamburg",
    "country" : "DE",
    "state" : "Tatooine",
    "vatId" : null,
    "commercialRegister" : null
  },
  "closedByMerchant" : true,
  "closedShopMessage" : "shop is currently closed for redesign",
  "currencies" : [ "USD", "EUR" ],
  "defaultCurrency" : "USD",
  "locales" : [ "de-DE" ],
  "defaultLocale" : "de-DE",
  "vatExempted" : false,
  "taxModel" : "GROSS",
  "listPriceText" : null,
  "minimumOrderValue" : {
    "currency" : "USD",
    "amount" : 29.99
  },
  "_id" : "c885e00d-c27a-435c-be6b-6ac9579b2988",
  "_links" : {
    "shop" : {
      "href" : "https://api-shop.beyondshop.cloud/api/shop{?projection}",
      "templated" : true
    }
  }
}

Users

List users

A GET request will list all of users visible to the current user.

Required scopes

user:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.users

Array

The list of users.

page

Object

See Pagination

_links

Object

See Hypermedia

Links

Relation Description

search

The endpoint to list all search endpoints.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1125

{
  "_embedded" : {
    "users" : [ {
      "username" : "username",
      "email" : "baxter@example.org",
      "enabled" : true,
      "_id" : "f0819f1b-a122-4608-b212-8548d5d380e1",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/users/f0819f1b-a122-4608-b212-8548d5d380e1"
        },
        "user" : {
          "href" : "https://api-shop.beyondshop.cloud/api/users/f0819f1b-a122-4608-b212-8548d5d380e1"
        },
        "change-password" : {
          "href" : "https://api-shop.beyondshop.cloud/api/users/f0819f1b-a122-4608-b212-8548d5d380e1/change-password"
        },
        "roles" : {
          "href" : "https://api-shop.beyondshop.cloud/api/users/f0819f1b-a122-4608-b212-8548d5d380e1/roles"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "https://api-shop.beyondshop.cloud/api/profile/users"
    },
    "search" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Create user

A POST request is used to create a user.

Required scopes

user:c

Request body properties

Path Type Description Constraints

username

String

The username that identifies the user.

Must not be empty

email

String

The email address of the user account.

Must be a valid email address. Must not be null

password

String

The password of the user.

Must not be empty

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <Access token>' -d '{"username":"user","password":"password","email":"user@host.tld"}'

Response body properties

Path Type Description

username

String

The username that identifies the user.

email

String

The email address of the user account.

_id

String

The immutable, unique identifier of the requested resource.

enabled

Boolean

Indicates if the user is active. Can be true or false.

_links

Object

See Hypermedia

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
ETag: "1"
Last-Modified: Thu, 07 Dec 2017 13:17:59 GMT
Location: https://api-shop.beyondshop.cloud/api/users/45742bed-68df-4674-85e7-5f5fefdfe1f3
Content-Type: application/json;charset=UTF-8
Content-Length: 605

{
  "username" : "user",
  "email" : "user@host.tld",
  "enabled" : true,
  "_id" : "45742bed-68df-4674-85e7-5f5fefdfe1f3",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/45742bed-68df-4674-85e7-5f5fefdfe1f3"
    },
    "user" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/45742bed-68df-4674-85e7-5f5fefdfe1f3"
    },
    "change-password" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/45742bed-68df-4674-85e7-5f5fefdfe1f3/change-password"
    },
    "roles" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/45742bed-68df-4674-85e7-5f5fefdfe1f3/roles"
    }
  }
}

Show user details

A GET request is used to retrieve the details of a user.

Required scopes

user:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/edbd247a-449d-4464-80df-cd58f2d23096' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_links

Object

See Hypermedia

username

String

The username that identifies the user.

email

String

The email address of the user account.

_id

String

The immutable, unique identifier of the requested resource.

enabled

Boolean

Indicates if the user is active. Can be true or false.

_links

Object

See Hypermedia

Links

Relation Description

user

The templated self link.

change-password

The link to the "Change password" endpoint.

roles

The roles of the user.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:17:49 GMT
ETag: "1"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 614

{
  "username" : "username",
  "email" : "baxter@example.org",
  "enabled" : true,
  "_id" : "edbd247a-449d-4464-80df-cd58f2d23096",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/edbd247a-449d-4464-80df-cd58f2d23096"
    },
    "user" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/edbd247a-449d-4464-80df-cd58f2d23096"
    },
    "change-password" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/edbd247a-449d-4464-80df-cd58f2d23096/change-password"
    },
    "roles" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/edbd247a-449d-4464-80df-cd58f2d23096/roles"
    }
  }
}

List user roles

A GET request will list all roles of a user.

Required scopes

user:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/fea2e837-5791-4ab0-a62e-51a9ab6435de/roles' -i -H 'Authorization: Bearer <Access token>'

Response body properties

Path Type Description

_embedded.roles

Array

The roles of the user.

_links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 629

{
  "_embedded" : {
    "roles" : [ {
      "generated" : false,
      "name" : "merchant",
      "_links" : {
        "self" : {
          "href" : "https://api-shop.beyondshop.cloud/api/roles/a1f80a2e-9477-459a-a4e2-0277cafd2d5a"
        },
        "role" : {
          "href" : "https://api-shop.beyondshop.cloud/api/roles/a1f80a2e-9477-459a-a4e2-0277cafd2d5a"
        },
        "scopes" : {
          "href" : "https://api-shop.beyondshop.cloud/api/roles/a1f80a2e-9477-459a-a4e2-0277cafd2d5a/scopes"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/fea2e837-5791-4ab0-a62e-51a9ab6435de/roles"
    }
  }
}

Set user roles

A PUT request is used set the roles of a user.

Required scopes

user:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/44ebfafb-ce60-4af3-9352-f20e4c776b36/roles' -i -X PUT -H 'Content-Type: text/uri-list' -H 'Authorization: Bearer <Access token>' -d 'https://api-shop.beyondshop.cloud/api/roles/52298f3f-bfde-4bb8-a2e6-dd541127b385'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Add user roles

A POST request is used add the roles of a user.

Required scopes

user:r, user:u

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/e3df8ba8-d082-4297-a3ad-321a7b7d7525/roles' -i -X POST -H 'Content-Type: text/uri-list' -H 'Authorization: Bearer <Access token>' -d 'https://api-shop.beyondshop.cloud/api/roles/c244b6c3-7424-4ff1-9461-a4aa5efae832'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

Change password

A POST request is used to change the password of a user.

Request body properties

Path Type Description Constraints

currentPassword

String

The current password of the user. This is verified before the password change.

Must not be empty

newPassword

String

The new password to set in order to change the password.

Must not be empty

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/273fd979-d064-4349-be72-6f040643542c/change-password' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <Access token>' -d '{"currentPassword":"password","newPassword":"new-password"}'

Response body properties

Path Type Description

username

String

The username that identifies the user.

email

String

The email address of the user account.

_id

String

The immutable, unique identifier of the requested resource.

enabled

Boolean

Indicates if the user is active. Can be true or false.

_links

Object

See Hypermedia

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Content-Length: 610

{
  "username" : "user",
  "email" : "baxter@example.org",
  "enabled" : true,
  "_id" : "273fd979-d064-4349-be72-6f040643542c",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/273fd979-d064-4349-be72-6f040643542c"
    },
    "user" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/273fd979-d064-4349-be72-6f040643542c"
    },
    "change-password" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/273fd979-d064-4349-be72-6f040643542c/change-password"
    },
    "roles" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/273fd979-d064-4349-be72-6f040643542c/roles"
    }
  }
}

Trigger password reset

A POST request is used to trigger a password reset email to be sent to a user. The email will contain a link to the MBO’s password reset page. The link includes a JWT to authorize resetting it via the following endpoint.

Request body properties

Path Type Description

email

String

The email address of the user account.

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/reset-password-request?locale=en-US' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "email" : "baxter@example.org"
}'

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY

List user searches

The search endpoint provides an overview of the search endpoints the user resource offers.

Required scopes

user:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/search' -i -H 'Content-Type: application/json' -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Links

Relation Description

find-by-username

The search endpoint to find a user by username.

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 241

{
  "_links" : {
    "find-by-username" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/search/find-by-username{?username}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/search"
    }
  }
}

Find user by username

Required scopes

user:r

Example request

$ curl 'https://api-shop.beyondshop.cloud/api/users/search/find-by-username?username=username' -i -H 'Accept: application/hal+json' -H 'Authorization: Bearer <Access token>'

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Last-Modified: Thu, 07 Dec 2017 13:17:47 GMT
ETag: "1"
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 614

{
  "username" : "username",
  "email" : "baxter@example.org",
  "enabled" : true,
  "_id" : "a651d1b3-bb00-4ea8-86dd-5bee545646a4",
  "_links" : {
    "self" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/a651d1b3-bb00-4ea8-86dd-5bee545646a4"
    },
    "user" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/a651d1b3-bb00-4ea8-86dd-5bee545646a4"
    },
    "change-password" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/a651d1b3-bb00-4ea8-86dd-5bee545646a4/change-password"
    },
    "roles" : {
      "href" : "https://api-shop.beyondshop.cloud/api/users/a651d1b3-bb00-4ea8-86dd-5bee545646a4/roles"
    }
  }
}

About the API

The Beyond API is based on RESTful principles, allowing you to code in whatever language you prefer. It supports JSON format and UTF-8 character encoding and uses the standard HTTP request methods. The API authorization framework is OAuth 2.0.

HTTP verbs

The following HTTP verbs are used throughout the API:

Verb CRUD Description

GET

Read

Used to read/retrieve the information of a resource. A successful request returns the status code 200 (OK) with a JSON representation. In case of an error, usually a 404 (Not Found) or 400 (Bad Request) is returned.

POST

Create

Used to create a resource. A successful request returns a 201 (Created).

PATCH

Update/Modify

Used to apply changes to a resource. A successful update either returns a 200 (OK) with a JSON representation or a 204 (No Content) if not returning any content in the body.

PUT

Update/Replace

Used to update or replace resource information. A successful update returns a 200 (OK) with a JSON representation.

DELETE

Delete

Used to delete an existing resource. A successful request returns a 204 (No Content).

API operations

To build a REST call, combine this:

  • HTTP method

  • full URI to the resource

  • HTTP headers (if required)

  • JSON body (if required)

For example, this request creates a product:

$ curl 'https://yoursandbox.beyondshop.cloud/api/products/management/products'
-i -X POST
-H 'Content-Type: application/json'
-H 'Authorization: < Access Token >'
-d '{
  "name": "New product",
  "salesPrice" : {
    "taxModel" : "GROSS",
   	"currency" : "EUR",
    "amount" : 99.90
},
  "description": "This is a brand new product."
}'

Request headers

Public API requests are authenticated by the following request headers. Not all resources require Accept and Content-Type, but some do. To ensure that all your calls are processed successfully, we encourage you to always include these headers.

Header Type Description

Authorization

String

The OAuth 2.0 bearer token to secure the request for accessing the API. Example (shortened): Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRJZCI6MTQzOCwidXNlcl9uYW1lIjoidXNlciI

Accept

String

The media type acceptable for the response. Can be one of application/json or application/hal+json.

Content-Type

String

Specifies the Media Type of the request body. Can be one of application/json, application/hal+json, application/json-patch+json or text/uri-list.

Response headers

A successfully sent request is followed by an HTTP response. The below table contains the response headers that can be returned by our server.

Header Type Description

Server

String

The name of the server.

Date

String

The date and time the response was sent. In "HTTP-date" format as defined by RFC 7231. Example: Fri, 04 Aug 2017 06:54:30 GMT

Content-Type

String

The media type of this content, e.g. application/hal+json;charset=UTF-8, application/json;charset=UTF-8, or `text/plain.

Transfer-Encoding

String

The form of encoding used to safely transfer the entity to the user.

Connection

String

Controls whether or not the network connection stays open after the current transaction finishes. Can be keep alive or close.

Cache-Control

String

Specifies directives for caching mechanisms along the request-response chain.

Pragma

String

Specific implementation for the browser to inform the server and any caches that a fresh version of the resource is requested.

Expires

String

The date and time after which the response is considered expired.

Strict-Transport-Security

String

Security feature to inform the browser that communication should only be performed via HTTPS.

Pagination

When making calls to our Beyond API you will be returned lots of results. A lot more than you might want to handle with a single request. That’s why we paginate the results to ensure the responses are easier for you to manage.

Even though we’ve built in a default limit, we recommend to use the following query parameters to get more streamlined results.

Query parameters

Parameter Type Description

page

number

The page of results to be returned (indexed: 0, default: 0).

size

number

The maximum number of results per page (default: 20).

sort

string

The sort order of results by propertyname, optionally followed by ,ASC for ascending or ,DESC for descending sort order.

Example request

$ curl 'https://yoursandbox.beyondshop.cloud/api/products/management/products?page=1&sort=salesPrice,ASC&size=2'
-i -X GET
-H 'Content-Type: application/hal+json'
-H 'Accept: application/hal+json'
-H 'Authorization: < Access Token >'

Response parameters

Response pagination is represented with the following JSON fields inside the response body.

Path Type Description

page.size

number

The requested number of results per page.

page.totalElements

number

The total number of elements available.

page.totalPages

number

The total number of pages available.

page.number

number

The number of the current page. The first page is indexed with 0.

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8

{
  "_embedded" : {
    "products" : [ {
      "_id" : "a7e2c07a-390e-42c5-8c8d-ac53569eda7d",
      "sku" : "1006",
      "name" : "Black Wooden Table",
      "salesPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 52.76,
        "derivedPrice" : {
          "taxModel" : "NET",
          "currency" : "EUR",
          "amount" : 44.33613,
          "taxRate" : 0.19
        }
      },
      "listPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 79.85,
        "derivedPrice" : {
          "taxModel" : "NET",
          "currency" : "EUR",
          "amount" : 67.10084,
          "taxRate" : 0.19
        }
      },
      "_embedded" : {
        "availability" : {
          "availabilityState" : "IN_STOCK",
          "availableStock" : null,
          "stockThreshold" : null,
          "_links" : {
            "self" : {
              "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d/availability"
            }
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d"
        },
        "self-localized" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d?locale=en-US"
        },
        "product" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d{?locale}",
          "templated" : true
        },
        "attributes" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d/attributes{?locale}",
          "templated" : true
        },
        "attachments" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d/attachments"
        },
        "images" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d/images"
        },
        "default-image" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/a7e2c07a-390e-42c5-8c8d-ac53569eda7d/default-image"
        },
        "default-image-data" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/core-storage/images/black-wooden-table.jpg?hash=f639d991b0e8908f6389b0ffa23393aab2ca9079{&width,height,upscale}",
          "templated" : true
        },
        "default-image-metadata" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/core-storage/images/black-wooden-table.jpg?hash=f639d991b0e8908f6389b0ffa23393aab2ca9079&download=no"
        }
      }
    }, {
      "_id" : "d2f63d54-41c6-4fb4-a467-c8388a693525",
      "sku" : "1005",
      "name" : "Retro Pouffe",
      "salesPrice" : {
        "taxModel" : "GROSS",
        "currency" : "EUR",
        "amount" : 159,
        "derivedPrice" : {
          "taxModel" : "NET",
          "currency" : "EUR",
          "amount" : 133.61345,
          "taxRate" : 0.19
        }
      },
      "listPrice" : null,
      "_embedded" : {
        "availability" : {
          "availabilityState" : "IN_STOCK",
          "availableStock" : null,
          "stockThreshold" : null,
          "_links" : {
            "self" : {
              "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525/availability"
            }
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525"
        },
        "self-localized" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525?locale=en-US"
        },
        "product" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525{?locale}",
          "templated" : true
        },
        "attributes" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525/attributes{?locale}",
          "templated" : true
        },
        "attachments" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525/attachments"
        },
        "images" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525/images"
        },
        "default-image" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/d2f63d54-41c6-4fb4-a467-c8388a693525/default-image"
        },
        "default-image-data" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/core-storage/images/retro-pouffe.jpg?hash=89489738342f8b407a46fe8ab70cdd5decf84667{&width,height,upscale}",
          "templated" : true
        },
        "default-image-metadata" : {
          "href" : "https://yoursandbox.beyondshop.cloud/api/core-storage/images/retro-pouffe.jpg?hash=89489738342f8b407a46fe8ab70cdd5decf84667&download=no"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products?page=0&size=2&sort=salesPrice,asc"
    },
    "prev" : {
      "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products?page=0&size=2&sort=salesPrice,asc"
    },
    "self" : {
      "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products?page=1&size=2&sort=salesPrice,asc"
    },
    "next" : {
      "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products?page=2&size=2&sort=salesPrice,asc"
    },
    "last" : {
      "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products?page=2&size=2&sort=salesPrice,asc"
    },
    "profile" : {
      "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/profile/products"
    },
    "search" : {
      "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/search"
    }
  },
  "page" : {
    "size" : 2,
    "totalElements" : 6,
    "totalPages" : 3,
    "number" : 1
  }

Hypermedia

We’ve applied the HAL (Hypertext Application Language) format to our Beyond API to offer a consistent and simple way to create hyperlinks between API resources. The HAL structure ensures that each resource contains relational links, and provides a standard identifiable structure for embedding other resources.

Most responses to a Beyond API call include

  • links to URIs (the string we render in our response bodies)

  • _embedded properties (mostly used with calls that list a collection of resources).

These links include

  • a target (the URI), located at the href string

  • a rel (the name of the link)

  • optional query parameters.

Use these _links to receive further information related to a specific request and operate on the resource itself. That way there’s no need to compose URIs yourself, or speculate if further related resources exist, but you can easily navigate from one resource to another. Defaults for operations or payloads, however, are not provided with these links.

HAL example

{
"_links" : {
   "self" : {
     "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/2046e922-cc2c-44fc-9310-c763d5ca6f79"
   },
   "self-localized" : {
     "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/2046e922-cc2c-44fc-9310-c763d5ca6f79?locale=en-US"
   },
   "availability" : {
     "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/2046e922-cc2c-44fc-9310-c763d5ca6f79/availability"
   },
   "attributes" : {
     "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/2046e922-cc2c-44fc-9310-c763d5ca6f79/attributes{?locale}",
     "templated" : true
   },
   "attachments" : {
     "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/2046e922-cc2c-44fc-9310-c763d5ca6f79/attachments"
   },
   "images" : {
     "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/2046e922-cc2c-44fc-9310-c763d5ca6f79/images"
   },
   "default-image" : {
     "href" : "https://yoursandbox.beyondshop.cloud/api/products/management/products/2046e922-cc2c-44fc-9310-c763d5ca6f79/default-image"
    }
  }
}

In many responses, you will find these link relations:

  • self shows the current representation of the resource

  • self-localized, in addition to self, holds the relevant localized parameters (mostly used with product-related resources).

You will also come across templated attributes (as described in RFC-6570), as you can see in the above example. If templated is true, additional query parameters can be set. For example, you can set the {?locale}, request specific image dimensions with {&width,height,upscale}, or handle paging and sorting with {?page,size,sort}, just to name a few.

Use cases

You plan an integration with ePages? That’s great! Here are some use cases we can think of.

Social Commerce

Show case products on social media platforms such as Facebook or Pinterest. Or why not integrating products on a blogging platform, or on any given site with a widget?

Portal Engines

Add products to price comparison or shopping portals.

Shipping

Enable our merchants to print shipping labels and to control the status of an order.

Accounting

Allow our merchants to manage and process orders.

Legal Service

Provide up-to-date legal information (imprint, terms and conditions, etc.) automatically.

Basic POS/Marketplace

Automatically update the stock level of a product upon a POS/Marketplace sale.

Sales Analytics

Determine top selling products, top customers, top regions, or optimize cross-selling products by evaluating orders.

Image Service

Provide the ability to get images for a product, upload improved images, delete old images, or set the default product image as well as reorder the slideshow.

Advanced POS/Marketplace

Automatically update the stock level of a product upon a POS/Marketplace sale and allow to create and manage customers and orders.

CRM and Newsletters

Analyze and groups/targets customers by ordered products and/or newsletter preferences and generate personalized newsletters accordingly.

Enterprise Management Systems (EMS)

Integrate all core ecommerce functionality from our cockpit into an external application.

Basic Storefront Apps

Implement different types of social media buttons, a live chat to interact with customers or place badges into a shop’s storefront.

Authorization

Private apps

Private apps can interact with the Beyond API on behalf of a single beyondshop. Once you have signed up for a beyondshop you can create private apps for a specific shop, and only for that shop.

1. Generate credentials

Before you can authenticate with a private app to a beyondshop, you need to generate the required credentials from the cockpit of the shop you want to connect with your app.

To generate the required credentials:

  1. From your beyondshop cockpit, click Developer area.

  2. Click Create new private app.

  3. Enter your app name, and select the scopes that outline the permissions and access required by your app.

  4. Click Save.

You immediately receive your client credentials with a client id and a client secret. Store the client secret safely, as you will not be able to see it in the Developer area again, once you revisit that page.

2. Authenticate

To authenticate with the Beyond API, simply Create a JsonWebToken from Client Credentials. Send a POST request to the token endpoint with the grant_type parameter. Pass client_id and client_secret (that you’ve received when generating your credentials in the beyondshop) as Basic Auth header.

Our authorization server will respond with a JSON object amongst others containing the access_token with the value bearer that you can now use for API requests.

3. Perform authenticated requests

Now that your application has an access_token, it can make authenticated requests to the Beyond API.

Example:

GET https://api-shop.beyondshop.cloud/api/products HTTP/1.1
Host: yourshop.com
Accept: application/hal+json
Authorization: Bearer 4HZ9hriF6J3GOnd10JbFzdVehycOvAZf

Scopes

Scope Used for

catg:c

Create category

catg:r

List categories, Show category details

catg:u

Update all category properties, Update category partially (json patch), Update category partially (json)

catg:d

Delete category