Sharefox API (1.0.0-alpha.0)

Download OpenAPI specification:Download

Introduction

API documentation for ShareFox - the digital solution for your rental business...

addresses

Addresses related end-point.

/invoice-addresses/latest

Gets the latest address

query Parameters
expand
string
Default: "gender,age,user"
Example: expand=gender,age,user

Describes which properties should be expanded

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "name": "Company",
  • "address": "Brobekkveien 54",
  • "userId": 1066,
  • "user": {
    },
  • "postcode": "0598",
  • "city": "Oslo",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "isCompany": true,
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "age": "54",
  • "gender": "male"
}

/orders/{orderId}/addresses

Creates an address.

path Parameters
orderId
required
number
Example: 1018
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
address
required
string non-empty
firstName
required
string non-empty
lastName
required
string non-empty
Array of objects
object
prefLanguage
required
string non-empty
country
required
string
postcode
required
string non-empty
city
required
string non-empty
phone
required
string non-empty
email
required
string <email> non-empty
isCompany
required
boolean
companyName
string
companyOrgNo
string
extraInfo
string
age
string
gender
string

Responses

Request samples

Content type
application/json
{
  • "address": "Brobekkveien 54",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "cards": [ ],
  • "activeCard": {
    },
  • "prefLanguage": "no",
  • "country": "Norway",
  • "postcode": "0598",
  • "city": "Oslo",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "isCompany": true,
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "age": "54",
  • "gender": "male"
}

Response samples

Content type
application/json
{
  • "success": true
}

/admin/orders/{addressId}/addresses

Updates the address of an order.

path Parameters
addressId
required
number
Example: 17669
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
postcode
string non-empty
city
string non-empty
address
string non-empty
phone
string non-empty
email
string <email> non-empty
name
string non-empty
extraInfo
string
userId
number
addressTypeId
number
country
string
companyName
string
companyOrgNo
string
isCompany
boolean
orderId
number

Responses

Request samples

Content type
application/json
{
  • "postcode": "0598",
  • "city": "Oslo",
  • "address": "Brobekkveien 54",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "name": "Company",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "userId": 1066,
  • "addressTypeId": 5,
  • "country": "Norway",
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "isCompany": true,
  • "orderId": 1010
}

Response samples

Content type
application/json
{
  • "changes": [ ],
  • "customerInfo": {
    },
  • "note": "Note",
  • "deposit": 1000,
  • "bookings": [ ],
  • "activeDeposit": {
    },
  • "depositRefund": {
    },
  • "depositRelease": {
    },
  • "bookingsMovements": [ ],
  • "payments": [ ],
  • "orderTags": [ ],
  • "additionalItems": [ ],
  • "accountingPaymentMethod": "1",
  • "id": 1018,
  • "reference": "NO39",
  • "time": "2060-09-08 15:00:00",
  • "isChangeOrder": false,
  • "paymentMethod": "Internal",
  • "customer": "John Doe",
  • "user": {
    },
  • "price": 649,
  • "totalPrice": 649,
  • "totalPriceExclVat": 519.2,
  • "status": "booked",
  • "startTime": "2060-09-08 15:00:00",
  • "endTime": "2060-09-09 11:00:00",
  • "type": 1,
  • "paymentStatus": "Unpaid",
  • "vat": 129.8,
  • "subtotals": {
    },
  • "productAttributes": "[]"
}

/admin/addresses/{addressId}

Updates an address by id

path Parameters
addressId
required
number
Example: 17669
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
postcode
string non-empty
city
string non-empty
address
string non-empty
phone
string non-empty
email
string <email> non-empty
name
string non-empty
extraInfo
string
userId
number
addressTypeId
number
country
string
companyName
string
companyOrgNo
string
isCompany
boolean
orderId
number

Responses

Request samples

Content type
application/json
{
  • "postcode": "0598",
  • "city": "Oslo",
  • "address": "Brobekkveien 54",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "name": "Company",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "userId": 1066,
  • "addressTypeId": 5,
  • "country": "Norway",
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "isCompany": true,
  • "orderId": 1010
}

Response samples

Content type
application/json
{
  • "postcode": "0598",
  • "city": "Oslo",
  • "address": "Brobekkveien 54",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "name": "Company",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "userId": 1066,
  • "addressTypeId": 5,
  • "country": "Norway",
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "isCompany": true,
  • "orderId": 1010
}

admin

Admin related end-point.

/admin/products/{productId}/inventory

Returns a list of inventory items.

path Parameters
productId
required
number
Example: 1006
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/admin/inventory/barcode/{barcode}

Returns an inventory item by barcode.

path Parameters
barcode
required
string non-empty
Example: TESTBARCODE
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "addedDate": "2020-02-08 07:28:23",
  • "balance": 1,
  • "barcodeAssignedDate": "2022-09-21 18:02:06",
  • "barcodeIdentifier": "TESTBARCODE",
  • "inventoryItemId": 25,
  • "isBulk": false,
  • "locationId": 4,
  • "locationName": "Avdeling 1",
  • "note": "Note",
  • "cost": 400,
  • "service": {
    },
  • "serviceStatus": "-",
  • "ssgProviderId": 0,
  • "ssgSerial1": "-",
  • "ssgSerial2": "-",
  • "supplierListPrice": 500,
  • "supplierName": "NAME",
  • "customInventoryId": "csdjncvn37934",
  • "supplierProdName": "NAME",
  • "productGroupId": 1008,
  • "productStatusId": 1,
  • "type": "Actual",
  • "units": 1
}

/admin/inventory/{inventoryItemId}

