Sourcing | Products

Retrieve a list of sourcing products

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

externalIdsstring[]Optional

Filter the products by one or more external ids.

partNumbersstring[]Optional

Filter the products by one or more part numbers.

eansstring[]Optional

Filter the products by one or more ean.

sortBystring · enumOptional

Sort the products 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 product to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of products to return

Default: 100

Responses

200

OK: List of sourcing products.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/sourcing/products

HTTPcURLJavaScriptPython

GET /v1/sourcing/products HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "source": "itscope",
      "description": "Best plan for starters.",
      "category": "saas",
      "manufacturer": "equipme GmbH",
      "ean": 5397184575161,
      "defaultSourcingOffer": {
        "supplier": {
          "id": 4,
          "name": "foo Inc.",
          "self": {
            "href": "text",
            "method": "text"
          }
        },
        "price": 14,
        "stockQuantity": 1,
        "currency": "EUR",
        "created": "2022-01-02",
        "externalId": "4ae705",
        "id": 1,
        "scope": "sourcing",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "defaultSalesOffer": {
        "supplier": {
          "id": 4,
          "name": "foo Inc.",
          "self": {
            "href": "text",
            "method": "text"
          }
        },
        "price": 14,
        "stockQuantity": 1,
        "currency": "EUR",
        "created": "2022-01-02",
        "externalId": "4ae705",
        "id": 1,
        "scope": "sourcing",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "isStockProduct": true,
      "minimumStock": 1,
      "id": 1,
      "name": "Basic Plan",
      "partNumber": "EQ-0001",
      "externalId": "3704e3bed2654eaf8222800068f62b56",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a new sourcing product

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.

Query parameters

allowDuplicatePartNumberbooleanOptional

Optional: if false the part number of the given product will be checked for duplicates. There should be no product of the same manufacturer with the same part number, as they would likely be duplicates. Set the value to true to skip the duplicate check. Default: false.

Default: false

Body

application/json

externalIdstring · max: 256 · nullableOptional

The id of the product in an external application like an ERP. Can be used for synchronization correlation.

Example: 3704e3bed2654eaf8222800068f62b56

sourcestring · nullableOptional

A reference value to identify the source of the product. This is used to identify the product in an external system combined with the external id.

Example: itscope

namestring · max: 512Required

The name of the product

Example: Basic Plan

descriptionstring · max: 2048 · nullableOptional

A short description of the product

Example: Best plan for starters.

eanstring · max: 50 · nullableOptional

The European Article Number of the product

Example: 5397184575161

partNumberstring · max: 256 · nullableOptional

The manufacturer part number of the product.

Example: EQ-0001

manufacturerstring · max: 256 · nullableOptional

The name of the company which produces the product.

Example: equipme GmbH

categorystring · min: 1Required

Name of the technical category of the product. For available categories see /categories route.

Example: saas

isStockProductboolean · nullableOptional

Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.

minimumStockinteger · int32 · max: 1000 · nullableOptional

The minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed. Requires "IsStockProduct" to be set to true otherwise it will be ignored

Responses

201

Created: The created sourcing product.

application/json

sourcestring · nullableOptional

A reference value to identify the source of the product. This is used to identify the product in an external system combined with the external id.

Example: itscope

descriptionstring · nullableOptional

A short description of the product

Example: Best plan for starters.

categorystring · min: 1Required

Name of the technical category of the product.

Example: saas

manufacturerstring · nullableOptional

The name of the company which produces the product.

Example: equipme GmbH

eanstring · nullableOptional

The European Article Number of the product

Example: 5397184575161

isStockProductboolean · nullableOptional

Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.

minimumStockinteger · int32 · max: 1000 · nullableOptional

Minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed. Requires "IsStockProduct" to be set to true otherwise it will be ignored

idinteger · int64Required

The identifier of the product.

Example: 1

namestring · min: 1Required

The name of the product.

Example: Basic Plan

partNumberstring · min: 1Required

The manufacturer part number of the product.

Example: EQ-0001

externalIdstring · nullableOptional

The id of the product in an external application like an ERP. Can be used for synchronization correlation.

Example: 3704e3bed2654eaf8222800068f62b56

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

409

Conflict: The given part number is already related to another product from the same manufacturer. Set the parameter 'allowDuplicatePartNumber' to true to ignore the conflict.

application/json

post/v1/sourcing/products

HTTPcURLJavaScriptPython

POST /v1/sourcing/products HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 523

{
  "externalId": "3704e3bed2654eaf8222800068f62b56",
  "source": "itscope",
  "sourcingOffer": {
    "scope": "sourcing",
    "supplier": "equipme GmbH",
    "price": 14.99,
    "stockQuantity": 1,
    "currency": "EUR",
    "externalId": "4ae705"
  },
  "name": "Basic Plan",
  "description": "Best plan for starters.",
  "ean": 5397184575161,
  "partNumber": "EQ-0001",
  "manufacturer": "equipme GmbH",
  "category": "saas",
  "salesOffer": {
    "scope": "sourcing",
    "supplier": "equipme GmbH",
    "price": 14.99,
    "stockQuantity": 1,
    "currency": "EUR",
    "externalId": "4ae705"
  },
  "isStockProduct": true,
  "minimumStock": 1
}

{
  "source": "itscope",
  "description": "Best plan for starters.",
  "category": "saas",
  "manufacturer": "equipme GmbH",
  "ean": 5397184575161,
  "defaultSourcingOffer": {
    "supplier": {
      "id": 4,
      "name": "foo Inc.",
      "self": {
        "href": "text",
        "method": "text"
      }
    },
    "price": 14,
    "stockQuantity": 1,
    "currency": "EUR",
    "created": "2022-01-02",
    "externalId": "4ae705",
    "id": 1,
    "scope": "sourcing",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "defaultSalesOffer": {
    "supplier": {
      "id": 4,
      "name": "foo Inc.",
      "self": {
        "href": "text",
        "method": "text"
      }
    },
    "price": 14,
    "stockQuantity": 1,
    "currency": "EUR",
    "created": "2022-01-02",
    "externalId": "4ae705",
    "id": 1,
    "scope": "sourcing",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "isStockProduct": true,
  "minimumStock": 1,
  "id": 1,
  "name": "Basic Plan",
  "partNumber": "EQ-0001",
  "externalId": "3704e3bed2654eaf8222800068f62b56",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a sourcing product by its id

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

productIdinteger · int32Required

The identifier of the sourcing product.

Responses

200

OK: Sourcing product.

application/json

sourcestring · nullableOptional

A reference value to identify the source of the product. This is used to identify the product in an external system combined with the external id.

Example: itscope

descriptionstring · nullableOptional

A short description of the product

Example: Best plan for starters.

categorystring · min: 1Required

Name of the technical category of the product.

Example: saas

manufacturerstring · nullableOptional

The name of the company which produces the product.

Example: equipme GmbH

eanstring · nullableOptional

The European Article Number of the product

Example: 5397184575161

isStockProductboolean · nullableOptional

Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.

minimumStockinteger · int32 · max: 1000 · nullableOptional

Minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed. Requires "IsStockProduct" to be set to true otherwise it will be ignored

idinteger · int64Required

The identifier of the product.

Example: 1

namestring · min: 1Required

The name of the product.

Example: Basic Plan

partNumberstring · min: 1Required

The manufacturer part number of the product.

Example: EQ-0001

externalIdstring · nullableOptional

The id of the product in an external application like an ERP. Can be used for synchronization correlation.

Example: 3704e3bed2654eaf8222800068f62b56

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sourcing/products/{productId}

HTTPcURLJavaScriptPython

GET /v1/sourcing/products/{productId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "source": "itscope",
  "description": "Best plan for starters.",
  "category": "saas",
  "manufacturer": "equipme GmbH",
  "ean": 5397184575161,
  "defaultSourcingOffer": {
    "supplier": {
      "id": 4,
      "name": "foo Inc.",
      "self": {
        "href": "text",
        "method": "text"
      }
    },
    "price": 14,
    "stockQuantity": 1,
    "currency": "EUR",
    "created": "2022-01-02",
    "externalId": "4ae705",
    "id": 1,
    "scope": "sourcing",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "defaultSalesOffer": {
    "supplier": {
      "id": 4,
      "name": "foo Inc.",
      "self": {
        "href": "text",
        "method": "text"
      }
    },
    "price": 14,
    "stockQuantity": 1,
    "currency": "EUR",
    "created": "2022-01-02",
    "externalId": "4ae705",
    "id": 1,
    "scope": "sourcing",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "isStockProduct": true,
  "minimumStock": 1,
  "id": 1,
  "name": "Basic Plan",
  "partNumber": "EQ-0001",
  "externalId": "3704e3bed2654eaf8222800068f62b56",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Update a sourcing product

put

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

productIdinteger · int32Required

The identifier of the sourcing product.

Query parameters

allowDuplicatePartNumberbooleanOptional

Optional: if false the part number of the given product will be checked for duplicates. There should be no product of the same manufacturer with the same part number, as they would likely be duplicates. Set the value to true to skip the duplicate check. Default: false.

Default: false

Body

application/json

namestring · max: 512Required

The name of the product

Example: Basic Plan

descriptionstring · max: 2048 · nullableOptional

A short description of the product

Example: Best plan for starters.

eanstring · max: 50 · nullableOptional

The European Article Number of the product

Example: 5397184575161

partNumberstring · max: 256 · nullableOptional

The manufacturer part number of the product.

Example: EQ-0001

manufacturerstring · max: 256 · nullableOptional

The name of the company which produces the product.

Example: equipme GmbH

categorystring · min: 1Required

Name of the technical category of the product. For available categories see /categories route.

Example: saas

isStockProductboolean · nullableOptional

Defines whether the product is a stock product or not. If true, minimumStock can also be set. If null, the information will be ignored.

minimumStockinteger · int32 · max: 1000 · nullableOptional

The minimum number of articles stored of this product. If the stock falls below this amount, a new procurement order should be placed. Requires "IsStockProduct" to be set to true otherwise it will be ignored

Responses

204

NoContent: The product was successfully updated.

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

409

Conflict: The given part number is already related to another product from the same manufacturer. Set the parameter 'allowDuplicatePartNumber' to true to ignore the conflict.

application/json

put/v1/sourcing/products/{productId}

HTTPcURLJavaScriptPython

PUT /v1/sourcing/products/{productId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "name": "Basic Plan",
  "description": "Best plan for starters.",
  "ean": 5397184575161,
  "partNumber": "EQ-0001",
  "manufacturer": "equipme GmbH",
  "category": "saas",
  "salesOffer": {
    "scope": "sourcing",
    "supplier": "equipme GmbH",
    "price": 14.99,
    "stockQuantity": 1,
    "currency": "EUR",
    "externalId": "4ae705"
  },
  "isStockProduct": true,
  "minimumStock": 1
}

No content

Delete a sourcing 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

productIdinteger · int32Required

The identifier of the sourcing product for which the offer should be updated.

Query parameters

forcebooleanOptional

Set to true if any conflicts that prevent the deletion should be ignored. (e.g. when the product is part of a bom and force is false, the product can not be deleted. If force is set to true the product will be removed from the bom and then deleted)

Default: false

Responses

204

NoContent: The product was successfully deleted.

No content

400

BadRequest: Delete not supported.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Given Product not found.

application/json

409

Conflict: The given product has relations to other entities and can therefore not be deleted. If the conflicts should be ignored, set force to true.

application/json

delete/v1/sourcing/products/{productId}

HTTPcURLJavaScriptPython

DELETE /v1/sourcing/products/{productId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Retrieve a list of offers of a specific sourcing 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

productIdinteger · int64Required

The identifier of the sourcing product for which the offers are requested.

Query parameters

scopestring · enumOptional

Filter the offers according to their type. When null, all offers will be returned. Default: null

Possible values:

isCurrentOfferbooleanOptionalDefault: true

sortBystring · enumOptional

Sort the items 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 item to return.

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000).

Default: 100

Responses

200

OK: Response object with a list of offers and the total count to apply paging operations.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sourcing/products/{productId}/offers

HTTPcURLJavaScriptPython

GET /v1/sourcing/products/{productId}/offers 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"
        }
      },
      "price": 14,
      "stockQuantity": 1,
      "currency": "EUR",
      "created": "2022-01-02",
      "externalId": "4ae705",
      "id": 1,
      "scope": "sourcing",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a new offer for a sourcing product. This offer is automatically set as current offer.

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

productIdinteger · int64Required

The identifier of the sourcing product for which the offer should be created.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

scopestring · enumRequiredPossible values:

supplierstring · nullableOptional

The supplier offering the product at given price.

Example: equipme GmbH

pricenumber · double · max: 7.922816251426434e+28Required

The price of the offer.

Example: 14.99

stockQuantityinteger · int32 · max: 7.922816251426434e+28 · nullableOptional

The currently available stock quantity.

currencystring · enumRequired

Supported currencies in ISO 4217 format

Possible values:

externalIdstring · max: 256 · nullableOptional

The id of the offer in an external application like an ERP. Can be used for synchronization correlation.

Example: 4ae705

Responses

201

Created: The created offer.

application/json

pricenumber · double · max: 7.922816251426434e+28Required

The price of the offer.

Example: 14

stockQuantityinteger · int32 · nullableOptional

The currently available stock quantity.

currencystring · enumRequired

Supported currencies in ISO 4217 format

Possible values:

createdstring · date-timeRequired

The time when the offer got created.

Example: 2022-01-02

externalIdstring · nullableOptional

The id of the offer in an external application like an ERP. Can be used for synchronization correlation.

Example: 4ae705

idinteger · int64Required

The identifier of the product offer.

Example: 1

scopestring · enumOptionalPossible 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

404

NotFound: Requested resource could not be found.

application/json

post/v1/sourcing/products/{productId}/offers

HTTPcURLJavaScriptPython

POST /v1/sourcing/products/{productId}/offers HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 117

{
  "scope": "sourcing",
  "supplier": "equipme GmbH",
  "price": 14.99,
  "stockQuantity": 1,
  "currency": "EUR",
  "externalId": "4ae705"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "price": 14,
  "stockQuantity": 1,
  "currency": "EUR",
  "created": "2022-01-02",
  "externalId": "4ae705",
  "id": 1,
  "scope": "sourcing",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single offer of a specific sourcing product by its id

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

productIdinteger · int64Required

The identifier of the sourcing product for which the offer is requested.

offerIdinteger · int64Required

The identifier of the offer.

Responses

200

OK: The requested offer.

application/json

pricenumber · double · max: 7.922816251426434e+28Required

The price of the offer.

Example: 14

stockQuantityinteger · int32 · nullableOptional

The currently available stock quantity.

currencystring · enumRequired

Supported currencies in ISO 4217 format

Possible values:

createdstring · date-timeRequired

The time when the offer got created.

Example: 2022-01-02

externalIdstring · nullableOptional

The id of the offer in an external application like an ERP. Can be used for synchronization correlation.

Example: 4ae705

idinteger · int64Required

The identifier of the product offer.

Example: 1

scopestring · enumOptionalPossible values:

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sourcing/products/{productId}/offers/{offerId}

HTTPcURLJavaScriptPython

GET /v1/sourcing/products/{productId}/offers/{offerId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "price": 14,
  "stockQuantity": 1,
  "currency": "EUR",
  "created": "2022-01-02",
  "externalId": "4ae705",
  "id": 1,
  "scope": "sourcing",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Update a sourcing product offer

put

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

productIdinteger · int64Required

The identifier of the sourcing product for which the offer should be updated.

offerIdinteger · int64Required

The id of the offer which should be updated.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

supplierstring · nullableOptional

The supplier offering the product at given price.

Example: equipme GmbH

pricenumber · double · max: 7.922816251426434e+28Required

The price of the offer.

Example: 14.99

stockQuantityinteger · int32 · max: 7.922816251426434e+28 · nullableOptional

The currently available stock quantity.

currencystring · enumRequired

Supported currencies in ISO 4217 format

Possible values:

externalIdstring · max: 256 · nullableOptional

The id of the offer in an external application like an ERP. Can be used for synchronization correlation.

Example: 4ae705

Responses

200

OK: The updated offer.

application/json

pricenumber · double · max: 7.922816251426434e+28Required

The price of the offer.

Example: 14

stockQuantityinteger · int32 · nullableOptional

The currently available stock quantity.

currencystring · enumRequired

Supported currencies in ISO 4217 format

Possible values:

createdstring · date-timeRequired

The time when the offer got created.

Example: 2022-01-02

externalIdstring · nullableOptional

The id of the offer in an external application like an ERP. Can be used for synchronization correlation.

Example: 4ae705

idinteger · int64Required

The identifier of the product offer.

Example: 1

scopestring · enumOptionalPossible values:

400

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

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

409

Conflict: If the offer is already used in an order, the offer cannot be updated due to historization. To update the current offer anyway, use the create route.

application/json

put/v1/sourcing/products/{productId}/offers/{offerId}

HTTPcURLJavaScriptPython

PUT /v1/sourcing/products/{productId}/offers/{offerId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 98

{
  "supplier": "equipme GmbH",
  "price": 14.99,
  "stockQuantity": 1,
  "currency": "EUR",
  "externalId": "4ae705"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "price": 14,
  "stockQuantity": 1,
  "currency": "EUR",
  "created": "2022-01-02",
  "externalId": "4ae705",
  "id": 1,
  "scope": "sourcing",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a list of sales services in which the specific sourcing product is part of any bill of materials

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

productIdinteger · int64Required

The identifier of the sourcing product for which the services are requested.

Query parameters

sortBystring · enumOptional

Sort the items 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 item to return.

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000).

Default: 100

Responses

200

OK: Response object with a list of services and the total count to apply paging operations.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sourcing/products/{productId}/services

HTTPcURLJavaScriptPython

GET /v1/sourcing/products/{productId}/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"
        }
      },
      "price": 14,
      "stockQuantity": 1,
      "currency": "EUR",
      "created": "2022-01-02",
      "externalId": "4ae705",
      "id": 1,
      "scope": "sourcing",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}