Outsource product lines

Outsource product lines provide information about products that have been applied to outsourced tickets by a partnered provider.

Outsource product line

The outsource product lines object provides information about products that have been applied to outsourced tickets by a partnered provider.

ticket_id
string <uuid>

Ticket identifier of the ticket that was outsourced to the partnered provider.

outsource_id
string <uuid>

Outsource identifier.

object (Money)

The discount for this product line.

amount
number <float>

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

object (Money)

The gross price of the product line. This is calculated using unit_gross_price x quantity.

amount
number <float>

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

object (Money)

The original equipment service fee for this product line. This is the original equipment service fee of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

product_id
string or null <uuid>

Product identifier.

product_name
string [ 1 .. 255 ] characters

Product name in the requested language.

product_number
string

Product number. This is the product number as referenced by your partnered provider.

provider_id
string <uuid>

Identifier of the partnered provider to which the outsource request has been sent.

quantity
integer <int32> >= 1

Quantity.

object (Money)

The gross price of one unit of the product line. This is the product gross price of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

{
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "outsource_id": "880092d9-6aa9-4787-863b-6f1c3c58f8c2",
  • "discount": {
    },
  • "gross_price": {
    },
  • "original_equipment_service_fee": {
    },
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "product_name": "Remote Diagnostic Support",
  • "product_number": "0000001",
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "quantity": 1,
  • "unit_gross_price": {
    }
}

Retrieve all outsource product lines

Retrieve a list of outsource product lines. Outsource product lines represent requested services that have been applied to an outsourced ticket by a partnered provider.

SecurityOAuth2 and ApiKey
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

outsource_created_after
string <date-time>

Return only outsource product lines that are associated with an outsource that was created after the provided date and time.

Example: outsource_created_after=2023-03-15T08:34:28Z
outsource_created_before
string <date-time>

Return only outsource product lines that are associated with an outsource that was created before the provided date and time.

Example: outsource_created_before=2023-03-15T08:34:28Z
outsource_finished_after
string <date-time>

Return only outsource product lines that are associated with an outsource that was finished after the provided date and time.

Example: outsource_finished_after=2023-03-15T08:34:28Z
outsource_finished_before
string <date-time>

Return only outsource product lines that are associated with an outsource that was finished before the provided date and time.

Example: outsource_finished_before=2023-03-15T08:34:28Z
outsource_state
Array of strings (Outsource-state) non-empty unique

Only return outsource product lines that are associated with an outsource that is in the provided state(s).

Items Enum Value Description
pending

The outsource is waiting to be worked on at the partnered provider.

in_progress

The outsource is being worked by an operator.

closed

The outsource is successfully finished.

cancelled

The outsource is cancelled, see cancel_reason_id as to why.

provider_id
string <uuid>

Filter outsource product lines by identifier of the partnered provider to which the outsource request has been sent.

ticket_id
string <uuid>

Filter outsource product lines by ticket_id.

header Parameters
Accept-Language
string
Default: en

Use this header to indicate the natural language and locale in which you want to receive translatable property values. Multiple preferences can be provided using a weighted qualifier. Properties that support translations will specify so in their description.

Examples:
fr-CH
Request for French (Switzerland) or, if not supported (in preferred order), French, English or German.
fr-CH,fr;q=0.9,en;q=0.8,de;q=0.7
Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Outsource product line) >= 0 items

List of outsource product lines.

Array (>= 0 items)
ticket_id
string <uuid>

Ticket identifier of the ticket that was outsourced to the partnered provider.

outsource_id
string <uuid>

Outsource identifier.

object (Money)

The discount for this product line.

object (Money)

The gross price of the product line. This is calculated using unit_gross_price x quantity.

object (Money)

The original equipment service fee for this product line. This is the original equipment service fee of the referenced product at the time of adding this product line.

product_id
string or null <uuid>

Product identifier.

product_name
string [ 1 .. 255 ] characters

Product name in the requested language.

product_number
string

Product number. This is the product number as referenced by your partnered provider.

provider_id
string <uuid>

Identifier of the partnered provider to which the outsource request has been sent.

quantity
integer <int32> >= 1

Quantity.

object (Money)

The gross price of one unit of the product line. This is the product gross price of the referenced product at the time of adding this product line.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/outsource-product-lines
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}