Updates an inventory item.

path Parameters
inventoryItemId
required
number
Example: 25
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
active
boolean
addedDate
string
balance
number
barcodeAssignedDate
string
barcodeIdentifier
string
isBulk
boolean
locationId
number
note
string
cost
number
object
ssgProviderId
number
ssgSerial1
string
ssgSerial2
string
supplierListPrice
number
supplierName
string
customInventoryId
string
supplierProdName
string
productGroupId
number
type
string
Enum: "Actual" "Virtual"
units
number

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "addedDate": "2020-02-08 07:28:23",
  • "balance": 1,
  • "barcodeAssignedDate": "2022-09-21 18:02:06",
  • "barcodeIdentifier": "TESTBARCODE",
  • "isBulk": false,
  • "locationId": 4,
  • "note": "Note",
  • "cost": 400,
  • "service": {
    },
  • "ssgProviderId": 0,
  • "ssgSerial1": "-",
  • "ssgSerial2": "-",
  • "supplierListPrice": 500,
  • "supplierName": "NAME",
  • "customInventoryId": "csdjncvn37934",
  • "supplierProdName": "NAME",
  • "productGroupId": 1008,
  • "type": "Actual",
  • "units": 1
}

Response samples

Content type
application/json
{
  • "active": true,
  • "addedDate": "2020-02-08 07:28:23",
  • "balance": 1,
  • "barcodeAssignedDate": "2022-09-21 18:02:06",
  • "barcodeIdentifier": "TESTBARCODE",
  • "inventoryItemId": 25,
  • "isBulk": false,
  • "locationId": 4,
  • "locationName": "Avdeling 1",
  • "note": "Note",
  • "cost": 400,
  • "service": {
    },
  • "serviceStatus": "-",
  • "ssgProviderId": 0,
  • "ssgSerial1": "-",
  • "ssgSerial2": "-",
  • "supplierListPrice": 500,
  • "supplierName": "NAME",
  • "customInventoryId": "csdjncvn37934",
  • "supplierProdName": "NAME",
  • "productGroupId": 1008,
  • "productStatusId": 1,
  • "type": "Actual",
  • "units": 1
}

/admin/login

Logs in an admin user

header Parameters
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
email
required
string <email>
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "example_user@example.com",
  • "password": "examplePass123"
}

Response samples

Content type
application/json
{
  • "message": "Logged in successfully!",
  • "token": "XXX.YYY.ZZZ",
  • "success": true,
  • "authorization": "Bearer XXX",
  • "roles": [ ],
  • "isToolerAdmin": false,
  • "userInfo": {
    }
}

/admin/login/shop-template

Logs in an admin user with permissions to access the shop template editor.

header Parameters
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
email
required
string <email>
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "example_user@example.com",
  • "password": "examplePass123"
}

Response samples

Content type
application/json
{
  • "message": "Logged in successfully!",
  • "token": "1"
}

/admin/token

Generates new admin jwt token.

header Parameters
cookie
required
string
Example: refreshToken=XXX; Domain=localhost; Path=/; HttpOnly; Secure; SameSite=Strict
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
expiredToken
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "expiredToken": "SCsCXqTjZDxGtQTxK3uxg7FmjuSwJNJ8"
}

Response samples

Content type
application/json
{
  • "token": "1",
  • "message": "1"
}

/admin/logout

User logout

header Parameters
cookie
string
Example: refreshToken=XXX; Domain=localhost; Path=/; HttpOnly; Secure; SameSite=Strict
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

authorization
required
string
Example: Bearer XXX

Add Bearer before token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message"
}

/admin/orders/{orderId}

Returns a single order by id

path Parameters
orderId
required
number
Example: 1018
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "changes": [ ],
  • "customerInfo": {
    },
  • "note": "Note",
  • "deposit": 1000,
  • "bookings": [ ],
  • "activeDeposit": {
    },
  • "depositRefund": {
    },
  • "depositRelease": {
    },
  • "bookingsMovements": [ ],
  • "payments": [ ],
  • "orderTags": [ ],
  • "additionalItems": [ ],
  • "accountingPaymentMethod": "1",
  • "id": 1018,
  • "reference": "NO39",
  • "time": "2060-09-08 15:00:00",
  • "isChangeOrder": false,
  • "paymentMethod": "Internal",
  • "customer": "John Doe",
  • "user": {
    },
  • "price": 649,
  • "totalPrice": 649,
  • "totalPriceExclVat": 519.2,
  • "status": "booked",
  • "startTime": "2060-09-08 15:00:00",
  • "endTime": "2060-09-09 11:00:00",
  • "type": 1,
  • "paymentStatus": "Unpaid",
  • "vat": 129.8,
  • "subtotals": {
    },
  • "productAttributes": "[]"
}

/admin/orders/{orderId}

Update order

path Parameters
orderId
required
number
Example: 1018
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
note
string
paymentMethodId
number
orderTypeId
number

Responses

Request samples

Content type
application/json
{
  • "note": "1",
  • "paymentMethodId": 5,
  • "orderTypeId": 5
}

Response samples

