Sourcing | BOM Definitions

List the BOM definitions of a sales service (currently only base BOM definition is supported)

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.

Query parameters

serviceIdinteger · int32Required

The identifier of the sales service.

Responses

200

OK: A list of BOM definitions.

application/json

totalinteger · int32Required

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/sourcing/bom-definitions

HTTPcURLJavaScriptPython

GET /v1/sourcing/bom-definitions?serviceId=1 HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "id": 1,
      "type": "base",
      "items": [
        {
          "id": 1,
          "product": {
            "id": 1,
            "name": "Basic Plan",
            "partNumber": "EQ-0001",
            "externalId": "3704e3bed2654eaf8222800068f62b56",
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "quantity": 1,
          "subscriptionPeriodCondition": 1,
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a new BOM definition for a sales service (currently only one base BOM definition is allowed)

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.

Body

application/json

serviceIdinteger · int32Required

The identifier of the sales service this BOM definition belongs to.

Example: 1

Responses

201

Created: The created BOM definition.

application/json

idinteger · int64Required

The identifier of the BOM definition.

Example: 1

typestring · enumRequiredPossible 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

409

Conflict: A base BOM definition already exists for this service.

application/json

post/v1/sourcing/bom-definitions

HTTPcURLJavaScriptPython

POST /v1/sourcing/bom-definitions HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "serviceId": 1,
  "items": [
    {
      "productId": 1,
      "quantity": 1,
      "subscriptionPeriodCondition": 1
    }
  ]
}

{
  "id": 1,
  "type": "base",
  "items": [
    {
      "id": 1,
      "product": {
        "id": 1,
        "name": "Basic Plan",
        "partNumber": "EQ-0001",
        "externalId": "3704e3bed2654eaf8222800068f62b56",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "quantity": 1,
      "subscriptionPeriodCondition": 1,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "self": {
    "href": "text",
    "method": "text"
  }
}

Add a product item to an existing BOM definition

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

bomDefinitionIdinteger · int64Required

Identifier of the BOM definition.

Body

application/json

productIdinteger · int64Required

The identifier of the sourcing product to add as a BOM item.

Example: 1

quantityinteger · int32 · min: 1 · max: 20Required

The quantity of this product in the BOM definition.

Default: 1Example: 1

subscriptionPeriodConditioninteger · int32 · max: 2147483647 · nullableOptional

If set, this item only applies to orders of an offer with the matching subscription period.

Responses

201

Created: The created BOM definition item.

application/json

idinteger · int64Required

The identifier of the BOM definition item.

Example: 1

quantityinteger · int32Required

The quantity of this product in the BOM definition.

Default: 1Example: 1

subscriptionPeriodConditioninteger · int32 · nullableOptional

If set, this item only applies to orders of an offer with the matching subscription period.

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

post/v1/sourcing/bom-definitions/{bomDefinitionId}/items

HTTPcURLJavaScriptPython

POST /v1/sourcing/bom-definitions/{bomDefinitionId}/items HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "productId": 1,
  "quantity": 1,
  "subscriptionPeriodCondition": 1
}

{
  "id": 1,
  "product": {
    "id": 1,
    "name": "Basic Plan",
    "partNumber": "EQ-0001",
    "externalId": "3704e3bed2654eaf8222800068f62b56",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "quantity": 1,
  "subscriptionPeriodCondition": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Remove an item from a BOM definition

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

bomDefinitionIdinteger · int64Required

Identifier of the BOM definition.

itemIdinteger · int64Required

The identifier of the item to be removed.

Responses

204

NoContent: Item successfully removed.

No content

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/sourcing/bom-definitions/{bomDefinitionId}/items/{itemId}

HTTPcURLJavaScriptPython

DELETE /v1/sourcing/bom-definitions/{bomDefinitionId}/items/{itemId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content