Sales | Customer Services

Get all metadata items for a specific service product

get

Authorizations

ApiKey

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

customerIdinteger · int32Required

serviceIdinteger · int32Required

Responses

200

Ok

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/customers/{customerId}/services/{serviceId}/metadata

HTTPcURLJavaScriptPython

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

No content

Create a new metadata entry for a specific service product and customer

post

Authorizations

ApiKey

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

customerIdinteger · int32Required

serviceIdinteger · int32Required

Unique service id

Body

application/json

DTO for creating a new metadata entry for a given resource which implements the logic

keystring · max: 150 · nullableOptional

Key for the new metadata entry

valuestring · max: 500 · nullableOptional

Metadata value

Responses

201

Created

application/json

valuestring · max: 500 · nullableOptional

Metadata value

Example: EQ1337555

scopestring · nullableOptional

Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.

Example: Supplier

keystring · max: 150Required

Metadata key used as a unique identifier for the metadata item.

Example: ExternalSystemId

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.

post/v1/sales/customers/{customerId}/services/{serviceId}/metadata

HTTPcURLJavaScriptPython

POST /v1/sales/customers/{customerId}/services/{serviceId}/metadata HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "key": "text",
  "value": "text"
}

{
  "value": "EQ1337555",
  "scope": "Supplier",
  "key": "ExternalSystemId",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Get a metadata item by service and metadata key

get

Authorizations

ApiKey

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

customerIdinteger · int32Required

serviceIdinteger · int32Required

keystringRequired

Responses

200

Ok

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/customers/{customerId}/services/{serviceId}/metadata/{key}

HTTPcURLJavaScriptPython

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

No content

Delete a specific metadata item for an service product

delete

Authorizations

ApiKey

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

customerIdinteger · int32Required

serviceIdinteger · int32Required

keystringRequired

Responses

201

Ok

application/json

valuestring · max: 500 · nullableOptional

Metadata value

Example: EQ1337555

scopestring · nullableOptional

Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.

Example: Supplier

keystring · max: 150Required

Metadata key used as a unique identifier for the metadata item.

Example: ExternalSystemId

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.

delete/v1/sales/customers/{customerId}/services/{serviceId}/metadata/{key}

HTTPcURLJavaScriptPython

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

{
  "value": "EQ1337555",
  "scope": "Supplier",
  "key": "ExternalSystemId",
  "self": {
    "href": "text",
    "method": "text"
  }
}