Content type
application/json
{
  • "changes": [ ],
  • "customerInfo": {
    },
  • "note": "Note",
  • "deposit": 1000,
  • "bookings": [ ],
  • "activeDeposit": {
    },
  • "depositRefund": {
    },
  • "depositRelease": {
    },
  • "bookingsMovements": [ ],
  • "payments": [ ],
  • "orderTags": [ ],
  • "additionalItems": [ ],
  • "accountingPaymentMethod": "1",
  • "id": 1018,
  • "reference": "NO39",
  • "time": "2060-09-08 15:00:00",
  • "isChangeOrder": false,
  • "paymentMethod": "Internal",
  • "customer": "John Doe",
  • "user": {
    },
  • "price": 649,
  • "totalPrice": 649,
  • "totalPriceExclVat": 519.2,
  • "status": "booked",
  • "startTime": "2060-09-08 15:00:00",
  • "endTime": "2060-09-09 11:00:00",
  • "type": 1,
  • "paymentStatus": "Unpaid",
  • "vat": 129.8,
  • "subtotals": {
    },
  • "productAttributes": "[]"
}

/admin/orders/reference/{reference}

Returns a single order by reference

path Parameters
reference
required
string non-empty
Example: NO39
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "changes": [ ],
  • "customerInfo": {
    },
  • "note": "Note",
  • "deposit": 1000,
  • "bookings": [ ],
  • "activeDeposit": {
    },
  • "depositRefund": {
    },
  • "depositRelease": {
    },
  • "bookingsMovements": [ ],
  • "payments": [ ],
  • "orderTags": [ ],
  • "additionalItems": [ ],
  • "id": 1018,
  • "reference": "NO39",
  • "time": "2060-09-08 15:00:00",
  • "isChangeOrder": false,
  • "paymentMethod": "Internal",
  • "customer": "John Doe",
  • "user": {
    },
  • "price": 649,
  • "totalPrice": 649,
  • "totalPriceExclVat": 519.2,
  • "status": "booked",
  • "startTime": "2060-09-08 15:00:00",
  • "endTime": "2060-09-09 11:00:00",
  • "type": 1,
  • "paymentStatus": "Unpaid",
  • "vat": 129.8,
  • "subtotals": {
    },
  • "productAttributes": "[]"
}

/admin/orders/

Returns a order list by time range.

query Parameters
required
string or string
required
string or string
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "startTime": "1",
  • "endTime": "1",
  • "products": "1",
  • "userLongName": "1",
  • "ds": "1",
  • "id": 5,
  • "bookTime": "1",
  • "bookingReference": "1",
  • "vat": "1",
  • "note": "1",
  • "orderStatusId": 5,
  • "customerId": 5,
  • "invoiceAddressId": 5,
  • "search": "1",
  • "paymentMethodId": 5,
  • "isChangeOrder": false,
  • "subtotals": "1",
  • "orderTypeId": 5,
  • "isDeleted": false,
  • "productAttributes": "1",
  • "paymentStatus": "1",
  • "totalPriceExclVat": "1",
  • "email": "1",
  • "orderTagsFull": "1",
  • "orderTags": "1",
  • "orderTagIds": [ ],
  • "paymentMethodName": "1",
  • "userEmail": "1",
  • "customer": "1",
  • "price": "1",
  • "reference": "1",
  • "status": "1",
  • "distribution": "1",
  • "deliveryStatuses": [ ],
  • "alerts": "1"
}

/admin/orders/{orderId}/status

Updates the status of an order.

path Parameters
orderId
required
number
Example: 1018
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
orderStatusId
required
number
forceParameter
required
boolean

Responses

Request samples

Content type
application/json
{
  • "orderStatusId": 1,
  • "forceParameter": false
}

Response samples

Content type
application/json
{
  • "changeOrderStatusUpdate": [ ],
  • "id": 1018,
  • "reference": "NO39",
  • "time": "2060-09-08 15:00:00",
  • "isChangeOrder": false,
  • "paymentMethod": "Internal",
  • "customer": "John Doe",
  • "user": {
    },
  • "price": 649,
  • "totalPrice": 649,
  • "totalPriceExclVat": 519.2,
  • "status": "booked",
  • "startTime": "2060-09-08 15:00:00",
  • "endTime": "2060-09-09 11:00:00",
  • "type": 1,
  • "paymentStatus": "Unpaid",
  • "vat": 129.8,
  • "subtotals": {
    },
  • "productAttributes": "[]"
}

/admin/orders/{addressId}/addresses

Updates the address of an order.

path Parameters
addressId
required
number
Example: 17669
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
postcode
string non-empty
city
string non-empty
address
string non-empty
phone
string non-empty
email
string <email> non-empty
name
string non-empty
extraInfo
string
userId
number
addressTypeId
number
country
string
companyName
string
companyOrgNo
string
isCompany
boolean
orderId
number

Responses

Request samples

Content type
application/json
{
  • "postcode": "0598",
  • "city": "Oslo",
  • "address": "Brobekkveien 54",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "name": "Company",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "userId": 1066,
  • "addressTypeId": 5,
  • "country": "Norway",
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "isCompany": true,
  • "orderId": 1010
}

Response samples

Content type
application/json
{
  • "changes": [ ],
  • "customerInfo": {
    },
  • "note": "Note",
  • "deposit": 1000,
  • "bookings": [ ],
  • "activeDeposit": {
    },
  • "depositRefund": {
    },
  • "depositRelease": {
    },
  • "bookingsMovements": [ ],
  • "payments": [ ],
  • "orderTags": [ ],
  • "additionalItems": [ ],
  • "accountingPaymentMethod": "1",
  • "id": 1018,
  • "reference": "NO39",
  • "time": "2060-09-08 15:00:00",
  • "isChangeOrder": false,
  • "paymentMethod": "Internal",
  • "customer": "John Doe",
  • "user": {
    },
  • "price": 649,
  • "totalPrice": 649,
  • "totalPriceExclVat": 519.2,
  • "status": "booked",
  • "startTime": "2060-09-08 15:00:00",
  • "endTime": "2060-09-09 11:00:00",
  • "type": 1,
  • "paymentStatus": "Unpaid",
  • "vat": 129.8,
  • "subtotals": {
    },
  • "productAttributes": "[]"
}

