Sales | Services

List the sales services

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

namesstring[]Optional

Filter the services by one or more exact names.

externalIdsstring[]Optional

Filter the services by one or more external ids.

sortBystring · enumOptional

Sort the services by a given criterion

Possible values:

sortOrderstring · enumOptional

Order in which the result of a list request is sorted.

Possible values:

offsetinteger · int32Optional

Specifies the index of the first service to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of services to return

Default: 100

Responses

200

OK: A list of sales services.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

get/v1/sales/services

GET /v1/sales/services HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "supplier": {
        "id": 4,
        "name": "foo Inc.",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "shortDescription": "You can start with the Basic plan at any time and change it on a monthly basis.",
      "detailDescription": "text",
      "scopeOfService": "text",
      "marketplaceCategory": "Services",
      "marketplaceRank": 1,
      "status": "active",
      "availability": "available",
      "availabilityMessage": "Available in 2-4 weeks",
      "contexts": [
        {
          "name": "employee",
          "optional": false,
          "changeAllowed": false
        }
      ],
      "offers": [
        {
          "id": 99,
          "type": "rental",
          "purchasePrice": 99.99,
          "recurringPrice": 19.99,
          "currency": "EUR",
          "subscriptionPeriod": 12,
          "name": "Summer Deal",
          "externalId": "W5A345",
          "isDefault": true,
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "created": "2026-07-15T17:06:53.795Z",
      "id": 4,
      "name": "Basic Plan",
      "category": "text",
      "ean": "0194253408253",
      "externalId": "E54363",
      "supplierName": "text",
      "previewImageLink": "text",
      "type": "service",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a new sales service

post

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body

configurationTypestring · enumOptional

Defines the configuration complexity of a service. Can not be changed after service creation.

Possible values:

customerIdsinteger · int32[] · nullableOptional

Customer IDs for which the service is available. If null, the service is available to all customers.

previewImageLinkstring · nullableOptional

The link of the preview image for the service. Recommended size is 200x200px.

Example: https://my-cdn.domain.com/products/45/preview.png

namestring · max: 100Required

The name of the service. (Max. 100 characters)

Example: Basic Plan

shortDescriptionstring · max: 1500 · nullableOptional

A short description of the service without any formatting.

Example: You can start with the Basic plan at any time and change it on a monthly basis.

detailDescriptionstring · nullableOptional

scopeOfServicestring · nullableOptional

marketplaceCategorystring · max: 50Required

Technical name of the marketplace category in which the service is displayed. Marketplace category can be managed by each supplier.

Example: Services

marketplaceRankinteger · int32 · nullableOptional

Defines in which order the service is displayed in its marketplace category. The lower the value, the further forward the service is displayed.

statusstring · enumOptionalPossible values:

eanstring · max: 50 · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)

Example: 0194253408253

externalIdstring · max: 50 · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service.

Example: E54363

Responses

201

Created: The created sales service.

application/json

shortDescriptionstring · nullableOptional

A short description of the service without any formatting.

Example: You can start with the Basic plan at any time and change it on a monthly basis.

detailDescriptionstring · nullableOptional

scopeOfServicestring · nullableOptional

marketplaceCategorystring · nullableOptional

Technical name of the marketplace category in which the service is displayed. Marketplace category can be managed by each supplier.

Example: Services

marketplaceRankinteger · int32 · nullableOptional

Defines in which order the service is displayed in its marketplace category. The lower the value, the further forward the service is displayed.

statusstring · enumOptionalPossible values:

availabilitystring · enumOptional

Current availability status. Possible values: NULL, available, available_soon, not_available

Possible values:

availabilityMessagestring · nullableOptional

A message in the service details that is displayed to further define the availability of the product.

Example: Available in 2-4 weeks

createdstring · date-timeOptional

The date and time when the service was created. (ISO 8601 format)

idinteger · int32Required

The identifier of the service.

Example: 4

namestring · min: 1Required

The name of the service.

Example: Basic Plan

categorystring · nullableOptional

The category of the service. Comes from the marketplace ProductDisplayGroup

eanstring · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)

Example: 0194253408253

externalIdstring · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service.

Example: E54363

supplierNamestring · nullableOptional

The supplier for this service product

previewImageLinkstring · nullableOptional

Link to a small preview image for the product

typestring · enumOptional

Services can take on different types that define their meaning and process flows within the system.

Possible values:

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied.

application/json

post/v1/sales/services

POST /v1/sales/services HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1082

{
  "configurationType": "simple",
  "offer": {
    "currency": "EUR",
    "name": "Summer Deal",
    "type": "rental",
    "customerIds": [
      1
    ],
    "syncPriceFromBom": true,
    "purchasePrice": 99.99,
    "recurringPrice": 19.99,
    "subscriptionPeriod": 12,
    "subscriptionPeriodRenewal": 1,
    "differentInvoiceIssuer": "equipme Leasing Corp",
    "externalId": "142EEF3",
    "isDefault": true
  },
  "bomItems": [
    {
      "productId": 1,
      "quantity": 1,
      "subscriptionPeriodCondition": 1
    }
  ],
  "customerIds": [
    1
  ],
  "previewImageLink": "https://my-cdn.domain.com/products/45/preview.png",
  "images": [
    {
      "large": "https://my-cdn.domain.com/products/45/images/first_large.png",
      "medium": "https://my-cdn.domain.com/products/45/images/first_medium.png",
      "small": "https://my-cdn.domain.com/products/45/images/first_small.png",
      "rank": 0
    }
  ],
  "name": "Basic Plan",
  "shortDescription": "You can start with the Basic plan at any time and change it on a monthly basis.",
  "detailDescription": "text",
  "scopeOfService": "text",
  "marketplaceCategory": "Services",
  "marketplaceRank": 1,
  "status": "active",
  "ean": "0194253408253",
  "externalId": "E54363",
  "contexts": [
    {
      "name": "employee",
      "optional": false,
      "changeAllowed": false
    }
  ]
}

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "shortDescription": "You can start with the Basic plan at any time and change it on a monthly basis.",
  "detailDescription": "text",
  "scopeOfService": "text",
  "marketplaceCategory": "Services",
  "marketplaceRank": 1,
  "status": "active",
  "availability": "available",
  "availabilityMessage": "Available in 2-4 weeks",
  "contexts": [
    {
      "name": "employee",
      "optional": false,
      "changeAllowed": false
    }
  ],
  "offers": [
    {
      "id": 99,
      "type": "rental",
      "purchasePrice": 99.99,
      "recurringPrice": 19.99,
      "currency": "EUR",
      "subscriptionPeriod": 12,
      "name": "Summer Deal",
      "externalId": "W5A345",
      "isDefault": true,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "created": "2026-07-15T17:06:53.795Z",
  "id": 4,
  "name": "Basic Plan",
  "category": "text",
  "ean": "0194253408253",
  "externalId": "E54363",
  "supplierName": "text",
  "previewImageLink": "text",
  "type": "service",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single sales service by its id

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service.

Responses

200

OK: The requested sales service.

application/json

shortDescriptionstring · nullableOptional

A short description of the service without any formatting.

Example: You can start with the Basic plan at any time and change it on a monthly basis.

detailDescriptionstring · nullableOptional

scopeOfServicestring · nullableOptional

marketplaceCategorystring · nullableOptional

Technical name of the marketplace category in which the service is displayed. Marketplace category can be managed by each supplier.

Example: Services

marketplaceRankinteger · int32 · nullableOptional

Defines in which order the service is displayed in its marketplace category. The lower the value, the further forward the service is displayed.

statusstring · enumOptionalPossible values:

availabilitystring · enumOptional

Current availability status. Possible values: NULL, available, available_soon, not_available

Possible values:

availabilityMessagestring · nullableOptional

A message in the service details that is displayed to further define the availability of the product.

Example: Available in 2-4 weeks

createdstring · date-timeOptional

The date and time when the service was created. (ISO 8601 format)

idinteger · int32Required

The identifier of the service.

Example: 4

namestring · min: 1Required

The name of the service.

Example: Basic Plan

categorystring · nullableOptional

The category of the service. Comes from the marketplace ProductDisplayGroup

eanstring · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)

Example: 0194253408253

externalIdstring · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service.

Example: E54363

supplierNamestring · nullableOptional

The supplier for this service product

previewImageLinkstring · nullableOptional

Link to a small preview image for the product

typestring · enumOptional

Services can take on different types that define their meaning and process flows within the system.

Possible values:

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sales/services/{serviceId}

GET /v1/sales/services/{serviceId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "shortDescription": "You can start with the Basic plan at any time and change it on a monthly basis.",
  "detailDescription": "text",
  "scopeOfService": "text",
  "marketplaceCategory": "Services",
  "marketplaceRank": 1,
  "status": "active",
  "availability": "available",
  "availabilityMessage": "Available in 2-4 weeks",
  "contexts": [
    {
      "name": "employee",
      "optional": false,
      "changeAllowed": false
    }
  ],
  "offers": [
    {
      "id": 99,
      "type": "rental",
      "purchasePrice": 99.99,
      "recurringPrice": 19.99,
      "currency": "EUR",
      "subscriptionPeriod": 12,
      "name": "Summer Deal",
      "externalId": "W5A345",
      "isDefault": true,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "created": "2026-07-15T17:06:53.795Z",
  "id": 4,
  "name": "Basic Plan",
  "category": "text",
  "ean": "0194253408253",
  "externalId": "E54363",
  "supplierName": "text",
  "previewImageLink": "text",
  "type": "service",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Updates an existing sales service

put

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service.

Body

availabilitystring · enumOptional

Current availability status. Possible values: NULL, available, available_soon, not_available

Possible values:

availabilityMessagestring · max: 100 · nullableOptional

A message in the service details that is displayed to further define the availability of the service.

Example: Available in 2-4 weeks

namestring · max: 100Required

The name of the service. (Max. 100 characters)

Example: Basic Plan

shortDescriptionstring · max: 1500 · nullableOptional

A short description of the service without any formatting.

Example: You can start with the Basic plan at any time and change it on a monthly basis.

detailDescriptionstring · nullableOptional

scopeOfServicestring · nullableOptional

marketplaceCategorystring · max: 50Required

Technical name of the marketplace category in which the service is displayed. Marketplace category can be managed by each supplier.

Example: Services

marketplaceRankinteger · int32 · nullableOptional

Defines in which order the service is displayed in its marketplace category. The lower the value, the further forward the service is displayed.

statusstring · enumOptionalPossible values:

eanstring · max: 50 · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)

Example: 0194253408253

externalIdstring · max: 50 · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service.

Example: E54363

Responses

200

OK: Returns the updated sales service.

application/json

shortDescriptionstring · nullableOptional

A short description of the service without any formatting.

Example: You can start with the Basic plan at any time and change it on a monthly basis.

detailDescriptionstring · nullableOptional

scopeOfServicestring · nullableOptional

marketplaceCategorystring · nullableOptional

Technical name of the marketplace category in which the service is displayed. Marketplace category can be managed by each supplier.

Example: Services

marketplaceRankinteger · int32 · nullableOptional

Defines in which order the service is displayed in its marketplace category. The lower the value, the further forward the service is displayed.

statusstring · enumOptionalPossible values:

availabilitystring · enumOptional

Current availability status. Possible values: NULL, available, available_soon, not_available

Possible values:

availabilityMessagestring · nullableOptional

A message in the service details that is displayed to further define the availability of the product.

Example: Available in 2-4 weeks

createdstring · date-timeOptional

The date and time when the service was created. (ISO 8601 format)

idinteger · int32Required

The identifier of the service.

Example: 4

namestring · min: 1Required

The name of the service.

Example: Basic Plan

categorystring · nullableOptional

The category of the service. Comes from the marketplace ProductDisplayGroup

eanstring · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service. (Max. 50 characters)

Example: 0194253408253

externalIdstring · nullableOptional

Value to identify the service in other systems. E.g. when an other system is the source of this service.

Example: E54363

supplierNamestring · nullableOptional

The supplier for this service product

previewImageLinkstring · nullableOptional

Link to a small preview image for the product

typestring · enumOptional

Services can take on different types that define their meaning and process flows within the system.

Possible values:

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

put/v1/sales/services/{serviceId}

PUT /v1/sales/services/{serviceId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 434

{
  "availability": "available",
  "availabilityMessage": "Available in 2-4 weeks",
  "name": "Basic Plan",
  "shortDescription": "You can start with the Basic plan at any time and change it on a monthly basis.",
  "detailDescription": "text",
  "scopeOfService": "text",
  "marketplaceCategory": "Services",
  "marketplaceRank": 1,
  "status": "active",
  "ean": "0194253408253",
  "externalId": "E54363",
  "contexts": [
    {
      "name": "employee",
      "optional": false,
      "changeAllowed": false
    }
  ]
}

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "shortDescription": "You can start with the Basic plan at any time and change it on a monthly basis.",
  "detailDescription": "text",
  "scopeOfService": "text",
  "marketplaceCategory": "Services",
  "marketplaceRank": 1,
  "status": "active",
  "availability": "available",
  "availabilityMessage": "Available in 2-4 weeks",
  "contexts": [
    {
      "name": "employee",
      "optional": false,
      "changeAllowed": false
    }
  ],
  "offers": [
    {
      "id": 99,
      "type": "rental",
      "purchasePrice": 99.99,
      "recurringPrice": 19.99,
      "currency": "EUR",
      "subscriptionPeriod": 12,
      "name": "Summer Deal",
      "externalId": "W5A345",
      "isDefault": true,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "created": "2026-07-15T17:06:53.795Z",
  "id": 4,
  "name": "Basic Plan",
  "category": "text",
  "ean": "0194253408253",
  "externalId": "E54363",
  "supplierName": "text",
  "previewImageLink": "text",
  "type": "service",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Deletes an existing sales service

delete

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service to be deleted

Responses

204

NoContent: Delete successful.

No content

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

delete/v1/sales/services/{serviceId}

DELETE /v1/sales/services/{serviceId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Partially updates an existing sales service

patch

Please provide a valid JSON Patch document with the allowed fields to update. See example below for further details.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service.

Bodyobject · Operation[]

valueany · nullableOptional

pathstring · nullableOptional

opstring · nullableOptional

fromstring · nullableOptional

Responses

200

No content

204

NoContent: Service successfully released.

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

patch/v1/sales/services/{serviceId}

PATCH /v1/sales/services/{serviceId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 872

[
  {
    "op": "add",
    "path": "/ean",
    "value": "0194253408253"
  },
  {
    "op": "add",
    "path": "/externalId",
    "value": "E54363"
  },
  {
    "op": "add",
    "path": "/name",
    "value": "Basic Plan"
  },
  {
    "op": "add",
    "path": "/marketplaceCategoryId",
    "value": "Services"
  },
  {
    "op": "add",
    "path": "/marketplaceRank",
    "value": "null"
  },
  {
    "op": "add",
    "path": "/shortDescription",
    "value": "You can start with the Basic plan at any time and change it on a monthly basis."
  },
  {
    "op": "add",
    "path": "/detailDescription",
    "value": "stringValue"
  },
  {
    "op": "add",
    "path": "/previewImageLink",
    "value": "https://my-cdn.domain.com/products/45/preview.png"
  },
  {
    "op": "add",
    "path": "/images/-",
    "value": {
      "large": "https://my-cdn.domain.com/products/45/images/first_large.png",
      "medium": "https://my-cdn.domain.com/products/45/images/first_medium.png",
      "small": "https://my-cdn.domain.com/products/45/images/first_small.png",
      "rank": 0
    }
  },
  {
    "op": "add",
    "path": "/images/0",
    "value": {}
  }
]

No content

Get all attributes for a specific service product

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

Service to retrieve attributes for

Responses

200

No content

201

Created

application/json

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

get/v1/sales/services/{serviceId}/attributes

GET /v1/sales/services/{serviceId}/attributes HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Add, Remove or partially update attributes for a specific service product

patch

Attribute definitions and their possible values can be managed with the endpoints defined in System | Attribute Definitions

Please provide a valid JSON Patch document with the allowed fields to update. See example below for further details.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the service.

Bodyobject · Operation[]

valueany · nullableOptional

pathstring · nullableOptional

opstring · nullableOptional

fromstring · nullableOptional

Responses

204

NoContent: Update successful.

No content

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid API key.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

patch/v1/sales/services/{serviceId}/attributes

PATCH /v1/sales/services/{serviceId}/attributes HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 125

[
  {
    "op": "add",
    "path": "/attributes/-",
    "value": {
      "definitionId": 4,
      "valueId": 123
    }
  },
  {
    "op": "add",
    "path": "/attributes/0",
    "value": {}
  }
]

No content

Retrieve a list of all offers of a sales service

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service for which the offers are requested.

Query parameters

sortBystring · enumOptional

Sort the offers by a given criterion

Possible values:

sortOrderstring · enumOptional

Order in which the result of a list request is sorted.

Possible values:

offsetinteger · int32Optional

Specifies the index of the first offer to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of offers to return

Default: 100

Responses

200

OK: List of sales service offers.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sales/services/{serviceId}/offers

GET /v1/sales/services/{serviceId}/offers HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "created": "2026-07-15T17:06:53.795Z",
      "subscriptionPeriodRenewal": 1,
      "differentInvoiceIssuer": "equipme Leasing Corp",
      "id": 99,
      "type": "rental",
      "purchasePrice": 99.99,
      "recurringPrice": 19.99,
      "currency": "EUR",
      "subscriptionPeriod": 12,
      "name": "Summer Deal",
      "externalId": "W5A345",
      "isDefault": true,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a new sales service offer

post

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service for which the offer should be created.

Body

currencystring · enumRequired

Supported currencies in ISO 4217 format

Possible values:

namestring · max: 50 · nullableOptional

Name of the offer

Example: Summer Deal

typestring · enumRequiredPossible values:

customerIdsinteger · int32[] · nullableOptional

Customer IDs for which the service offer is available. If null, the service offer is available to all customers for which the service is available.

syncPriceFromBombooleanOptional

Determines if the Prices are synced to the sales offers of the mapped products

purchasePricenumber · double · max: 1.7976931348623157e+308Required

The price charged only once after providing the item.

Example: 99.99

recurringPricenumber · double · max: 1.7976931348623157e+308Required

The price charged monthly after providing the item for the subscription period

Example: 19.99

subscriptionPeriodinteger · int32 · max: 2147483647Required

The minimum subscription period (in month) for rental offers.

Example: 12

subscriptionPeriodRenewalinteger · int32 · max: 2147483647Required

Number of months a subscription is renewed after its expiration time if it has not been terminated.

Example: 1

differentInvoiceIssuerstring · max: 100 · nullableOptional

Specifies the invoicing company's name, used when billing is outsourced. Enter the legal name of the company handling invoices, different from the service provider. Applicable for organizations that outsource billing but manage service provision. Leave blank if billing is handled on your own.

Example: equipme Leasing Corp

externalIdstring · max: 50 · nullableOptional

Value to identify the offer in other systems. E.g. when another system is the source of this offer.

Example: 142EEF3

isDefaultboolean · nullableOptional

Specifies if this offer is a default offer for the service. Every service must have one default offer per offer type.

Responses

201

Created: The created sales service offer.

application/json

createdstring · date-timeRequired

UTC date of offer creation

subscriptionPeriodRenewalinteger · int32 · max: 2147483647Required

Number of months a subscription is renewed after its expiration time if it has not been terminated.

Example: 1

differentInvoiceIssuerstring · max: 100 · nullableOptional

Example: equipme Leasing Corp

idinteger · int32Required

The id to identify the offer in the system.

Example: 99

typestring · enumRequiredPossible values:

purchasePricenumber · double · max: 1.7976931348623157e+308Required

The price charged only once after providing the item.

Example: 99.99

recurringPricenumber · double · max: 1.7976931348623157e+308Required

The price charged monthly after providing the item for the subscription period

Example: 19.99

currencystring · min: 1Required

Currency in ISO 4217

Example: EUR

subscriptionPeriodinteger · int32 · max: 2147483647Required

The minimum subscription period (in months) for rental offers.

Example: 12

namestring · nullableOptional

Name of the offer

Example: Summer Deal

externalIdstring · nullableOptional

Value to identify the offer in other systems. E.g. when another system is the source of this offer.

Example: W5A345

isDefaultbooleanOptional

Indicates if this offer is a default offer for the service.

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

post/v1/sales/services/{serviceId}/offers

POST /v1/sales/services/{serviceId}/offers HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "currency": "EUR",
  "name": "Summer Deal",
  "type": "rental",
  "customerIds": [
    1
  ],
  "syncPriceFromBom": true,
  "purchasePrice": 99.99,
  "recurringPrice": 19.99,
  "subscriptionPeriod": 12,
  "subscriptionPeriodRenewal": 1,
  "differentInvoiceIssuer": "equipme Leasing Corp",
  "externalId": "142EEF3",
  "isDefault": true
}

{
  "created": "2026-07-15T17:06:53.795Z",
  "subscriptionPeriodRenewal": 1,
  "differentInvoiceIssuer": "equipme Leasing Corp",
  "id": 99,
  "type": "rental",
  "purchasePrice": 99.99,
  "recurringPrice": 19.99,
  "currency": "EUR",
  "subscriptionPeriod": 12,
  "name": "Summer Deal",
  "externalId": "W5A345",
  "isDefault": true,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single sales service offer by its id

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service for which the offer is requested.

offerIdinteger · int32Required

The identifier of the sales service offer.

Responses

200

OK: The requested sales service offer.

application/json

createdstring · date-timeRequired

UTC date of offer creation

subscriptionPeriodRenewalinteger · int32 · max: 2147483647Required

Number of months a subscription is renewed after its expiration time if it has not been terminated.

Example: 1

differentInvoiceIssuerstring · max: 100 · nullableOptional

Example: equipme Leasing Corp

idinteger · int32Required

The id to identify the offer in the system.

Example: 99

typestring · enumRequiredPossible values:

purchasePricenumber · double · max: 1.7976931348623157e+308Required

The price charged only once after providing the item.

Example: 99.99

recurringPricenumber · double · max: 1.7976931348623157e+308Required

The price charged monthly after providing the item for the subscription period

Example: 19.99

currencystring · min: 1Required

Currency in ISO 4217

Example: EUR

subscriptionPeriodinteger · int32 · max: 2147483647Required

The minimum subscription period (in months) for rental offers.

Example: 12

namestring · nullableOptional

Name of the offer

Example: Summer Deal

externalIdstring · nullableOptional

Value to identify the offer in other systems. E.g. when another system is the source of this offer.

Example: W5A345

isDefaultbooleanOptional

Indicates if this offer is a default offer for the service.

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sales/services/{serviceId}/offers/{offerId}

GET /v1/sales/services/{serviceId}/offers/{offerId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "created": "2026-07-15T17:06:53.795Z",
  "subscriptionPeriodRenewal": 1,
  "differentInvoiceIssuer": "equipme Leasing Corp",
  "id": 99,
  "type": "rental",
  "purchasePrice": 99.99,
  "recurringPrice": 19.99,
  "currency": "EUR",
  "subscriptionPeriod": 12,
  "name": "Summer Deal",
  "externalId": "W5A345",
  "isDefault": true,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Updates an existing sales service offer

put

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service for which the offer is to be updated

offerIdinteger · int32Required

The identifier of the offer to be updated

Body

syncPriceFromBombooleanOptional

Determines if the Prices are synced to the sales offers of the mapped products

purchasePricenumber · double · max: 1.7976931348623157e+308Required

The price charged only once after providing the item.

Example: 99.99

recurringPricenumber · double · max: 1.7976931348623157e+308Required

The price charged monthly after providing the item for the subscription period

Example: 19.99

subscriptionPeriodinteger · int32 · max: 2147483647Required

The minimum subscription period (in month) for rental offers.

Example: 12

subscriptionPeriodRenewalinteger · int32 · max: 2147483647Required

Number of months a subscription is renewed after its expiration time if it has not been terminated.

Example: 1

differentInvoiceIssuerstring · max: 100 · nullableOptional

Example: equipme Leasing Corp

externalIdstring · max: 50 · nullableOptional

Value to identify the offer in other systems. E.g. when another system is the source of this offer.

Example: 142EEF3

isDefaultboolean · nullableOptional

Specifies if this offer is a default offer for the service. Every service must have one default offer per offer type.

Responses

200

OK: Returns the updated product.

application/json

createdstring · date-timeRequired

UTC date of offer creation

subscriptionPeriodRenewalinteger · int32 · max: 2147483647Required

Number of months a subscription is renewed after its expiration time if it has not been terminated.

Example: 1

differentInvoiceIssuerstring · max: 100 · nullableOptional

Example: equipme Leasing Corp

idinteger · int32Required

The id to identify the offer in the system.

Example: 99

typestring · enumRequiredPossible values:

purchasePricenumber · double · max: 1.7976931348623157e+308Required

The price charged only once after providing the item.

Example: 99.99

recurringPricenumber · double · max: 1.7976931348623157e+308Required

The price charged monthly after providing the item for the subscription period

Example: 19.99

currencystring · min: 1Required

Currency in ISO 4217

Example: EUR

subscriptionPeriodinteger · int32 · max: 2147483647Required

The minimum subscription period (in months) for rental offers.

Example: 12

namestring · nullableOptional

Name of the offer

Example: Summer Deal

externalIdstring · nullableOptional

Value to identify the offer in other systems. E.g. when another system is the source of this offer.

Example: W5A345

isDefaultbooleanOptional

Indicates if this offer is a default offer for the service.

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

put/v1/sales/services/{serviceId}/offers/{offerId}

PUT /v1/sales/services/{serviceId}/offers/{offerId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "syncPriceFromBom": true,
  "purchasePrice": 99.99,
  "recurringPrice": 19.99,
  "subscriptionPeriod": 12,
  "subscriptionPeriodRenewal": 1,
  "differentInvoiceIssuer": "equipme Leasing Corp",
  "externalId": "142EEF3",
  "isDefault": true
}

{
  "created": "2026-07-15T17:06:53.795Z",
  "subscriptionPeriodRenewal": 1,
  "differentInvoiceIssuer": "equipme Leasing Corp",
  "id": 99,
  "type": "rental",
  "purchasePrice": 99.99,
  "recurringPrice": 19.99,
  "currency": "EUR",
  "subscriptionPeriod": 12,
  "name": "Summer Deal",
  "externalId": "W5A345",
  "isDefault": true,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Deletes an existing sales service offer

delete

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

serviceIdinteger · int32Required

The identifier of the sales service for which the offer is to be deleted

offerIdinteger · int32Required

The identifier of the offer to be deleted

Responses

204

NoContent: Delete successful.

No content

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

delete/v1/sales/services/{serviceId}/offers/{offerId}

DELETE /v1/sales/services/{serviceId}/offers/{offerId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Last updated 4 hours ago

Was this helpful?