/admin/orders/statuses

Returns a list of order statuses.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/admin/payments/

Creates a payment.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
amount
required
number
currency
required
string
orderId
required
number
userId
required
number

Responses

Request samples

Content type
application/json
{
  • "amount": 2096,
  • "currency": "NOK",
  • "orderId": 1018,
  • "userId": 1066
}

Response samples

Content type
application/json
{
  • "id": 188,
  • "initiationTime": "2060-09-08 15:00:00",
  • "outputStatus": "accepted",
  • "paymentProviderId": 0,
  • "paymentStatusId": 2,
  • "paymentTypeId": 11,
  • "transactionId": "023f000062dfb2f8ea4ded644c2c39cd",
  • "amount": 2096,
  • "currency": "NOK",
  • "orderId": 1018,
  • "userId": 1066
}

/admin/payments/mark-paid

Marks a payment as paid.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
orderId
required
number
userId
required
number
paymentProviderId
number

Responses

Request samples

Content type
application/json
{
  • "orderId": 1018,
  • "userId": 1066,
  • "paymentProviderId": 5
}

Response samples

Content type
application/json
{
  • "id": 188,
  • "initiationTime": "2060-09-08 15:00:00",
  • "outputStatus": "accepted",
  • "paymentProviderId": 0,
  • "paymentStatusId": 2,
  • "paymentTypeId": 11,
  • "transactionId": "023f000062dfb2f8ea4ded644c2c39cd",
  • "amount": 2096,
  • "currency": "NOK",
  • "orderId": 1018,
  • "userId": 1066
}

/admin/reports/{id}

Get report by id.

path Parameters
id
required
number
Example: 5
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/admin/reports/latest

Get latests report that is published daily at 7 am, via our admin reports feature.

query Parameters
type
required
string
Enum: "inventoryStatusReport" "orderLineReportMonthly" "customerSalesReport" "customerPaymentReport" "inventoryCapacityReport" "orderLineReportMonthlyWithExtraUserInformation" "inventoryList"
Example: type=1
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/admin/reports/

Get list of reports that are available.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/admin/report-types/

Get list of report types

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/admin/report-types/{id}

Get report type by id for period as json

path Parameters
id
required
number
Example: 5
query Parameters
start
required
string
Example: start=2060-09-08
end
required
string
Example: end=2060-09-09
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "paymentId": 5,
  • "paymentMethod": "1",
  • "receivedPayments": 5,
  • "paymentInitiationTime": "1",
  • "orderReference": "1",
  • "orderId": 5,
  • "userName": "1",
  • "totalPriceForOrder": 5,
  • "orderVat": 5,
  • "transactionId": "1",
  • "transactionStatus": "1"
}

/admin/addresses/{addressId}

Updates an address by id

path Parameters
addressId
required
number
Example: 17669
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
postcode
string non-empty
city
string non-empty
address
string non-empty
phone
string non-empty
email
string <email> non-empty
name
string non-empty
extraInfo
string
userId
number
addressTypeId
number
country
string
companyName
string
companyOrgNo
string
isCompany
boolean
orderId
number

Responses

Request samples

Content type
application/json
{
  • "postcode": "0598",
  • "city": "Oslo",
  • "address": "Brobekkveien 54",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "name": "Company",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "userId": 1066,
  • "addressTypeId": 5,
  • "country": "Norway",
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "isCompany": true,
  • "orderId": 1010
}

Response samples

Content type
application/json
{
  • "postcode": "0598",
  • "city": "Oslo",
  • "address": "Brobekkveien 54",
  • "phone": "+47 902 79 664",
  • "email": "example_user@example.com",
  • "name": "Company",
  • "extraInfo": "[\"extra\",\"info\"]",
  • "userId": 1066,
  • "addressTypeId": 5,
  • "country": "Norway",
  • "companyName": "Sharefox",
  • "companyOrgNo": "817 404 502",
  • "isCompany": true,
  • "orderId": 1010
}

/admin/shop-template/

View the storefront template

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "key": "Shop.Frontend.AppStructure",
  • "timestampUpdated": "2022-09-21T18:02:06+02:00",
  • "standardValue": "",
  • "visibleOnFrontend": true,
  • "use": "The structural JSON used in Shop 2.0. This should be edited by a skilled user and make sure it is always valid JSON",
  • "standardKeyExists": true,
  • "versions": [
    ]
}

/admin/shop-template/

Update the storefront template

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
value
required
object
custom
required
boolean
detail
required
string
published
required
boolean
use
required
string
visibleOnFrontend
required
boolean

Responses

Request samples

Content type
application/json
{
  • "value": { },
  • "custom": true,
  • "detail": "Shop.Frontend.AppStructure",
  • "published": false,
  • "use": "The structural JSON used in Shop 2.0. This should be edited by a skilled user and make sure it is always valid JSON",
  • "visibleOnFrontend": true
}

Response samples

Content type
application/json
{
  • "value": { },
  • "custom": true,
  • "detail": "Shop.Frontend.AppStructure",
  • "id": 2409,
  • "published": false,
  • "use": "The structural JSON used in Shop 2.0. This should be edited by a skilled user and make sure it is always valid JSON",
  • "userId": 1001,
  • "visibleOnFrontend": true
}

/admin/order-tags/

Get order tags

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "orderTags": [ ],
  • "active": true,
  • "createdAt": "2060-09-08 15:00:00",
  • "updatedAt": "2060-09-09 11:00:00",
  • "id": 1,
  • "name": "Tag 1"
}

/admin/order-tags/

Create order tag

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
active
required
boolean
name
required
string
orderTagTypeId
required
number

Responses

Request samples

Content type
application/json
{
  • "active": false,
  • "name": "1",
  • "orderTagTypeId": 1
}

Response samples

Content type
application/json
{
  • "orderTagTypeId": 1,
  • "totalOrders": 4,
  • "active": true,
  • "createdAt": "2060-09-08 15:00:00",
  • "updatedAt": "2060-09-09 11:00:00",
  • "id": 1,
  • "name": "Tag 1"
}

/admin/order-tags/{id}

Update order tag

path Parameters
id
required
number
Example: 1
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
active
required
boolean
name
required
string
orderTagTypeId
required
number

Responses

Request samples

Content type
application/json
{
  • "active": false,
  • "name": "1",
  • "orderTagTypeId": 1
}

Response samples

Content type
application/json
{
  • "orderTagTypeId": 1,
  • "totalOrders": 4,
  • "active": true,
  • "createdAt": "2060-09-08 15:00:00",
  • "updatedAt": "2060-09-09 11:00:00",
  • "id": 1,
  • "name": "Tag 1"
}

/admin/order-tags/{id}

Delete order tag

path Parameters
id
required
number
Example: 1
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message",
  • "error": true
}

/admin/order-tags/order/{orderId}

Assign order tag to order

path Parameters
orderId
required
number
Example: 1018
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
orderTagIds
required
Array of any

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message",
  • "error": true
}

/admin/order-tags/order/{orderId}

Remove order tag from order

path Parameters
orderId
required
number
Example: 1018
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
orderTagIds
required
Array of any

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message",
  • "error": true
}

/admin/order-tag-types/

Get order tag types

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2060-09-08 15:00:00",
  • "updatedAt": "2060-09-09 11:00:00",
  • "id": 1,
  • "name": "Tag 1"
}

/admin/order-tag-types/

Create order tag type

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
active
required
boolean
name
required
string

Responses

Request samples

Content type
application/json
{
  • "active": false,
  • "name": "1"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2060-09-08 15:00:00",
  • "updatedAt": "2060-09-09 11:00:00",
  • "id": 1,
  • "name": "Tag 1"
}

/admin/order-tag-types/{id}

Update order tag type

path Parameters
id
required
number
Example: 1
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
active
required
boolean
name
required
string

Responses

Request samples

Content type
application/json
{
  • "active": false,
  • "name": "1"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdAt": "2060-09-08 15:00:00",
  • "updatedAt": "2060-09-09 11:00:00",
  • "id": 1,
  • "name": "Tag 1"
}

/admin/bookings/{bookingId}/status

Changes status of booking.

path Parameters
bookingId
required
number
Example: 1024
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
statusId
required
number
required
string or string

Responses

Request samples

Content type
application/json
{
  • "statusId": 1,
  • "actionTime": "2060-09-08"
}

Response samples

Content type
application/json
{
  • "bookingId": 1024,
  • "statusId": 1,
  • "statusName": "returned",
  • "statusChangeTime": "22:54 <br> 22 August",
  • "movementId": 171,
  • "bookingHandoverId": 171,
  • "message": "Booking status successfully changed!"
}

/admin/additional-items/

Add additional item to the order

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
description
required
string
pricePerUnit
required
number
orderId
required
number
type
string
units
required
number
vatCode
required
string
vatRate
required
number

Responses

Request samples

Content type
application/json
{
  • "description": "1",
  • "pricePerUnit": 5,
  • "orderId": 5,
  • "type": "1",
  • "units": 5,
  • "vatCode": "1",
  • "vatRate": 5
}

Response samples

Content type
application/json
{
  • "id": 5,
  • "additionalItemTypeId": 5,
  • "description": "1",
  • "endDatetime": "1",
  • "startDatetime": "1",
  • "initiateTime": "1",
  • "orderId": 5,
  • "price": 5,
  • "pricePerUnit": 5,
  • "units": 5,
  • "vatCode": "1",
  • "vatRate": 5,
  • "vat": 5
}

/admin/additional-items/{id}

Update additional item of the order

path Parameters
id
required
number
Example: 1
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
description
required
string
pricePerUnit
required
number
orderId
required
number
type
string
units
required
number
vatCode
required
string
vatRate
required
number

Responses

Request samples

Content type
application/json
{
  • "description": "1",
  • "pricePerUnit": 5,
  • "orderId": 5,
  • "type": "1",
  • "units": 5,
  • "vatCode": "1",
  • "vatRate": 5
}

Response samples

Content type
application/json
{
  • "id": 5,
  • "additionalItemTypeId": 5,
  • "description": "1",
  • "endDatetime": "1",
  • "startDatetime": "1",
  • "initiateTime": "1",
  • "orderId": 5,
  • "price": 5,
  • "pricePerUnit": 5,
  • "units": 5,
  • "vatCode": "1",
  • "vatRate": 5,
  • "vat": 5
}

/admin/additional-items/{id}

Remove additional item from the order

path Parameters
id
required
number
Example: 1
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message",
  • "error": true
}

/admin/settings/

Set the site settings.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
value
required
string
custom
required
boolean
detail
required
string
published
required
boolean
use
required
string
visibleOnFrontend
required
boolean

Responses

Request samples

Content type
application/json
{
  • "value": { },
  • "custom": true,
  • "detail": "Shop.Frontend.AppStructure",
  • "published": false,
  • "use": "The structural JSON used in Shop 2.0. This should be edited by a skilled user and make sure it is always valid JSON",
  • "visibleOnFrontend": true
}

Response samples

Content type
application/json
{
  • "value": { },
  • "custom": true,
  • "detail": "Shop.Frontend.AppStructure",
  • "id": 2409,
  • "published": false,
  • "use": "The structural JSON used in Shop 2.0. This should be edited by a skilled user and make sure it is always valid JSON",
  • "userId": 1001,
  • "visibleOnFrontend": true
}

/admin/settings/publish

Publish the site settings.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Responses

assets

Assets related end-point.

/assets/files/{name}

Returns a single asset.

path Parameters
name
required
string non-empty
Example: template.json
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

auth

Auth related end-point.

/login

Logs in a user through email

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
email
required
string <email>
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "example_user@example.com",
  • "password": "examplePass123"
}

Response samples

Content type
application/json
{
  • "token": "SCsCXqTjZDxGtQTxK3uxg7FmjuSwJNJ8",
  • "refreshToken": "XXX"
}

/login/guest

Logs in a user as a guest

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "token": "SCsCXqTjZDxGtQTxK3uxg7FmjuSwJNJ8",
  • "refreshToken": "XXX"
}

/login/google

Logs in a user through Google

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
photo
string
source
required
string non-empty
sourceId
required
string non-empty
email
required
string <email>
firstName
required
string non-empty
lastName
required
string non-empty

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "token": "SCsCXqTjZDxGtQTxK3uxg7FmjuSwJNJ8",
  • "refreshToken": "XXX"
}

/login/token

Logs in a user by token

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
token
required
string non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "succes": true,
  • "access": {
    },
  • "refreshToken": "XXX",
  • "token": "XXX"
}

/login/bank-id

Logs in a user by bank id

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
bankIdNameIdentifier
required
string

Responses

Request samples

Content type
application/json
{
  • "bankIdNameIdentifier": "1"
}

Response samples

Content type
application/json
{
  • "token": "SCsCXqTjZDxGtQTxK3uxg7FmjuSwJNJ8",
  • "refreshToken": "XXX"
}

/login/sso

User sso login.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "logoutUrl": "-"
}

/login/sso/callback

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
code
required
string non-empty
state
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "402",
  • "state": "52"
}

Response samples

Content type
application/json
{
  • "url": "-"
}

/logout

User logout

header Parameters
cookie
string
Example: refreshToken=XXX; Domain=localhost; Path=/; HttpOnly; Secure; SameSite=Strict
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
authorization
required
string
Example: Bearer XXX

Add Bearer before token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message"
}

/token

Generates new jwt token.

header Parameters
cookie
required
string
Example: refreshToken=XXX; Domain=localhost; Path=/; HttpOnly; Secure; SameSite=Strict
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
expiredToken
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "expiredToken": "SCsCXqTjZDxGtQTxK3uxg7FmjuSwJNJ8"
}

Response samples

Content type
application/json
{
  • "token": "1",
  • "message": "1"
}

/password-recovery/login

Logs in a user through access token

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
token
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "token": "1",
  • "refreshToken": "1",
  • "success": false
}

/admin/login

Logs in an admin user

header Parameters
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
email
required
string <email>
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "example_user@example.com",
  • "password": "examplePass123"
}

Response samples

Content type
application/json
{
  • "message": "Logged in successfully!",
  • "token": "XXX.YYY.ZZZ",
  • "success": true,
  • "authorization": "Bearer XXX",
  • "roles": [ ],
  • "isToolerAdmin": false,
  • "userInfo": {
    }
}

/admin/login/shop-template

Logs in an admin user with permissions to access the shop template editor.

header Parameters
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
email
required
string <email>
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "example_user@example.com",
  • "password": "examplePass123"
}

Response samples

Content type
application/json
{
  • "message": "Logged in successfully!",
  • "token": "1"
}

/admin/token

Generates new admin jwt token.

header Parameters
cookie
required
string
Example: refreshToken=XXX; Domain=localhost; Path=/; HttpOnly; Secure; SameSite=Strict
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
expiredToken
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "expiredToken": "SCsCXqTjZDxGtQTxK3uxg7FmjuSwJNJ8"
}

Response samples

Content type
application/json
{
  • "token": "1",
  • "message": "1"
}

/admin/logout

User logout

header Parameters
cookie
string
Example: refreshToken=XXX; Domain=localhost; Path=/; HttpOnly; Secure; SameSite=Strict
x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

authorization
required
string
Example: Bearer XXX

Add Bearer before token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message"
}

availability

Product availability related end-points. Proxied to the Sharefox v1.0 API.

/product-unavailability/{productId}/handovertimes

Returns a list of availability.

path Parameters
productId
required
number
Example: 1006
query Parameters
channelId
number
Example: channelId=1
bookingItemId
number
Example: bookingItemId=6574
type
required
string
Enum: "pickup" "return"
Example: type=pickup
required
string or string
Example: startDate=2060-09-08
locationId
required
number
Example: locationId=4
string or string
Example: endDate=2060-09-09
endTimeId
number
Example: endTimeId=19
startTimeId
number
Example: startTimeId=17
itemRelationsId
number
Example: itemRelationsId=6574
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/product-unavailability/{productId}/days

Returns a list of availability.

path Parameters
productId
required
number
Example: 1006
query Parameters
channelId
number
Example: channelId=1
month
number [ 1 .. 12 ]
Example: month=10
year
number
Example: year=2023
type
string
Enum: "pickup" "return"
Example: type=pickup
string or string
Example: endDate=2060-09-09
string or string
Example: startDate=2060-09-08
endTimeId
number
Example: endTimeId=19
startTimeId
number
Example: startTimeId=17
locationId
required
number
Example: locationId=4
itemRelationsId
number
Example: itemRelationsId=6574
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/product-availability/{productId}

Returns a list of availability.

path Parameters
productId
required
number
Example: 1006
query Parameters
required
string or string
Example: endDate=2060-09-09
required
string or string
Example: startDate=2060-09-08
endTimeId
required
number
Example: endTimeId=19
startTimeId
required
number
Example: startTimeId=17
locationId
required
number
Example: locationId=4
itemRelationsId
number
Example: itemRelationsId=6574
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/product-availability-bulk/{productIds}

Returns a list of availability.

path Parameters
productIds
required
string
Example: 1006
query Parameters
required
string or string
Example: endDate=2060-09-09
required
string or string
Example: startDate=2060-09-08
endTimeId
required
number
Example: endTimeId=19
startTimeId
required
number
Example: startTimeId=17
locationId
required
number
Example: locationId=4
itemRelationsId
number
Example: itemRelationsId=6574
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

blog-groups

Blog groups related end-points. Proxied to the Sharefox v1.0 API.

/blog-groups/

Returns a list of blog-groups.

query Parameters
search
string
Example: search=acce

Phrase to search for blogs.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

blog-types

Blog types related end-point.

/blog-types/

Returns a list of blog-types.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

blogs

Blogs related end-points. Proxied to the Sharefox v1.0 API.

/blogs/{slug}

Returns a single blog.

path Parameters
slug
required
string non-empty
Example: artikkel-1
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "name": "Artikkel 1",
  • "images": [ ],
  • "instructions": "<p style=\"color: inherit; font-family: inherit; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; text-decoration: none; box-sizing: border-box; margin: 0px 0px 10px; caret-color: #414b5d; font-size: 14px;\">Her har du plass til &aring; fortelle, beskrive eller informere ytterligere. Vi sier som alltid: <br />Unng&aring; veldig lange setninger, v&aelig;r tydelig og l&oslash;ft frem det viktigste. Pr&oslash;v &aring; holde deg s&aring;nn omtrent til tekstmengden du ser her n&aring;.&nbsp;Og du &ndash; husk &aring; slette v&aring;re kommentarer og den latinske tulleteksten.&nbsp;</p>\n<p style=\"color: inherit; font-family: inherit; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; text-decoration: none; box-sizing: border-box; margin: 0px 0px 10px; caret-color: #414b5d; font-size: 14px;\">Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Inmensae subtilitatis.Ut enim ad minim veniam, quis nostrud exercitation. Nec dubitamus multa iter quae et nos invenerat. Fabio vel iudice vincam, sunt in culpa qui officia. Idque Caesaris facere voluntate liceret: sese habere.</p>\n<p style=\"color: inherit; font-family: inherit; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; text-decoration: none; box-sizing: border-box; margin: 0px 0px 10px; caret-color: #414b5d; font-size: 14px;\">&nbsp;</p>",
  • "whatNeeded": "<p style=\"color: inherit; font-family: inherit; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; text-decoration: none; box-sizing: border-box; margin: 0px 0px 10px; caret-color: #414b5d; font-size: 14px;\">Her har du plass til &aring; beskrive eller informere mer detaljert.<br />Unng&aring; veldig lange setninger, v&aelig;r tydelig og l&oslash;ft frem det viktigste. Pr&oslash;v &aring; holde deg s&aring;nn omtrent til tekstmengden du ser her n&aring;.&nbsp;Og du &ndash; husk &aring; slette v&aring;re kommentarer og den latinske tulleteksten.&nbsp;</p>\n<p style=\"color: inherit; font-family: inherit; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; text-decoration: none; box-sizing: border-box; margin: 0px 0px 10px; caret-color: #414b5d; font-size: 14px;\">Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Inmensae subtilitatis.Ut enim ad minim veniam, quis nostrud exercitation. Nec dubitamus multa iter quae et nos invenerat. Fabio vel iudice vincam, sunt in culpa qui officia. Idque Caesaris facere voluntate liceret: sese habere.</p>",
  • "difficulty": "Medium",
  • "time": "Artikkel 1",
  • "summary": {
    },
  • "blogGroups": [ ],
  • "suggestedProducts": [ ],
  • "photosVideos": [ ],
  • "slug": "artikkel-1",
  • "metaTitle": "metaTitle",
  • "metaDescription": "metaDescription"
}

/blogs-popular

Returns a list of popular blog posts.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

booking

Bookings related end-point.

/bookings/{itemRelationsId}

Returns a single booking item.

path Parameters
itemRelationsId
required
number
Example: 6574
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "startDate": "2060-09-08",
  • "endDate": "2060-09-09",
  • "startTimeId": 17,
  • "endTimeId": 19,
  • "startDateTime": "2060-09-08 15:00:00",
  • "endDateTime": "2060-09-09 11:00:00",
  • "startTimestamp": 1661958000,
  • "endTimestamp": 1662634800,
  • "locationId": 4,
  • "bookingId": 1024,
  • "itemRelationsId": 6574,
  • "productQuestions": [ ],
  • "bookings": [ ],
  • "quantity": 1
}

booking-items

Booking items related end-point.

/booking-items/{bookingItemId}

Updates a booking item.

path Parameters
bookingItemId
required
number
Example: 6574
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
quantity
required
number

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true
}

/booking-items/{bookingItemId}

Removes a booking item.

path Parameters
bookingItemId
required
number
Example: 6574
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "success": true
}

bookings

Bookings related end-point.

/bookings/{bookingId}/status

Changes status of booking.

path Parameters
bookingId
required
number
Example: 1024
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
statusId
required
number
required
string or string

Responses

Request samples

Content type
application/json
{
  • "statusId": 1,
  • "actionTime": "2060-09-08"
}

Response samples

Content type
application/json
{
  • "bookingId": 1024,
  • "statusId": 1,
  • "statusName": "returned",
  • "statusChangeTime": "22:54 <br> 22 August",
  • "movementId": 171,
  • "bookingHandoverId": 171,
  • "message": "Booking status successfully changed!"
}

/bookings/

Updates a single booking.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
bookingId
required
number
itemRelationsId
required
number
productId
required
number
quantity
required
number
required
string or string
required
string or string
startTimeId
required
number
endTimeId
required
number
locationId
required
number
required
Array of objects
prefLanguage
required
string non-empty
productQuestionsInput
any

Responses

Request samples

Content type
application/json
{
  • "bookingId": 1024,
  • "itemRelationsId": 6574,
  • "productId": 1006,
  • "quantity": 1,
  • "startDate": "2060-09-08",
  • "endDate": "2060-09-09",
  • "startTimeId": 17,
  • "endTimeId": 19,
  • "locationId": 4,
  • "items": [ ],
  • "prefLanguage": "no",
  • "productQuestionsInput": null
}

Response samples

Content type
application/json
{
  • "orderId": 1018,
  • "success": true,
  • "totalPrice": 323
}

/bookings/

Add product to the cart.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
productId
required
number
quantity
required
number
required
string or string
required
string or string
startTimeId
required
number
endTimeId
required
number
locationId
required
number
required
Array of objects
prefLanguage
required
string non-empty
productQuestionsInput
any

Responses

Request samples

Content type
application/json
{
  • "productId": 1006,
  • "quantity": 1,
  • "startDate": "2060-09-08",
  • "endDate": "2060-09-09",
  • "startTimeId": 17,
  • "endTimeId": 19,
  • "locationId": 4,
  • "items": [ ],
  • "prefLanguage": "no",
  • "productQuestionsInput": null
}

Response samples

Content type
application/json
{
  • "orderId": 1018,
  • "totalPrice": 323,
  • "success": true,
  • "message": "Example message",
  • "error": true
}

/bookings/{itemRelationsId}

Deletes a single booking.

path Parameters
itemRelationsId
required
number
Example: 6574
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message",
  • "error": true
}

/booking-options/

query Parameters
productId
required
number
Example: productId=1005
type
required
string non-empty
Example: type=recommendedAccessory
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

/admin/bookings/{bookingId}/status

Changes status of booking.

path Parameters
bookingId
required
number
Example: 1024
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-admin-domain
required
string
Example: backend.admin.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

Request Body schema: application/json
statusId
required
number
required
string or string

Responses

Request samples

Content type
application/json
{
  • "statusId": 1,
  • "actionTime": "2060-09-08"
}

Response samples

Content type
application/json
{
  • "bookingId": 1024,
  • "statusId": 1,
  • "statusName": "returned",
  • "statusChangeTime": "22:54 <br> 22 August",
  • "movementId": 171,
  • "bookingHandoverId": 171,
  • "message": "Booking status successfully changed!"
}

bookings-active

Active orders related end-point.

/bookings-active/

Returns a list of active bookings.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

channel-availability

Channel-availability related end-point.

/channel-availability/

Returns a list of channel availabilities.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

company-information

Company information related end-points. Proxied to the Sharefox v1.0 API.

/company-information/terms-and-conditions

Returns a rental condition of shop.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

/company-information/privacy-policy

Returns a privacy policy of shop.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

consumables

Consumables related end-point.

/consumables/orders/{orderId}

Add consumables to the cart.

path Parameters
orderId
required
number
Example: 1018
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
quantity
required
number
totalPrice
required
number

Responses

Request samples

Content type
application/json
{
  • "quantity": 1,
  • "totalPrice": 150
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message",
  • "error": true
}

contact

Contact related end-point.

/contact-us/

Contact us my email.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Example message",
  • "error": true
}

coupons

Coupons related end-point.

/coupons/

Applies a coupon to a cart.

header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1
Request Body schema: application/json
code
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "code": "TEST_CODE"
}

Response samples

Content type
application/json
{
  • "coupon": {
    },
  • "success": true,
  • "message": "Example message",
  • "error": true
}

/coupons/{code}

Removes a coupon from a cart.

path Parameters
code
required
string non-empty
Example: TEST_CODE
header Parameters
authorization
required
string
Example: Bearer XXX

Add Bearer before token

x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

documents

Documents related end-points. Proxied straight to hosting.

/uploads/documents/{name}

Returns a single document.

path Parameters
name
required
string non-empty
Example: template.json
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

faq

FAQ related end-points. Proxied to the Sharefox v1.0 API.

/faq/

Returns a list of faq.

header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

files

Files related end-points. Proxied straight to hosting.

/uploads/files/{name}

Returns a single file.

path Parameters
name
required
string non-empty
Example: settings.json
header Parameters
x-sharefox-shop-domain
required
string
Example: backend.shop.mysharefox.com
locale
string
Example: no

Language of response messages. The fallback is no

origin
string
Example: 1

Responses

health

Health check related end-point.

/health

Returns a health message.

Responses

help

Help related end-point.

/help/articles

Returns all the articles from help.

Responses

Response samples

Content type
application/json