{
”x-generator”: ”NSwag v13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v13.0.0.0))”,
”swagger”: ”2.0”,
”info”: {
”title”: ”Rosie Vendor API”,
”version”: ”2.0”
},
”host”: ”api.radera.tech”,
”schemes”: [
”https”
],
”consumes”: [
”application/json”,
”text/json”,
”application/xml”,
”text/xml”,
”application/x-www-form-urlencoded”
],
”produces”: [
”application/json”,
”text/json”,
”application/xml”,
”text/xml”
],
”paths”: {
”/api/v2/fpc/deal”: {
”post”: {
”tags”: [
”Fpc”
],
”operationId”: ”Fpc_Deal”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”request”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/RegisterFpcTransactionApiRequestDto”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/RegisterFpcTransactionApiResponseDto”
}
}
}
}
},
”/api/v2/fpc/shopping-cart/calculate”: {
”post”: {
”tags”: [
”Fpc”
],
”operationId”: ”Fpc_CalculateShoppingCart”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”devicesIdentifiers”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/CalculateShoppingCartRequestDto”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/CalculateShoppingCartResponseDto”
}
}
}
}
},
”/api/v2/fpc/products/update”: {
”patch”: {
”tags”: [
”Fpc”
],
”operationId”: ”Fpc_UpdateProducts”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”parameters”: [
{
”name”: ”command”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/UpdateFpcTransactionProducts”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
}
},
”/api/v2/fpc/cancel”: {
”patch”: {
”tags”: [
”Fpc”
],
”operationId”: ”Fpc_Cancel”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”fpcTransactionId”,
”in”: ”query”,
”required”: true,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”boolean”,
”name”: ”keepTradeIn”,
”in”: ”query”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
}
},
”/api/v2/fpc/residual”: {
”get”: {
”tags”: [
”Fpc”
],
”summary”: ”Fpc Products Residual Prices”,
”operationId”: ”Fpc_Residual”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”sku”,
”in”: ”query”,
”description”: ”Sku. Optional.”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”limit”,
”in”: ”query”,
”description”: ”Limit. 10 by default. 100 maximum.”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”integer”,
”name”: ”offset”,
”in”: ”query”,
”description”: ”Offset. 0 by default.”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/ResidualPriceResponseDto”
}
}
}
}
}
},
”/api/v2/fpc/products”: {
”get”: {
”tags”: [
”Fpc”
],
”summary”: ”Fpc Products”,
”operationId”: ”Fpc_Products”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”limit”,
”in”: ”query”,
”description”: ”Limit. 10 by default. 100 maximum.”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”integer”,
”name”: ”offset”,
”in”: ”query”,
”description”: ”Offset. 0 by default.”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcShortProductInfoDto”
}
}
}
}
}
},
”/api/v2/fpc/products/lookup”: {
”get”: {
”tags”: [
”Fpc”
],
”summary”: ”Lookup Fpc Products”,
”operationId”: ”Fpc_Lookup”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”productName”,
”in”: ”query”,
”description”: ”Product name. Length must be more than 3 characters.”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”modelId”,
”in”: ”query”,
”description”: ”Model Id. Optional.”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcShortProductInfoDto”
}
}
}
}
}
},
”/api/v2/fpc/products/pricing”: {
”get”: {
”tags”: [
”Fpc”
],
”summary”: ”Fpc Pricing”,
”operationId”: ”Fpc_Pricing”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”sku”,
”in”: ”query”,
”description”: ”Sku. Optional.”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”limit”,
”in”: ”query”,
”description”: ”Limit. 10 by default. 100 maximum.”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”integer”,
”name”: ”offset”,
”in”: ”query”,
”description”: ”Offset. 0 by default.”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”integer”,
”name”: ”returnPeriod”,
”in”: ”query”,
”description”: ”Return period. Optional.”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcProductPricesDto”
}
}
}
}
}
},
”/api/v2/fpc/configurations/data-fields”: {
”get”: {
”tags”: [
”Fpc”
],
”summary”: ”Get Fpc specific data fields”,
”operationId”: ”Fpc_DataFields”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Data Fields”,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcDataFieldConfigurationDto”
}
}
}
}
}
},
”/api/v2/languages”: {
”get”: {
”tags”: [
”Languages”
],
”summary”: ”Retrieves languages”,
”operationId”: ”Languages_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/LanguageFullInfoDto”
}
}
}
}
}
},
”/api/v2/locations”: {
”get”: {
”tags”: [
”Locations”
],
”summary”: ”Retrieves locations”,
”operationId”: ”Locations_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/LocationDto”
}
}
}
}
}
},
”/api/v2/tradeindevices/{tradeInDeviceId}/withhold”: {
”put”: {
”tags”: [
”TradeInDevices”
],
”summary”: ”Change TradeInItem Status to withheld”,
”operationId”: ”TradeInDevices_ChangeTradeInItemStatusToWithheld”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInDeviceId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Device Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
}
},
”/api/v2/users”: {
”get”: {
”tags”: [
”Users”
],
”summary”: ”Retrieves users”,
”operationId”: ”Users_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/GetVendorUserResponseDto”
}
}
}
}
}
},
”/api/v2/retail/campaigns/list”: {
”get”: {
”tags”: [
”Campaigns”
],
”summary”: ”Returns list of vendors campaigns”,
”operationId”: ”Campaigns_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”status”,
”in”: ”query”,
”description”: ”Campaign status (status code): Active (1), Expired(2), Upcoming(3)”,
”x-schema”: {
”$ref”: ”#/definitions/ApiCampaignStatus”
},
”x-nullable”: true,
”enum”: [
1,
2,
3
]
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/CampaignDto”
}
}
}
}
},
”/api/v2/retail/campaigns/details/{id}”: {
”get”: {
”tags”: [
”Campaigns”
],
”summary”: ”Returns campaign details”,
”operationId”: ”Campaigns_Details”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”path”,
”required”: true,
”description”: ”Campaign id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/CampaignDetailsDto”
}
}
}
}
},
”/api/v2/retail/campaigns/{id}/find”: {
”post”: {
”tags”: [
”Campaigns”
],
”summary”: ”Returns campaign offers”,
”operationId”: ”Campaigns_CampaignOffers”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”path”,
”required”: true,
”description”: ”Campaign id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”GetCampaignOffersDto”,
”schema”: {
”$ref”: ”#/definitions/GetCampaignOffersDto”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/CampaignOfferDto”
}
}
}
}
}
},
”/api/v2/retail/checkmend/certificate”: {
”post”: {
”tags”: [
”CheckMend”
],
”summary”: ”Gets certificate”,
”operationId”: ”CheckMend_Certificate”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/GetCertificate”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Price quote”,
”schema”: {
”$ref”: ”#/definitions/CertificateResponseDto”
}
}
}
}
},
”/api/v2/retail/checkmend/check”: {
”post”: {
”tags”: [
”CheckMend”
],
”summary”: ”Performs CheckMend query for a specific model”,
”operationId”: ”CheckMend_Check”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/GetCheckMendQueryCriteria”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Price quote”,
”schema”: {
”$ref”: ”#/definitions/CheckMendResponseDto”
}
}
}
}
},
”/api/v2/retail/configurations/data-fields”: {
”get”: {
”tags”: [
”Configurations”
],
”summary”: ”Get vendor specific data fields”,
”operationId”: ”Configurations_GetFields”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Data Fields”,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/DataFieldConfigurationDto”
}
}
}
}
}
},
”/api/v2/retail/duediligence/check”: {
”post”: {
”tags”: [
”DueDiligence”
],
”summary”: ”Performs all possible due diligence checks for a specific model.\nIf nothing required for the model, result will be null”,
”operationId”: ”DueDiligence_PerformCheck”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”query”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/GetDeviceCheckResultApi”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”string”
}
}
}
}
},
”/api/v2/retail/duediligence/report/{reportId}”: {
”get”: {
”tags”: [
”DueDiligence”
],
”summary”: ”Get report details”,
”operationId”: ”DueDiligence_Report”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”reportId”,
”in”: ”path”,
”required”: true,
”description”: ”Report id”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/DeviceCheckResponseDto”
}
}
}
}
},
”/api/v2/retail/itemgroups”: {
”get”: {
”tags”: [
”ItemGroups”
],
”operationId”: ”ItemGroups_Get”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/ItemGroupDto”
}
}
}
}
}
},
”/api/v2/retail/manufacturers”: {
”get”: {
”tags”: [
”Manufacturers”
],
”summary”: ”Retrieves manufacturers collection for a given tool”,
”operationId”: ”Manufacturers_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”itemGroupId”,
”in”: ”query”,
”description”: ”Optional. Item Group Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/ManufacturersListDto”
}
}
}
}
},
”/api/v2/retail/models/{id}”: {
”get”: {
”tags”: [
”Models”
],
”summary”: ”Retrieves model details”,
”operationId”: ”Models_Details”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”path”,
”required”: true,
”description”: ”Model Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/ModelDetailsApiDto”
}
}
}
}
},
”/api/v2/retail/models”: {
”get”: {
”tags”: [
”Models”
],
”summary”: ”Retrieves models collection for a given tool.”,
”operationId”: ”Models_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”itemGroupId”,
”in”: ”query”,
”description”: ”Optional. Item Group Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”manufacturerId”,
”in”: ”query”,
”description”: ”Optional. Manufacturer Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”term”,
”in”: ”query”,
”description”: ”Optional. Search term. Can be device identifier (IMEI, sn. etc), product name. Minimum length 2”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”limit”,
”in”: ”query”,
”description”: ”Optional. Number or results to return”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/ModelsListApiDto”
}
}
}
}
},
”/api/v2/retail/models/{id}/grading-form”: {
”get”: {
”tags”: [
”Models”
],
”summary”: ”Retrieves grading form for a given vendor, solution, tool and model”,
”operationId”: ”Models_GetForm”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”path”,
”required”: true,
”description”: ”Model Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”A matching grading form”,
”schema”: {
”$ref”: ”#/definitions/GradingFormDto”
}
}
}
}
},
”/api/v2/retail/models/verifymodel”: {
”get”: {
”tags”: [
”Models”
],
”summary”: ”Verifies device IMEI/Serial”,
”operationId”: ”Models_VerifyModel”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”deviceIdentifier”,
”in”: ”query”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”modelId”,
”in”: ”query”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/VerifyModelResultDto”
}
}
}
}
},
”/api/v2/retail/packages”: {
”post”: {
”tags”: [
”Packages”
],
”summary”: ”Create package”,
”operationId”: ”Packages_Create”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/CreatePackageApi”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Package Id”,
”schema”: {
”type”: ”integer”,
”format”: ”int32”
}
}
}
},
”get”: {
”tags”: [
”Packages”
],
”summary”: ”Packages list”,
”operationId”: ”Packages_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”List of packages”,
”schema”: {
”$ref”: ”#/definitions/PackagesListResponseModel”
}
}
}
}
},
”/api/v2/retail/packages/{packageId}”: {
”delete”: {
”tags”: [
”Packages”
],
”summary”: ”Cancel package”,
”operationId”: ”Packages_Cancel”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”packageId”,
”in”: ”path”,
”required”: true,
”description”: ”Package Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”agentId”,
”in”: ”query”,
”description”: ”Optional. Agent Id”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
},
”get”: {
”tags”: [
”Packages”
],
”summary”: ”Gets Package details”,
”operationId”: ”Packages_Details”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”packageId”,
”in”: ”path”,
”required”: true,
”description”: ”Package Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/PackageDetailsResponseModel”
}
}
}
}
},
”/api/v2/retail/packages/package-dimensions”: {
”get”: {
”tags”: [
”Packages”
],
”summary”: ”Package Dimensions list”,
”operationId”: ”Packages_PackageDimensionsList”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”List of all possible package dimensions”,
”schema”: {
”$ref”: ”#/definitions/PackageDimensionsListResponseModel”
}
}
}
}
},
”/api/v2/retail/packages/add-items”: {
”put”: {
”tags”: [
”Packages”
],
”summary”: ”Add Trade-in Items to an existing package”,
”operationId”: ”Packages_AddItems”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”parameters”: [
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/AddItemsApi”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
}
},
”/api/v2/retail/price-quote”: {
”get”: {
”tags”: [
”PriceQuote”
],
”summary”: ”Gets price quote by quote unique identifier”,
”operationId”: ”PriceQuote_GetPriceQuote”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”quoteId”,
”in”: ”query”,
”description”: ”Price Quote Guid”,
”format”: ”guid”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Price quote”,
”schema”: {
”$ref”: ”#/definitions/PriceQuoteResponseDto”
}
}
}
},
”post”: {
”tags”: [
”PriceQuote”
],
”summary”: ”Gets price quote for a given model”,
”operationId”: ”PriceQuote_GetQuote”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/PriceQuoteRequest”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Price quote”,
”schema”: {
”$ref”: ”#/definitions/PriceQuoteResponseDto”
}
}
}
}
},
”/api/v2/retail/price-quote/{priceQuoteId}/co2-emission”: {
”get”: {
”tags”: [
”PriceQuote”
],
”summary”: ”Gets co2 emission for price quote”,
”operationId”: ”PriceQuote_GetCo2Emission”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”priceQuoteId”,
”in”: ”path”,
”required”: true,
”description”: ”Price quote id”,
”format”: ”guid”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Co2 emission”,
”schema”: {
”$ref”: ”#/definitions/Co2EmissionResponseDto”
}
}
}
}
},
”/api/v2/retail/shipments”: {
”post”: {
”tags”: [
”Shipments”
],
”summary”: ”Creates new Shipment”,
”operationId”: ”Shipments_Create”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/CreateShipmentApi”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Shipment identifier”,
”schema”: {
”type”: ”integer”,
”format”: ”int32”
}
}
}
},
”get”: {
”tags”: [
”Shipments”
],
”summary”: ”Shipment list”,
”operationId”: ”Shipments_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”List of shipment”,
”schema”: {
”$ref”: ”#/definitions/ShipmentsListResponseModel”
}
}
}
}
},
”/api/v2/retail/shipments/{shipmentId}”: {
”delete”: {
”tags”: [
”Shipments”
],
”summary”: ”Cancels shipment”,
”operationId”: ”Shipments_Cancel”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”description”: ”Shipment Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”agentId”,
”in”: ”query”,
”description”: ”Optional. User id”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
},
”get”: {
”tags”: [
”Shipments”
],
”summary”: ”Gets Shipment details, including Packages and Trade-in devices in the Shipment”,
”operationId”: ”Shipments_Details”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”description”: ”Shipment Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Shipment devices”,
”schema”: {
”$ref”: ”#/definitions/ShipmentDetailsResponseModel”
}
}
}
},
”put”: {
”tags”: [
”Shipments”
],
”summary”: ”Allows user update shipment name and tracking number by shipment identifier”,
”operationId”: ”Shipments_Update”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”description”: ”Shipment Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/UpdateShipmentRequestModel”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
}
},
”/api/v2/retail/shipments/{shipmentId}/add-packages”: {
”post”: {
”tags”: [
”Shipments”
],
”summary”: ”Add Packages to an existing Shipment”,
”operationId”: ”Shipments_AddPackagesToExistingShipment”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”description”: ”Shipment Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/AddPackageRequestModel”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
}
},
”/api/v2/retail/shipments/{shipmentId}/label”: {
”post”: {
”tags”: [
”Shipments”
],
”summary”: ”Create Shipment Label”,
”operationId”: ”Shipments_CreateLabel”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”description”: ”Shipment Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/CreateShipmentLabelRequestModel”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/CreateShipmentLabelResponseModel”
}
}
}
},
”get”: {
”tags”: [
”Shipments”
],
”summary”: ”Download Shipment Label”,
”operationId”: ”Shipments_DownloadShipmentLabel”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”description”: ”Shipment Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Shipment Label File”,
”schema”: {
”type”: ”file”
}
}
}
},
”delete”: {
”tags”: [
”Shipments”
],
”summary”: ”Cancel Shipment Label”,
”operationId”: ”Shipments_CancelShipmentLabel”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”description”: ”Shipment Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”description”: ””
}
}
}
},
”/api/v2/retail/shipments/{shipmentId}/status/log”: {
”get”: {
”tags”: [
”Shipments”
],
”summary”: ”Get shipping status history”,
”operationId”: ”Shipments_GetShippingStatusHistory”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”shipmentId”,
”in”: ”path”,
”required”: true,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/ShippingStatusesDto”
}
}
}
}
},
”/api/v2/retail/shipments/tradein/{tradeInId}”: {
”post”: {
”tags”: [
”Shipments”
],
”summary”: ”Creates new package and shipment by TradeInId”,
”operationId”: ”Shipments_TradeIn”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”TradeIn Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”description”: ”Request data model”,
”schema”: {
”$ref”: ”#/definitions/CreateShipmentByTradeInModel”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/ShipmentAndPackageDto”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}/pdf”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets Trade-in PDF”,
”operationId”: ”TradeIns_DownloadTradeInPdf”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”accept-language”,
”x-originalName”: ”languageCode”,
”in”: ”header”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”file”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}/pdf/url”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets Trade-in PDF public url”,
”operationId”: ”TradeIns_GetUrlTradeInPdf”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”accept-language”,
”x-originalName”: ”languageCode”,
”in”: ”header”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/TradeInPdfInfoDto”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}/voucher/status”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets Trade-in voucher status”,
”operationId”: ”TradeIns_GetVoucherStatus”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/VoucherStatusDto”
}
}
}
},
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Change Trade-in voucher status”,
”operationId”: ”TradeIns_ChangeVoucherStatus”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”name”: ”request”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/UpdateVoucherStatusDto”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/UpdateVoucherStatusResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins”: {
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Registers new trade-in”,
”operationId”: ”TradeIns_Register”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”model”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/RegisterTradeInRequest”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/RegisterTradeInResponseDto”
}
}
}
},
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets Trade-ins list”,
”operationId”: ”TradeIns_List”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”query”,
”description”: ”Optional. Trade-in Id.”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”identifier”,
”in”: ”query”,
”description”: ”Optional. Trade-in device identifier (IMEI, serial).”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”limit”,
”in”: ”query”,
”description”: ”Optional. Number of trade-ins to fetch. Default is 500.”,
”format”: ”int32”,
”default”: 500,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”tradeInRef”,
”in”: ”query”,
”description”: ”Optional. Trade-in reference number.”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/TradeInListResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}”: {
”delete”: {
”tags”: [
”TradeIns”
],
”summary”: ”Cancel trade-in”,
”operationId”: ”TradeIns_Cancel”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”agentId”,
”in”: ”query”,
”description”: ”Optional. Agent Id.”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”integer”,
”format”: ”int32”
}
}
}
},
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets Trade-in details”,
”operationId”: ”TradeIns_Details”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/TradeInDetailsResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins/devices”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets list of all registered trade-in devices, optionally filtered by …”,
”operationId”: ”TradeIns_DevicesList”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”query”,
”description”: ”Optional. Trade-in device Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”limit”,
”in”: ”query”,
”description”: ”Optional. Number of records to fetch. Default 500”,
”format”: ”int32”,
”default”: 500,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”skip”,
”in”: ”query”,
”description”: ”Optional. Number of records to skip.”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”identifier”,
”in”: ”query”,
”description”: ”Optional. Trade-in device identifier (IMEI, serial)”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/TradeInDevicesListResponseModel”
}
}
}
}
},
”/api/v2/retail/tradeins/datafields”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets a list of custom data field values.”,
”operationId”: ”TradeIns_GetTradeInDataFieldsByTerm”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”term”,
”in”: ”query”,
”description”: ”Search term. Data field value”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”dataFieldId”,
”in”: ”query”,
”description”: ”Optional. Data field Id”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/GetTradeInDataFieldsResponseDto”
}
}
}
}
}
},
”/api/v2/retail/tradeins/datafields/validate”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Validate custom data field value.”,
”operationId”: ”TradeIns_ValidateTradeInDataField”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”value”,
”in”: ”query”,
”description”: ”Data field value”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”dataFieldId”,
”in”: ”query”,
”description”: ”Data field Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/ValidateTradeInDataFieldResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins/temp”: {
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Registers temp trade-in”,
”operationId”: ”TradeIns_RegisterTempTradeIn”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”command”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/RegisterTempTradeInRequest”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/RegisterTempTradeInResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins/temp/{tempTradeInId}”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Temp trade-in details”,
”operationId”: ”TradeIns_TempTradeInDetails”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tempTradeInId”,
”in”: ”path”,
”required”: true,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/TempTradeInDetailsResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins/confirm”: {
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Confirm temp trade-in”,
”operationId”: ”TradeIns_ConfirmTempTradeIn”,
”consumes”: [
”application/json-patch+json”,
”application/json”,
”text/json”,
”application/*+json”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”name”: ”command”,
”in”: ”body”,
”required”: true,
”schema”: {
”$ref”: ”#/definitions/ConfirmTempTradeInRequest”
},
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/RegisterTradeInResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins/temp/{tempTradeInId}/pdf”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets temp Trade-in PDF”,
”operationId”: ”TradeIns_DownloadTempTradeInPdf”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”tempTradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Temp Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”accept-language”,
”x-originalName”: ”languageCode”,
”in”: ”header”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”file”
}
}
}
}
},
”/api/v2/retail/tradeins/temp/{tempTradeInId}/pdf/url”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets temp Trade-in PDF public url”,
”operationId”: ”TradeIns_GetPublicUrlTempTradeInPdf”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tempTradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Temp Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”accept-language”,
”x-originalName”: ”languageCode”,
”in”: ”header”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/TempTradeInPdfInfoDto”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}/grading”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Get trade-in grading”,
”operationId”: ”TradeIns_GetTradeInGrading”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/GradingTradeInResponseDto”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}/shipments”: {
”get”: {
”tags”: [
”TradeIns”
],
”summary”: ”Gets Trade-in shipments”,
”operationId”: ”TradeIns_GetTradeInShipments”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/TradeInShipmentDto”
}
}
}
}
}
},
”/api/v2/retail/tradeins/signature/agent”: {
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Uploads agent signature before trade-in registration”,
”operationId”: ”TradeIns_UploadAgentSignature”,
”consumes”: [
”multipart/form-data”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”file”,
”name”: ”signature”,
”in”: ”formData”,
”description”: ”Agent signature. Suggested picture size is less then 700×300”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/Result”
}
}
}
}
},
”/api/v2/retail/tradeins/signature/client”: {
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Uploads client signature before trade-in registration”,
”operationId”: ”TradeIns_UploadClientSignature”,
”consumes”: [
”multipart/form-data”
],
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”file”,
”name”: ”signature”,
”in”: ”formData”,
”description”: ”Client signature. Suggested picture size is less then 700×300”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/Result”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}/signature/agent”: {
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Uploads agent signature after trade-in registration”,
”operationId”: ”TradeIns_UploadAgentSignature2”,
”consumes”: [
”multipart/form-data”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”file”,
”name”: ”signature”,
”in”: ”formData”,
”description”: ”Agent signature. Suggested picture size is less then 700×300”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: true,
”description”: ””,
”schema”: {
”type”: ”file”
}
}
}
},
”delete”: {
”tags”: [
”TradeIns”
],
”summary”: ”Removes agent signature from trade-in”,
”operationId”: ”TradeIns_RemoveAgentSignature”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: true,
”description”: ””,
”schema”: {
”type”: ”file”
}
}
}
}
},
”/api/v2/retail/tradeins/{tradeInId}/signature/client”: {
”post”: {
”tags”: [
”TradeIns”
],
”summary”: ”Uploads client signature after trade-in registration”,
”operationId”: ”TradeIns_UploadClientSignature2”,
”consumes”: [
”multipart/form-data”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”file”,
”name”: ”signature”,
”in”: ”formData”,
”description”: ”Client signature. Suggested picture size is less then 700×300”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: true,
”description”: ””,
”schema”: {
”type”: ”file”
}
}
}
},
”delete”: {
”tags”: [
”TradeIns”
],
”summary”: ”Removes client signature from trade-in”,
”operationId”: ”TradeIns_RemoveClientSignature”,
”parameters”: [
{
”type”: ”integer”,
”name”: ”tradeInId”,
”in”: ”path”,
”required”: true,
”description”: ”Trade-in Id”,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: true,
”description”: ””,
”schema”: {
”type”: ”file”
}
}
}
}
},
”/api/v2/b2b/configurations/data-fields”: {
”get”: {
”tags”: [
”Configurations”
],
”summary”: ”Retrieves custom data fields collection for a given tool”,
”operationId”: ”Configurations_DataFields”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Data fields collection”,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/VendorB2BToolDataFieldDto”
}
}
}
}
}
},
”/api/v2/b2b/itemgroups”: {
”get”: {
”tags”: [
”ItemGroups”
],
”summary”: ”Retrieves item groups collection for a B2b tool”,
”operationId”: ”ItemGroups_Get2”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Item groups collection”,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/VendorB2BToolItemGroupItemDto”
}
}
}
}
}
},
”/api/v2/b2b/manufacturers”: {
”get”: {
”tags”: [
”Manufacturers”
],
”summary”: ”Retrieves item groups collection for a given tool”,
”operationId”: ”Manufacturers_Get”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”itemGroupId”,
”in”: ”query”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Item groups collection”,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/ManufacturerDto”
}
}
}
}
}
},
”/api/v2/b2b/models”: {
”get”: {
”tags”: [
”Models”
],
”summary”: ”Retrieves item groups collection for a given tool”,
”operationId”: ”Models_Query”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”term”,
”in”: ”query”,
”default”: ””,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”itemGroupId”,
”in”: ”query”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”manufacturerId”,
”in”: ”query”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Item groups collection”,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/ModelInfoDto”
}
}
}
}
}
},
”/api/v2/b2b/pricelist”: {
”get”: {
”tags”: [
”PriceList”
],
”summary”: ”Retrieves item groups collection for a given tool”,
”operationId”: ”PriceList_Query”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”term”,
”in”: ”query”,
”default”: ””,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”itemGroupId”,
”in”: ”query”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”integer”,
”name”: ”manufacturerId”,
”in”: ”query”,
”format”: ”int32”,
”x-nullable”: true
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ”Item groups collection”,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/PriceListItemDto”
}
}
}
}
}
},
”/api/v2/b2b/quotes/{id}”: {
”get”: {
”tags”: [
”Quote”
],
”operationId”: ”Quote_GetQuoteApi”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”path”,
”required”: true,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”$ref”: ”#/definitions/GetQuoteApiDto”
}
}
}
}
},
”/api/v2/b2b/quotes/{id}/items”: {
”get”: {
”tags”: [
”Quote”
],
”operationId”: ”Quote_GetQuoteLinesApi”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”integer”,
”name”: ”id”,
”in”: ”path”,
”required”: true,
”format”: ”int32”,
”x-nullable”: false
},
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/GetQuoteLineApiDto”
}
}
}
}
}
},
”/api/v2/b2b/quotes/statuses”: {
”get”: {
”tags”: [
”Quote”
],
”operationId”: ”Quote_GetQuoteStatusesApi”,
”produces”: [
”text/plain”,
”application/json”,
”text/json”
],
”parameters”: [
{
”type”: ”string”,
”name”: ”api-version”,
”in”: ”query”,
”default”: ”2.0”,
”x-nullable”: true
},
{
”name”: ”accept-language”,
”in”: ”header”,
”description”: ”Override language (iso2 code). Either ’en’ or default vendor language.”,
”default”: ”en-US”
}
],
”responses”: {
”200”: {
”x-nullable”: false,
”description”: ””,
”schema”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/GetQuoteStatusesApiDto”
}
}
}
}
}
}
},
”definitions”: {
”RegisterFpcTransactionApiResponseDto”: {
”type”: ”object”,
”required”: [
”FpcTransactionId”
],
”properties”: {
”FpcTransactionId”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”RegisterFpcTransactionApiRequestDto”: {
”type”: ”object”,
”required”: [
”ReturnPeriod”,
”CartTotal”
],
”properties”: {
”Products”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcTransactionProductSkuDto”
}
},
”ReturnPeriod”: {
”type”: ”integer”,
”format”: ”int32”
},
”CartTotal”: {
”type”: ”number”,
”format”: ”decimal”
},
”DataFields”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcTransactionApiRequestDataFieldDto”
}
}
}
},
”FpcTransactionProductSkuDto”: {
”type”: ”object”,
”required”: [
”Quantity”
],
”properties”: {
”Sku”: {
”type”: ”string”,
”description”: ”SKU”
},
”Quantity”: {
”type”: ”integer”,
”description”: ”> 0”,
”format”: ”int32”
}
}
},
”FpcTransactionApiRequestDataFieldDto”: {
”type”: ”object”,
”description”: ”Custom data field submitted result”,
”required”: [
”DataFieldId”
],
”properties”: {
”DataFieldId”: {
”type”: ”integer”,
”description”: ”Gets or sets data field id”,
”format”: ”int32”
},
”DataFieldValue”: {
”type”: ”string”,
”description”: ”Gets or sets data field value (literal, boolean value or list option id)”
}
}
},
”CalculateShoppingCartResponseDto”: {
”type”: ”object”,
”required”: [
”CartTotal”
],
”properties”: {
”CartTotal”: {
”type”: ”number”,
”format”: ”decimal”
},
”CartCalculations”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/CartCalculationsDto”
}
}
}
},
”CartCalculationsDto”: {
”type”: ”object”,
”required”: [
”ReturnPeriod”,
”MonthlyPayment”,
”LoanPeriod”
],
”properties”: {
”ReturnPeriod”: {
”type”: ”integer”,
”format”: ”int32”
},
”MonthlyPayment”: {
”type”: ”number”,
”format”: ”decimal”
},
”LoanPeriod”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”CalculateShoppingCartRequestDto”: {
”type”: ”object”,
”required”: [
”CartTotal”
],
”properties”: {
”CartTotal”: {
”type”: ”number”,
”format”: ”decimal”
},
”Devices”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/DeviceIdentifiersDto”
}
}
}
},
”DeviceIdentifiersDto”: {
”type”: ”object”,
”properties”: {
”Sku”: {
”type”: ”string”
}
}
},
”UpdateFpcTransactionProducts”: {
”type”: ”object”,
”required”: [
”FpcTransactionId”
],
”properties”: {
”FpcTransactionId”: {
”type”: ”integer”,
”format”: ”int32”
},
”Products”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcTransactionProductDto”
}
}
}
},
”FpcTransactionProductDto”: {
”type”: ”object”,
”required”: [
”PartnerProductId”
],
”properties”: {
”PartnerProductId”: {
”type”: ”integer”,
”format”: ”int32”
},
”Identifier”: {
”type”: ”string”
}
}
},
”ResidualPriceResponseDto”: {
”type”: ”object”,
”required”: [
”Price”
],
”properties”: {
”Sku”: {
”type”: ”string”
},
”Price”: {
”type”: ”number”,
”format”: ”decimal”
},
”ResidualPrices”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/ResidualValueDto”
}
}
}
},
”ResidualValueDto”: {
”type”: ”object”,
”required”: [
”ReturnPeriod”,
”Value”
],
”properties”: {
”ReturnPeriod”: {
”type”: ”integer”,
”format”: ”int32”
},
”Value”: {
”type”: ”number”,
”format”: ”decimal”
}
}
},
”FpcShortProductInfoDto”: {
”type”: ”object”,
”required”: [
”ProductId”
],
”properties”: {
”Sku”: {
”type”: ”string”
},
”ProductId”: {
”type”: ”integer”,
”format”: ”int32”
},
”ProductName”: {
”type”: ”string”
},
”ModelId”: {
”type”: ”integer”,
”format”: ”int32”
},
”ProductType”: {
”type”: ”string”
}
}
},
”FpcProductPricesDto”: {
”type”: ”object”,
”required”: [
”ProductPrice”
],
”properties”: {
”Sku”: {
”type”: ”string”
},
”ProductPrice”: {
”type”: ”number”,
”format”: ”decimal”
},
”PeriodPrices”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/FpcProductPeriodDto”
}
}
}
},
”FpcProductPeriodDto”: {
”type”: ”object”,
”required”: [
”ReturnPeriod”,
”TotalPeriod”,
”MonthlyPayment”
],
”properties”: {
”ReturnPeriod”: {
”type”: ”integer”,
”format”: ”int32”
},
”TotalPeriod”: {
”type”: ”integer”,
”format”: ”int32”
},
”MonthlyPayment”: {
”type”: ”number”,
”format”: ”decimal”
}
}
},
”FpcDataFieldConfigurationDto”: {
”type”: ”object”,
”description”: ”Fpc Data Field Configuration”,
”required”: [
”IsRequired”,
”IsActive”,
”SortOrder”,
”DataFieldId”,
”HasEncryption”,
”IsGdprCompliant”
],
”properties”: {
”IsRequired”: {
”type”: ”boolean”,
”description”: ”Gets or sets if this data field is required.”
},
”IsActive”: {
”type”: ”boolean”,
”description”: ”Gets or sets if this data field is active.”
},
”Label”: {
”type”: ”string”,
”description”: ”Gets or sets the data field label.”
},
”SortOrder”: {
”type”: ”integer”,
”description”: ”Gets or sets the data field’s sort order.”,
”format”: ”int32”
},
”DataFieldId”: {
”type”: ”integer”,
”description”: ”Gets or sets the data field unique identifier.”,
”format”: ”int32”
},
”DataFieldName”: {
”type”: ”string”,
”description”: ”Gets or sets the data field name.”
},
”DataFieldType”: {
”type”: ”string”,
”description”: ”Gets or sets the data field type.”
},
”HasEncryption”: {
”type”: ”boolean”,
”description”: ”Gets or sets if this data field has encryption.”
},
”IsGdprCompliant”: {
”type”: ”boolean”,
”description”: ”Gets or sets if this data field is Gdpr compliant.”
},
”ListOptions”: {
”type”: ”array”,
”description”: ”Gets or sets the data field list options collection (only for the data fields of type list).”,
”items”: {
”$ref”: ”#/definitions/DataFieldListOptionDto”
}
}
}
},
”DataFieldListOptionDto”: {
”type”: ”object”,
”description”: ”Custom Data Field List Option”,
”required”: [
”Id”,
”Position”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Gets or sets the unique identifier to this option.”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Gets or sets the option’s name.”
},
”Position”: {
”type”: ”integer”,
”description”: ”Gets or sets the option’s position in the list.”,
”format”: ”int32”
}
}
},
”LanguageFullInfoDto”: {
”type”: ”object”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Code”: {
”type”: ”string”
},
”Name”: {
”type”: ”string”
},
”IsoCode”: {
”type”: ”string”
}
}
},
”LocationDto”: {
”type”: ”object”,
”required”: [
”Id”,
”IsActive”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”
},
”IsActive”: {
”type”: ”boolean”
},
”Address”: {
”$ref”: ”#/definitions/AddressModelDto”
}
}
},
”AddressModelDto”: {
”type”: ”object”,
”properties”: {
”Address”: {
”type”: ”string”
},
”City”: {
”type”: ”string”
},
”CountryCode”: {
”type”: ”string”
},
”CountryName”: {
”type”: ”string”
},
”PostalCode”: {
”type”: ”string”
},
”Region”: {
”type”: ”string”
}
}
},
”GetVendorUserResponseDto”: {
”type”: ”object”,
”required”: [
”IsActive”
],
”properties”: {
”UserId”: {
”type”: ”string”
},
”UserName”: {
”type”: ”string”
},
”FirstName”: {
”type”: ”string”
},
”LastName”: {
”type”: ”string”
},
”PhoneNumber”: {
”type”: ”string”
},
”Email”: {
”type”: ”string”
},
”CreateDate”: {
”type”: ”string”,
”format”: ”date-time”
},
”Locations”: {
”type”: ”array”,
”items”: {
”type”: ”string”
}
},
”LocationIds”: {
”type”: ”array”,
”items”: {
”type”: ”integer”,
”format”: ”int32”
}
},
”UserExternalReference”: {
”type”: ”string”
},
”IsActive”: {
”type”: ”boolean”
}
}
},
”CampaignDto”: {
”type”: ”object”,
”properties”: {
”Data”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/CampaignItemDto”
}
}
}
},
”CampaignItemDto”: {
”type”: ”object”,
”required”: [
”Id”,
”ActiveFrom”,
”ActiveTo”,
”OverrideVendorTC”,
”HasFmipDeduction”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”
},
”ActiveFrom”: {
”type”: ”string”,
”format”: ”date-time”
},
”ActiveTo”: {
”type”: ”string”,
”format”: ”date-time”
},
”Description”: {
”type”: ”string”
},
”OverrideVendorTC”: {
”type”: ”boolean”
},
”TermsAndConditions”: {
”type”: ”string”
},
”PromoCode”: {
”type”: ”string”
},
”HasFmipDeduction”: {
”type”: ”boolean”
},
”MaxDevicesPerTradeIn”: {
”type”: ”integer”,
”format”: ”int32”
},
”MaxTadeInValue”: {
”type”: ”number”,
”format”: ”decimal”
},
”Status”: {
”type”: ”string”
},
”Strategy”: {
”type”: ”string”
}
}
},
”ApiCampaignStatus”: {
”type”: ”integer”,
”description”: ”1 = Active\n2 = Expired\n3 = Upcoming”,
”x-enumNames”: [
”Active”,
”Expired”,
”Upcoming”
],
”enum”: [
1,
2,
3
]
},
”CampaignDetailsDto”: {
”allOf”: [
{
”$ref”: ”#/definitions/CampaignItemDto”
},
{
”type”: ”object”,
”properties”: {
”DataFields”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/DataFieldConfigurationDto”
}
},
”Offers”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/CampaignOfferDto”
}
}
}
}
]
},
”DataFieldConfigurationDto”: {
”type”: ”object”,
”description”: ”Custom Data Field Configuration”,
”required”: [
”IsRequired”,
”IsVisible”,
”SortOrder”,
”DataFieldId”,
”IsCampaignField”
],
”properties”: {
”IsRequired”: {
”type”: ”boolean”,
”description”: ”Gets or sets if this data field is required.”
},
”IsVisible”: {
”type”: ”boolean”,
”description”: ”Gets or sets if this data field is visible in the UI.”
},
”Scope”: {
”type”: ”string”,
”description”: ”Gets or sets if this data field is corporate visible or private visible.”
},
”Label”: {
”type”: ”string”,
”description”: ”Gets or sets the data field label.”
},
”SortOrder”: {
”type”: ”integer”,
”description”: ”Gets or sets the data field’s sort order.”,
”format”: ”int32”
},
”DataFieldId”: {
”type”: ”integer”,
”description”: ”Gets or sets the data field unique identifier.”,
”format”: ”int32”
},
”DataFieldName”: {
”type”: ”string”,
”description”: ”Gets or sets the data field name.”
},
”DataFieldTemplateType”: {
”type”: ”string”,
”description”: ”Gets or sets the data field UI template type.”
},
”DataFieldType”: {
”type”: ”string”,
”description”: ”Gets or sets the data field type.”
},
”IsCampaignField”: {
”type”: ”boolean”,
”description”: ”Gets or sets if this data field is associated to campaign on not.”
},
”ListOptions”: {
”type”: ”array”,
”description”: ”Gets or sets the data field list options collection (only for the data fields of type list).”,
”items”: {
”$ref”: ”#/definitions/DataFieldListOptionDto”
}
}
}
},
”CampaignOfferDto”: {
”type”: ”object”,
”required”: [
”Amount”,
”Priority”
],
”properties”: {
”ItemVariantId”: {
”type”: ”integer”,
”format”: ”int32”
},
”ManufacturerId”: {
”type”: ”integer”,
”format”: ”int32”
},
”ItemGroupId”: {
”type”: ”integer”,
”format”: ”int32”
},
”Amount”: {
”type”: ”number”,
”format”: ”decimal”
},
”OfferCode”: {
”type”: ”string”
},
”AdjustmentType”: {
”type”: ”string”
},
”Grade”: {
”type”: ”string”
},
”OfferType”: {
”type”: ”string”
},
”Priority”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”GetCampaignOffersDto”: {
”type”: ”object”,
”properties”: {
”ManufacturerId”: {
”type”: ”integer”,
”format”: ”int32”
},
”ItemGroupId”: {
”type”: ”integer”,
”format”: ”int32”
},
”ItemVariantId”: {
”type”: ”integer”,
”format”: ”int32”
},
”Grade”: {
”type”: ”string”
}
}
},
”CertificateResponseDto”: {
”type”: ”object”,
”required”: [
”StatusCode”
],
”properties”: {
”StatusCode”: {
”type”: ”integer”,
”format”: ”int32”
},
”Reason”: {
”type”: ”string”
},
”Message”: {
”type”: ”string”
}
}
},
”GetCertificate”: {
”type”: ”object”,
”properties”: {
”CertId”: {
”type”: ”string”
},
”Url”: {
”type”: ”string”
},
”Email”: {
”type”: ”string”
},
”Provider”: {
”type”: ”string”
}
}
},
”CheckMendResponseDto”: {
”type”: ”object”,
”properties”: {
”FraudCheckResults”: {
”type”: ”array”,
”description”: ”Fraud check results collection\n ”,
”items”: {
”$ref”: ”#/definitions/FraudCheckResult”
}
},
”FmipCheckResults”: {
”type”: ”array”,
”description”: ”Fmip check results collection\n ”,
”items”: {
”$ref”: ”#/definitions/FraudCheckResult”
}
}
}
},
”FraudCheckResult”: {
”type”: ”object”,
”description”: ”Fraud check query result”,
”required”: [
”ResultId”,
”Timestamp”
],
”properties”: {
”Provider”: {
”type”: ”string”,
”description”: ”Gets or sets provider name”
},
”CertId”: {
”type”: ”string”,
”description”: ”Gets or sets providers certificate id”
},
”Result”: {
”type”: ”string”,
”description”: ”Gets or sets provider query result”
},
”ResultId”: {
”type”: ”integer”,
”description”: ”Provider query result Id”,
”format”: ”int32”
},
”Timestamp”: {
”type”: ”string”,
”description”: ”Gets or sets Provider query timestamp”,
”format”: ”date-time”
}
}
},
”GetCheckMendQueryCriteria”: {
”type”: ”object”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”ItemIdentifier”: {
”type”: ”string”
}
}
},
”GetDeviceCheckResultApi”: {
”type”: ”object”,
”description”: ”Due Diligence query for a specific model”,
”required”: [
”ModelId”
],
”properties”: {
”ModelId”: {
”type”: ”integer”,
”description”: ”Model id”,
”format”: ”int32”
},
”ItemIdentifier”: {
”type”: ”string”,
”description”: ”Item identifier”
}
}
},
”DeviceCheckResponseDto”: {
”type”: ”object”,
”properties”: {
”FraudCheckResults”: {
”type”: ”array”,
”description”: ”Fraud check results collection\n ”,
”items”: {
”$ref”: ”#/definitions/FraudCheckResult2”
}
},
”FmipCheckResults”: {
”type”: ”array”,
”description”: ”Fmip check results collection\n ”,
”items”: {
”$ref”: ”#/definitions/FraudCheckResult2”
}
}
}
},
”FraudCheckResult2”: {
”type”: ”object”,
”description”: ”Fraud check query result”,
”required”: [
”ResultId”,
”Timestamp”
],
”properties”: {
”Provider”: {
”type”: ”string”,
”description”: ”Gets or sets provider name”
},
”CertId”: {
”type”: ”string”,
”description”: ”Gets or sets providers certificate id”
},
”Result”: {
”type”: ”string”,
”description”: ”Gets or sets provider query result”
},
”ResultId”: {
”type”: ”integer”,
”description”: ”Provider query result Id”,
”format”: ”int32”
},
”Timestamp”: {
”type”: ”string”,
”description”: ”Gets or sets Provider query timestamp”,
”format”: ”date-time”
}
}
},
”ItemGroupDto”: {
”type”: ”object”,
”description”: ”Item group”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Gets or sets the unique identifier for the item group.”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Gets or sets the name for the item group.”
}
}
},
”ManufacturersListDto”: {
”type”: ”object”,
”description”: ”Manufacturers list response data model\n ”,
”properties”: {
”Data”: {
”type”: ”array”,
”description”: ”List of Manufacturers\n ”,
”items”: {
”$ref”: ”#/definitions/ManufacturerDto”
}
}
}
},
”ManufacturerDto”: {
”type”: ”object”,
”description”: ”Trade-in data model\n ”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Manufacturer Id\n ”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Manufacturer name\n ”
},
”ImageUrl”: {
”type”: ”string”,
”description”: ”Manufacturer Image Url\n ”
}
}
},
”ModelDetailsApiDto”: {
”type”: ”object”,
”description”: ”Model details response data model\n ”,
”required”: [
”Id”,
”ItemVariantType”,
”IsCustomConfig”,
”ItemGroupId”,
”ManufacturerId”,
”ItemId”,
”ExchangeRate”,
”LastModified”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Model Id\n ”,
”format”: ”int32”
},
”ItemVariantType”: {
”description”: ”Model item variant type. 1 – Simple, 2 – Configurable\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/ItemVariantType”
}
]
},
”IsCustomConfig”: {
”type”: ”boolean”,
”description”: ”Indicates if model is a custom config model.\n ”
},
”ItemGroupId”: {
”type”: ”integer”,
”description”: ”Item Group Id\n ”,
”format”: ”int32”
},
”ManufacturerId”: {
”type”: ”integer”,
”description”: ”Manufacturer Id\n ”,
”format”: ”int32”
},
”ManufacturerName”: {
”type”: ”string”,
”description”: ”Manufacturer name\n ”
},
”ItemId”: {
”type”: ”integer”,
”description”: ”Model Item Id\n ”,
”format”: ”int32”
},
”ItemName”: {
”type”: ”string”,
”description”: ”Item name\n ”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name\n ”
},
”ProductCode”: {
”type”: ”string”,
”description”: ”Product code\n ”
},
”ProductNameShort”: {
”type”: ”string”,
”description”: ”Product name, without configuration details\n ”
},
”Price”: {
”type”: ”number”,
”description”: ”Model price list price\n ”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency ISO 4217 code\n ”
},
”CurrencySymbol”: {
”type”: ”string”,
”description”: ”CurrencySymbol”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Currency exchange rate\n ”,
”format”: ”decimal”
},
”PictureUrl”: {
”type”: ”string”,
”description”: ”Model picture URL\n ”
},
”LastModified”: {
”type”: ”string”,
”description”: ”Date when model data was last modified\n ”,
”format”: ”date-time”
}
}
},
”ItemVariantType”: {
”type”: ”integer”,
”description”: ”1 = SimpleItemVariant\n2 = ConfigurableItemVariant”,
”x-enumNames”: [
”SimpleItemVariant”,
”ConfigurableItemVariant”
],
”enum”: [
1,
2
]
},
”ModelsListApiDto”: {
”type”: ”object”,
”description”: ”Models list response data model\n ”,
”properties”: {
”Data”: {
”type”: ”array”,
”description”: ”An array of models\n ”,
”items”: {
”$ref”: ”#/definitions/ModelInfoDto”
}
}
}
},
”ModelInfoDto”: {
”type”: ”object”,
”required”: [
”Id”,
”ItemVariantType”,
”ItemId”,
”ItemGroupId”,
”ManufacturerId”,
”ExchangeRate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Model Id\n ”,
”format”: ”int32”
},
”ItemVariantType”: {
”description”: ”Model item variant type. 1 – Simple, 2 – Configurable\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/ItemVariantType”
}
]
},
”ItemId”: {
”type”: ”integer”,
”description”: ”Model Item Id\n ”,
”format”: ”int32”
},
”ItemName”: {
”type”: ”string”,
”description”: ”Item name\n ”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name\n ”
},
”ProductCode”: {
”type”: ”string”,
”description”: ”Product code\n ”
},
”ProductNameShort”: {
”type”: ”string”,
”description”: ”Product name, without configuration details\n ”
},
”ItemGroupId”: {
”type”: ”integer”,
”description”: ”Item Group Id\n ”,
”format”: ”int32”
},
”ManufacturerId”: {
”type”: ”integer”,
”description”: ”Manufacturer Id\n ”,
”format”: ”int32”
},
”Price”: {
”type”: ”number”,
”description”: ”Model price list price\n ”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency ISO 4217 code\n ”
},
”CurrencySymbol”: {
”type”: ”string”,
”description”: ”CurrencySymbol”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Currency exchange rate\n ”,
”format”: ”decimal”
},
”PictureUrl”: {
”type”: ”string”,
”description”: ”Model picture URL\n ”
}
}
},
”GradingFormDto”: {
”type”: ”object”,
”description”: ”Grading form\n ”,
”required”: [
”Id”,
”ScoringType”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Gets or sets grading form id\n ”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Gets or sets the name of the grading form\n ”
},
”Questions”: {
”type”: ”array”,
”description”: ”Gets or set the grading form’s questions collection\n ”,
”items”: {
”$ref”: ”#/definitions/GradingFormQuestionDto”
}
},
”Extras”: {
”type”: ”array”,
”description”: ”Gets or set the grading form’s extras collection\n ”,
”items”: {
”$ref”: ”#/definitions/GradingFormExtraAnswerDto”
}
},
”SystemExtras”: {
”type”: ”array”,
”description”: ”Gets or set the grading form’s system extras collection\n ”,
”items”: {
”$ref”: ”#/definitions/GradingFormSystemExtraAnswerDto”
}
},
”ScoringType”: {
”description”: ”Gets or set the scoring strategy type of the grading form\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/GradingFormScoringStrategyType”
}
]
}
}
},
”GradingFormQuestionDto”: {
”type”: ”object”,
”description”: ”Grading form question\n ”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Grading form question ID\n ”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Gets or sets question’s name\n ”
},
”Label”: {
”type”: ”string”,
”description”: ”Gets or sets question’s label\n ”
},
”Info”: {
”type”: ”string”,
”description”: ”Gets or sets question’s info\n ”
},
”InfoCards”: {
”type”: ”array”,
”description”: ”Gets or sets question’s info cards\n ”,
”items”: {
”$ref”: ”#/definitions/InfoCardBlankDto”
}
},
”Answers”: {
”type”: ”array”,
”description”: ”Gets or sets answers collection for this question\n ”,
”items”: {
”$ref”: ”#/definitions/GradingFormAnswerDto”
}
}
}
},
”InfoCardBlankDto”: {
”type”: ”object”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Label”: {
”type”: ”string”
},
”Text”: {
”type”: ”string”
},
”Images”: {
”type”: ”array”,
”items”: {
”type”: ”string”
}
}
}
},
”GradingFormAnswerDto”: {
”type”: ”object”,
”description”: ”Grading form answer\n ”,
”required”: [
”Id”,
”Score”,
”IsVendorSelected”,
”IsPartnerSelected”,
”IsAffiliateSelected”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Gets or sets answer’s unique identifier\n ”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Gets or sets answer’s name\n ”
},
”Score”: {
”type”: ”integer”,
”description”: ”Gets or sets answer’s score\n ”,
”format”: ”int32”
},
”InfoCards”: {
”type”: ”array”,
”description”: ”Gets or sets answer’s info cards\n ”,
”items”: {
”$ref”: ”#/definitions/InfoCardBlankDto”
}
},
”IsVendorSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if answer was selected by the vendor\n ”
},
”IsPartnerSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if answer was selected by the partner\n ”
},
”IsAffiliateSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if answer was selected by the affiliate\n ”
}
}
},
”GradingFormExtraAnswerDto”: {
”type”: ”object”,
”description”: ”Grading form extra answer\n ”,
”required”: [
”Id”,
”Type”,
”IsVendorSelected”,
”IsPartnerSelected”,
”IsAffiliateSelected”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Gets or sets extra’s unique identifier\n ”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Gets or sets extra’s name\n ”
},
”Type”: {
”description”: ”Gets or sets extra’s type\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/GradingFormExtraType”
}
]
},
”Info”: {
”type”: ”string”,
”description”: ”Gets or sets extra’s info\n ”
},
”IsVendorSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if extra was selected by the vendor\n ”
},
”IsPartnerSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if extra was selected by the partner\n ”
},
”IsAffiliateSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if extra was selected by the affiliate\n ”
}
}
},
”GradingFormExtraType”: {
”type”: ”integer”,
”description”: ”1 = User”,
”x-enumNames”: [
”User”
],
”enum”: [
1
]
},
”GradingFormSystemExtraAnswerDto”: {
”type”: ”object”,
”description”: ”Grading form system extra answer\n ”,
”required”: [
”Id”,
”IsVendorSelected”,
”IsPartnerSelected”,
”IsAffiliateSelected”
],
”properties”: {
”Id”: {
”description”: ”Gets or sets system extra’s type\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/GradingFormSystemExtraType”
}
]
},
”IsVendorSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if system extra was selected by the vendor\n ”
},
”IsPartnerSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if system extra was selected by the partner\n ”
},
”IsAffiliateSelected”: {
”type”: ”boolean”,
”description”: ”Gets or sets if system extra was selected by the affiliate\n ”
}
}
},
”GradingFormSystemExtraType”: {
”type”: ”integer”,
”description”: ”1 = IsFmipOn”,
”x-enumNames”: [
”IsFmipOn”
],
”enum”: [
1
]
},
”GradingFormScoringStrategyType”: {
”type”: ”integer”,
”description”: ”1 = Sum\n2 = Minimum”,
”x-enumNames”: [
”Sum”,
”Minimum”
],
”enum”: [
1,
2
]
},
”VerifyModelResultDto”: {
”type”: ”object”,
”properties”: {
”AlternativeModels”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/AlternativeModelDto”
}
},
”Errors”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/VerifyModelErrorDto”
}
},
”ValidityStatus”: {
”type”: ”string”
}
}
},
”AlternativeModelDto”: {
”type”: ”object”,
”required”: [
”ModelId”
],
”properties”: {
”ModelId”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”VerifyModelErrorDto”: {
”type”: ”object”,
”properties”: {
”ErrorCode”: {
”type”: ”string”
},
”ErrorMessage”: {
”type”: ”string”
}
}
},
”CreatePackageApi”: {
”type”: ”object”,
”required”: [
”PackageDimensionId”
],
”properties”: {
”Name”: {
”type”: ”string”,
”description”: ”Package name”
},
”Identifier”: {
”type”: ”string”,
”description”: ”Unique Package identifier. If not value is provided, auto-generated value is used.”
},
”PackageDimensionId”: {
”type”: ”integer”,
”description”: ”Package size Id”,
”format”: ”int32”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id. If no value is provided, default User associated with the API key will be used.”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id. If no value is provided, default Location associated with the API key will be used.”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”TradeInDeviceIds”: {
”type”: ”array”,
”description”: ”An array of Trade-in device Ids in the Package”,
”items”: {
”type”: ”integer”,
”format”: ”int32”
}
}
}
},
”PackageDetailsResponseModel”: {
”type”: ”object”,
”description”: ”Package details response data model”,
”required”: [
”Id”,
”LocationId”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Package Id”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Package name”
},
”Identifier”: {
”type”: ”string”,
”description”: ”Unique Package identifier”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”AgentName”: {
”type”: ”string”,
”description”: ”Agent name”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Package creation date”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Package status”
},
”Content”: {
”type”: ”array”,
”description”: ”An array of Trade-in devices in the Package”,
”items”: {
”$ref”: ”#/definitions/PackageContentModel”
}
},
”ShipmentId”: {
”type”: ”integer”,
”description”: ”Shipment Id”,
”format”: ”int32”
},
”ShipmentStatus”: {
”type”: ”string”,
”description”: ”Shipment status”
}
}
},
”PackageContentModel”: {
”type”: ”object”,
”description”: ”Package content data model”,
”required”: [
”TradeInDeviceId”,
”Price”,
”ExchangeRate”,
”TradeInId”,
”TradeInDate”
],
”properties”: {
”TradeInDeviceId”: {
”type”: ”integer”,
”description”: ”Trade-in device Id”,
”format”: ”int32”
},
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device unique identifier (e.g IMEI, serial number)”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name”
},
”Grade”: {
”type”: ”string”,
”description”: ”Trade-in device grade”
},
”Price”: {
”type”: ”number”,
”description”: ”Trade-in device price”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”CurrencySymbol”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”Status”: {
”type”: ”string”,
”description”: ”Trade-in device status”
},
”TradeInId”: {
”type”: ”integer”,
”description”: ”Trade-in Id”,
”format”: ”int32”
},
”TradeInDate”: {
”type”: ”string”,
”description”: ”Trade-in registration date”,
”format”: ”date-time”
},
”AgentName”: {
”type”: ”string”,
”description”: ”User name, who registered the Trade-in”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id, where the Trade-in was registered”,
”format”: ”int32”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name, where the Trade-in was registered”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example, a cash register receipt number, contract number etc.\nCan be empty.”
}
}
},
”PackagesListResponseModel”: {
”type”: ”object”,
”description”: ”Package list data model”,
”properties”: {
”Data”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/PackageModel”
}
}
}
},
”PackageModel”: {
”type”: ”object”,
”description”: ”Package data model”,
”required”: [
”Id”,
”LocationId”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Package Id”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Package name”
},
”Identifier”: {
”type”: ”string”,
”description”: ”Package identifier.”
},
”DeviceQty”: {
”type”: ”integer”,
”description”: ”Total number of devices in the Package”,
”format”: ”int32”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name where Package was created”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id where Package was created”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”ShipmentId”: {
”type”: ”integer”,
”description”: ”Shipment id”,
”format”: ”int32”
},
”ShipmentStatus”: {
”type”: ”string”,
”description”: ”Shipment status”
},
”AgentName”: {
”type”: ”string”,
”description”: ”Agent name who created the Package”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Package creation date”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Package status”
}
}
},
”PackageDimensionsListResponseModel”: {
”type”: ”object”,
”description”: ”Package dimensions list response data model”,
”properties”: {
”Data”: {
”type”: ”array”,
”description”: ”An array of Package Dimensions”,
”items”: {
”$ref”: ”#/definitions/PackageDimensionsModel”
}
}
}
},
”PackageDimensionsModel”: {
”type”: ”object”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Package Dimension Id”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Name”
},
”Dimensions”: {
”type”: ”string”,
”description”: ”Dimensions”
}
}
},
”AddItemsApi”: {
”type”: ”object”,
”properties”: {
”PackageId”: {
”type”: ”integer”,
”description”: ”Package Id\n ”,
”format”: ”int32”
},
”TradeInDevices”: {
”type”: ”array”,
”description”: ”An array of trade-in item Ids\n ”,
”items”: {
”type”: ”integer”,
”format”: ”int32”
}
}
}
},
”PriceQuoteResponseDto”: {
”type”: ”object”,
”description”: ”Price quote response data model\n ”,
”required”: [
”PriceQuoteId”,
”OfferedPrice”,
”OfferedPriceInclVat”,
”OfferedPriceMVAT”,
”ExchangeRate”
],
”properties”: {
”PriceQuoteId”: {
”type”: ”string”,
”description”: ”Price quote Id\n ”,
”format”: ”guid”
},
”ItemIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device identifier\n ”
},
”Grade”: {
”type”: ”string”,
”description”: ”Trade-in device grade\n ”
},
”OfferedPrice”: {
”type”: ”number”,
”description”: ”Trade-in device price in vendor currency\n ”,
”format”: ”decimal”
},
”OfferedPriceInclVat”: {
”type”: ”number”,
”description”: ”Trade-in device price in vendor currency, including VAT\nIncluding Potential Bonus\n ”,
”format”: ”decimal”
},
”OfferedPriceMVAT”: {
”type”: ”number”,
”description”: ”Trade-in device price in vendor currency\n ”,
”format”: ”decimal”
},
”VATCoefficient”: {
”type”: ”integer”,
”description”: ”VAT rate\n ”,
”format”: ”int32”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency ISO code\n ”
},
”CurrencySymbol”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange rate\n ”,
”format”: ”decimal”
},
”TradeInChannel”: {
”description”: ”Trade in channel\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/TradeInChannel”
}
]
},
”TradeInType”: {
”description”: ”Trade in type\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/TradeInType”
}
]
},
”PotentialCampaign”: {
”description”: ”Potential Campaign Information\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/PriceQuoteCampaignDto”
}
]
}
}
},
”TradeInChannel”: {
”type”: ”integer”,
”description”: ”0 = Web\n1 = RetailStore”,
”x-enumNames”: [
”Web”,
”RetailStore”
],
”enum”: [
0,
1
]
},
”TradeInType”: {
”type”: ”integer”,
”description”: ”0 = Regular\n1 = Upgrade\n2 = Buyback\n3 = Fpc”,
”x-enumNames”: [
”Regular”,
”Upgrade”,
”Buyback”,
”Fpc”
],
”enum”: [
0,
1,
2,
3
]
},
”PriceQuoteCampaignDto”: {
”type”: ”object”,
”description”: ”Potential Campaign Information\n ”,
”required”: [
”CampaignId”
],
”properties”: {
”DeviceBonusInclVat”: {
”type”: ”number”,
”description”: ”Device Bonus included in the OfferedPriceInclVat\n ”,
”format”: ”decimal”
},
”DealBonusInclVat”: {
”type”: ”number”,
”description”: ”Potential Deal Bonus, which can be added in Total Trade-in sum\n ”,
”format”: ”decimal”
},
”CampaignId”: {
”type”: ”integer”,
”description”: ”Applied Campaign\n ”,
”format”: ”int32”
}
}
},
”PriceQuoteRequest”: {
”type”: ”object”,
”required”: [
”ModelId”
],
”properties”: {
”GradingForm”: {
”description”: ”Grading form JSON object\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/GradingFormJsonFillInfo”
}
]
},
”ModelId”: {
”type”: ”integer”,
”description”: ”Trade-in device Model Id\n ”,
”format”: ”int32”
},
”ItemIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device identifier (IMEI, serial number, etc.)\n ”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id. If no value is provided, default Location associated with the API key will be used.\n ”,
”format”: ”int32”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id. If no value is provided, default User associated with the API key will be used.\n ”
},
”TradeInChannel”: {
”description”: ”Trade in channel to distinct different trade-in channels , eg. online (web), retail store, etc\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/TradeInChannel”
}
]
},
”TradeInType”: {
”description”: ”Trade in type to distinct different trade-in types, eg. regular trade-in, upgrade, buyback etc.\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/TradeInType”
}
]
},
”CampaignId”: {
”type”: ”integer”,
”description”: ”Campaign Id for potential bonus evaluation\n ”,
”format”: ”int32”
}
}
},
”GradingFormJsonFillInfo”: {
”type”: ”object”,
”properties”: {
”Answers”: {
”type”: ”object”,
”additionalProperties”: {
”type”: ”array”,
”items”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”Extras”: {
”type”: ”array”,
”items”: {
”type”: ”integer”,
”format”: ”int32”
}
},
”SystemExtras”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/GradingFormSystemExtraType”
}
},
”GradingDifferenceImages”: {
”type”: ”object”,
”additionalProperties”: {
”type”: ”array”,
”items”: {
”type”: ”string”
}
}
},
”GradingProofImages”: {
”type”: ”array”,
”x-deprecated”: true,
”items”: {
”type”: ”string”
}
}
}
},
”Co2EmissionResponseDto”: {
”type”: ”object”,
”properties”: {
”Value”: {
”type”: ”number”,
”format”: ”decimal”
}
}
},
”CreateShipmentApi”: {
”type”: ”object”,
”properties”: {
”Name”: {
”type”: ”string”,
”description”: ”Shipment name”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id. If no value is provided, default User associated with the API key will be used. ”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id. If no value is provided, default Location associated with the API key will be used.”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”PackagesIds”: {
”type”: ”array”,
”description”: ”An array of Package Id’s in the Shipment”,
”items”: {
”type”: ”integer”,
”format”: ”int32”
}
},
”TrackingNumber”: {
”type”: ”string”,
”description”: ”Tracking code of shipment”
}
}
},
”AddPackageRequestModel”: {
”type”: ”object”,
”description”: ”Add Package To Shipment request data model”,
”properties”: {
”PackageIds”: {
”type”: ”array”,
”description”: ”Package identifier”,
”items”: {
”type”: ”integer”,
”format”: ”int32”
}
}
}
},
”ShipmentDetailsResponseModel”: {
”type”: ”object”,
”description”: ”Shipment details response data model”,
”required”: [
”Id”,
”LocationId”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Shipment Id”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Shipment name”
},
”Identifier”: {
”type”: ”string”,
”description”: ”Shipment identifier.”
},
”TrackingNumber”: {
”type”: ”string”,
”description”: ”Shipment tracking number”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name where Shipment was created”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id where Shipment was created”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”AgentName”: {
”type”: ”string”,
”description”: ”Agent name who created the Shipment”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Shipment creation date”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Shipment status”
},
”Packages”: {
”type”: ”array”,
”description”: ”Trade-in devices in the shipment”,
”items”: {
”$ref”: ”#/definitions/PackageModel2”
}
}
}
},
”PackageModel2”: {
”type”: ”object”,
”description”: ”Package data model”,
”required”: [
”Id”,
”LocationId”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Package Id”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Package name”
},
”Identifier”: {
”type”: ”string”,
”description”: ”Package identifier”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”AgentName”: {
”type”: ”string”,
”description”: ”Agent name”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Package creation date”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Package status”
},
”Content”: {
”type”: ”array”,
”description”: ”Trade-in devices in the Package”,
”items”: {
”$ref”: ”#/definitions/PackageContentModel2”
}
}
}
},
”PackageContentModel2”: {
”type”: ”object”,
”description”: ”Package content model”,
”required”: [
”TradeInDeviceId”,
”Price”,
”ExchangeRate”,
”TradeInId”,
”TradeInDate”
],
”properties”: {
”TradeInDeviceId”: {
”type”: ”integer”,
”description”: ”Trade-in device Id”,
”format”: ”int32”
},
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device unique identifier (e.g IMEI, serial number)”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name”
},
”Grade”: {
”type”: ”string”,
”description”: ”Trade-in device grade”
},
”Price”: {
”type”: ”number”,
”description”: ”Trade-in device price”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”CurrencySymbol”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”Status”: {
”type”: ”string”,
”description”: ”Trade-in device status”
},
”TradeInId”: {
”type”: ”integer”,
”description”: ”Trade-in Id”,
”format”: ”int32”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example, a cash register receipt number, contract number etc.\nCan be empty.”
},
”TradeInDate”: {
”type”: ”string”,
”description”: ”Trade-in registration date”,
”format”: ”date-time”
},
”AgentName”: {
”type”: ”string”,
”description”: ”User name, who registered the Trade-in”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id, where the Trade-in was registered”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name, where the Trade-in was registered”
}
}
},
”UpdateShipmentRequestModel”: {
”type”: ”object”,
”description”: ”Update Shipment request data model”,
”properties”: {
”ShipmentName”: {
”type”: ”string”,
”description”: ”Shipment name”
},
”TrackingNumber”: {
”type”: ”string”,
”description”: ”Shipment tacking number”
}
}
},
”ShipmentsListResponseModel”: {
”type”: ”object”,
”description”: ”Shipments list response data model”,
”properties”: {
”Data”: {
”type”: ”array”,
”description”: ”An array of Shipments”,
”items”: {
”$ref”: ”#/definitions/ShipmentModel”
}
}
}
},
”ShipmentModel”: {
”type”: ”object”,
”description”: ”Shipment data model”,
”required”: [
”Id”,
”PackageQty”,
”LocationId”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Shipment Id”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”,
”description”: ”Shipment name”
},
”Identifier”: {
”type”: ”string”,
”description”: ”Shipment identifier.”
},
”DeviceQty”: {
”type”: ”integer”,
”description”: ”Total number of devices in the shipment”,
”format”: ”int32”
},
”PackageQty”: {
”type”: ”integer”,
”description”: ”Total number of packages in the shipment”,
”format”: ”int32”
},
”TrackingNumber”: {
”type”: ”string”,
”description”: ”Shipment tracking number”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name where Shipment was created”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id where Shipment was created”,
”format”: ”int32”
},
”AgentName”: {
”type”: ”string”,
”description”: ”Agent name who created the Shipment”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Shipment creation date”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Shipment status”
}
}
},
”CreateShipmentLabelResponseModel”: {
”type”: ”object”,
”properties”: {
”DownloadUrl”: {
”type”: ”string”
}
}
},
”CreateShipmentLabelRequestModel”: {
”type”: ”object”,
”description”: ”Create Shipment Label request data model”,
”properties”: {
”LocationId”: {
”type”: ”integer”,
”format”: ”int32”
},
”LocationAddress”: {
”$ref”: ”#/definitions/ShipmentLabelLocationAddress”
}
}
},
”ShipmentLabelLocationAddress”: {
”type”: ”object”,
”description”: ”Shipment Label address”,
”properties”: {
”CountryCode”: {
”type”: ”string”
},
”City”: {
”type”: ”string”
},
”PostCode”: {
”type”: ”string”
},
”Street1”: {
”type”: ”string”
},
”Street2”: {
”type”: ”string”
},
”PhoneNumber”: {
”type”: ”string”
}
}
},
”ShippingStatusesDto”: {
”type”: ”object”,
”properties”: {
”Data”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/ShippingStatusDto”
}
}
}
},
”ShippingStatusDto”: {
”type”: ”object”,
”required”: [
”StatusId”,
”StatusName”,
”Timestamp”
],
”properties”: {
”StatusId”: {
”type”: ”string”
},
”StatusName”: {
”type”: ”string”
},
”Timestamp”: {
”type”: ”string”,
”format”: ”date-time”
},
”CountryCode”: {
”type”: ”string”
},
”City”: {
”type”: ”string”
}
}
},
”ShipmentAndPackageDto”: {
”type”: ”object”,
”required”: [
”PackageId”,
”ShipmentId”
],
”properties”: {
”PackageId”: {
”type”: ”integer”,
”format”: ”int32”
},
”ShipmentId”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”CreateShipmentByTradeInModel”: {
”type”: ”object”,
”properties”: {
”PackageName”: {
”type”: ”string”,
”description”: ”Package name. If not value is provided, default value is used.”
},
”ShipmentName”: {
”type”: ”string”,
”description”: ”Shipment name. If not value is provided, default value is used.”
},
”PackageIdentifier”: {
”type”: ”string”,
”description”: ”Unique Package identifier. If not value is provided, auto-generated value is used.”
},
”TrackingNumber”: {
”type”: ”string”,
”description”: ”Tracking code of shipment.\nCould be empty.”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id. If no value is provided, default User associated with the API key will be used.”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id. If no value is provided, default Location associated with the API key will be used.”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
}
}
},
”TradeInPdfInfoDto”: {
”type”: ”object”,
”description”: ”Trade-in PDF info response”,
”properties”: {
”FileKey”: {
”type”: ”string”,
”description”: ”File key for Temp Trade-in PDF”
},
”PublicUrl”: {
”type”: ”string”,
”description”: ”Public url to download Temp Trade-in PDF”
}
}
},
”VoucherStatusDto”: {
”type”: ”object”,
”description”: ”Simple Voucher System – tradein voucher status”,
”properties”: {
”VoucherStatus”: {
”type”: ”string”
}
}
},
”UpdateVoucherStatusResponseDto”: {
”type”: ”object”,
”required”: [
”VoucherCode”
],
”properties”: {
”VoucherCode”: {
”type”: ”integer”,
”format”: ”int32”
},
”VoucherStatus”: {
”type”: ”string”
}
}
},
”UpdateVoucherStatusDto”: {
”type”: ”object”,
”required”: [
”NewVoucherStatus”
],
”properties”: {
”NewVoucherStatus”: {
”$ref”: ”#/definitions/TradeInVoucherStatus”
}
}
},
”TradeInVoucherStatus”: {
”type”: ”integer”,
”description”: ”0 = Used\n1 = Available”,
”x-enumNames”: [
”Used”,
”Available”
],
”enum”: [
0,
1
]
},
”RegisterTradeInResponseDto”: {
”type”: ”object”,
”description”: ”Register Trade-in response data model\n ”,
”required”: [
”Id”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Trade-in Id\n ”,
”format”: ”int32”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Trade-in registration timestamp\n ”,
”format”: ”date-time”
},
”TradeInDevices”: {
”type”: ”array”,
”description”: ”Trade-in devices collection\n ”,
”items”: {
”$ref”: ”#/definitions/TradeInDeviceResponseDto”
}
},
”Status”: {
”type”: ”string”,
”description”: ”Trade-in status\n ”
},
”CustomDataFields”: {
”type”: ”array”,
”description”: ”Custom data fields collection”,
”items”: {
”$ref”: ”#/definitions/DataFieldDto”
}
}
}
},
”TradeInDeviceResponseDto”: {
”type”: ”object”,
”description”: ”Trade-in device details request model\n ”,
”required”: [
”TradeInDeviceId”,
”PriceQuoteId”,
”Price”,
”ExchangeRate”
],
”properties”: {
”TradeInDeviceId”: {
”type”: ”integer”,
”description”: ”Trade-in device Id\n ”,
”format”: ”int32”
},
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device unique identifier (e.g IMEI, serial number)\n ”
},
”PriceQuoteId”: {
”type”: ”string”,
”description”: ”Price quote Id\n ”,
”format”: ”guid”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name\n ”
},
”Grade”: {
”type”: ”string”,
”description”: ”Trade-in device grade\n ”
},
”Price”: {
”type”: ”number”,
”description”: ”Trade-in device price\n ”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”CurrencySymbol”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”CheckMendCertId”: {
”type”: ”string”,
”description”: ”CheckMend certificate Id\n ”
}
}
},
”DataFieldDto”: {
”type”: ”object”,
”description”: ”Custom data field \n ”,
”required”: [
”DataFieldId”
],
”properties”: {
”DataFieldId”: {
”type”: ”integer”,
”description”: ”Gets or sets data field id\n ”,
”format”: ”int32”
},
”DataFieldValue”: {
”type”: ”string”,
”description”: ”Gets or sets data field value (literal, boolean value or list option id)\n ”
}
}
},
”RegisterTradeInRequest”: {
”type”: ”object”,
”description”: ”Register Trade-in request data model\nNotice that, unlike RegisterTradeIn, it is being used from `Rosie.Vendor.Api`\n ”,
”required”: [
”IsCorporate”
],
”properties”: {
”TradeInDevices”: {
”type”: ”array”,
”description”: ”An array of Trade-in devices registered with the Trade-in\n ”,
”items”: {
”$ref”: ”#/definitions/TradeInDeviceRequestDto”
}
},
”CustomDataFields”: {
”type”: ”array”,
”description”: ”Custom data fields collection. Any arbitrary additional data fields passed alongside with the form.\n ”,
”items”: {
”$ref”: ”#/definitions/DataFieldRequestDto”
}
},
”IsCorporate”: {
”type”: ”boolean”,
”description”: ”Is corporate trade in or not\n ”
},
”OrganizationName”: {
”type”: ”string”,
”description”: ”organization name\n ”
},
”ClientFirstName”: {
”type”: ”string”,
”description”: ”client first name\n ”
},
”ClientLastName”: {
”type”: ”string”,
”description”: ”client last name\n ”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id. If no value is provided, default User associated with the API key will be used.\n ”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.\n ”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id. If no value is provided, default Location associated with the API key will be used.\n ”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.\n ”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example, a cash register receipt number, contract number etc.\nCan be empty.\n ”
},
”ClientSignature”: {
”type”: ”string”,
”description”: ”Trade-in client signature storage field id\n ”,
”format”: ”guid”
},
”AgentSignature”: {
”type”: ”string”,
”description”: ”Trade-in agent signature storage field id\n ”,
”format”: ”guid”
}
}
},
”TradeInDeviceRequestDto”: {
”type”: ”object”,
”description”: ”Trade in item\n ”,
”required”: [
”PriceQuoteId”
],
”properties”: {
”PriceQuoteId”: {
”type”: ”string”,
”description”: ”Price quote unique identifier\n ”,
”format”: ”guid”
},
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Device identifier\n ”
}
}
},
”DataFieldRequestDto”: {
”type”: ”object”,
”description”: ”Custom data field submitted result\n ”,
”required”: [
”DataFieldId”
],
”properties”: {
”DataFieldId”: {
”type”: ”integer”,
”description”: ”Gets or sets data field id\n ”,
”format”: ”int32”
},
”DataFieldValue”: {
”type”: ”string”,
”description”: ”Gets or sets data field value (literal, boolean value or list option id)\n ”
}
}
},
”TradeInDetailsResponseDto”: {
”type”: ”object”,
”description”: ”Trade-in details response data model\n ”,
”required”: [
”Id”,
”IsCorporate”,
”CampaignOfferAdjustment”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Trade-in Id\n ”,
”format”: ”int32”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example, a cash register receipt number, contract number etc.\nCan be empty.\n ”
},
”IsCorporate”: {
”type”: ”boolean”,
”description”: ”Is corporate trade-in or not\n ”
},
”CustomerName”: {
”type”: ”string”,
”description”: ”Customer name\n ”
},
”PromoCode”: {
”type”: ”string”,
”description”: ”Promo code\n ”
},
”CampaignOfferAdjustment”: {
”type”: ”number”,
”description”: ”Campaign offer adjustment\n ”,
”format”: ”decimal”
},
”CustomDataFields”: {
”type”: ”array”,
”description”: ”Trade-in custom data fields collection”,
”items”: {
”$ref”: ”#/definitions/DataFieldDto”
}
},
”TradeInDevices”: {
”type”: ”array”,
”description”: ”Trade-in devices collection”,
”items”: {
”$ref”: ”#/definitions/TradeInDeviceDto”
}
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id, where Trade-in was registered\n ”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.\n ”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id, who registered Trade-in\n ”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.\n ”
},
”AgentName”: {
”type”: ”string”,
”description”: ”User name, who registered the Trade-in\n ”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Trade-in registration timestamp\n ”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Trade-in status\n ”
},
”TotalVATPrice”: {
”type”: ”number”,
”description”: ”Total Price with VAT for all TradeInDevices\n ”,
”format”: ”decimal”
},
”AppliedCampaign”: {
”description”: ”Applied Campaign Information\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/DealCampaignDto”
}
]
}
}
},
”TradeInDeviceDto”: {
”type”: ”object”,
”description”: ”Trade-in device\n ”,
”required”: [
”Id”,
”Price”,
”PriceWithVAT”,
”ExchangeRate”,
”ItemGroupId”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Trade-in device Id\n ”,
”format”: ”int32”
},
”CheckMendCertificateId”: {
”type”: ”string”,
”description”: ”Checkmend certificate id\n ”
},
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device unique identifier (e.g IMEI, serial number)\n ”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name\n ”
},
”Grade”: {
”type”: ”string”,
”description”: ”Trade-in device grade\n ”
},
”Price”: {
”type”: ”number”,
”description”: ”Trade-in device price\n ”,
”format”: ”decimal”
},
”ManufacturerId”: {
”type”: ”integer”,
”description”: ”Manufacturer Id\n ”,
”format”: ”int32”
},
”ManufacturerName”: {
”type”: ”string”,
”description”: ”Manufacturer Name\n ”
},
”PriceWithVAT”: {
”type”: ”number”,
”description”: ”Price with VAT\nIncluding Bonus\n ”,
”format”: ”decimal”
},
”DeviceBonusInclVat”: {
”type”: ”number”,
”description”: ”Device Bonus included in the PriceWithVAT\n ”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”CurrencySymbol”: {
”type”: ”string”,
”description”: ”Currency symbol\n ”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”Status”: {
”type”: ”string”,
”description”: ”Trade-in device status\n ”
},
”ReportingStatus”: {
”type”: ”string”,
”description”: ”Reporting Status\n ”
},
”PackageId”: {
”type”: ”integer”,
”description”: ”Package Id (optional). Provided if the device has been packaged in a Package\n ”,
”format”: ”int32”
},
”PackageIdentifier”: {
”type”: ”string”,
”description”: ”Package unique identifier (optional). provided only if the device has been packaged in a Package\n ”
},
”ShipmentId”: {
”type”: ”integer”,
”description”: ”Shipment Id (optional). Provided if the device\n ”,
”format”: ”int32”
},
”ShipmentIdentifier”: {
”type”: ”string”,
”description”: ”Shipment unique identifier (optional). Optional.\n ”
},
”GradingFormJson”: {
”type”: ”string”,
”description”: ”Initial Grading Form\n ”
},
”VendorGradingDifferenceImages”: {
”type”: ”array”,
”description”: ”Vendor grading images”,
”items”: {
”type”: ”string”
}
},
”PartnerGradingDifferenceImages”: {
”type”: ”array”,
”description”: ”Partner grading images”,
”items”: {
”type”: ”string”
}
},
”AffiliateGradingDifferenceImages”: {
”type”: ”array”,
”description”: ”Affiliate grading images”,
”items”: {
”type”: ”string”
}
},
”ItemVariantId”: {
”type”: ”integer”,
”description”: ”Trade-in device item variant Id\n ”,
”format”: ”int32”
},
”ItemGroupId”: {
”type”: ”integer”,
”description”: ”Trade-in device item group Id\n ”,
”format”: ”int32”
}
}
},
”DealCampaignDto”: {
”type”: ”object”,
”description”: ”Applied Campaign Information\n ”,
”required”: [
”DealBonusInclVat”,
”CampaignId”
],
”properties”: {
”DealBonusInclVat”: {
”type”: ”number”,
”description”: ”Bonus included in the TotalVATPrice\n ”,
”format”: ”decimal”
},
”CampaignId”: {
”type”: ”integer”,
”description”: ”Applied Campaign\n ”,
”format”: ”int32”
}
}
},
”TradeInListResponseDto”: {
”type”: ”object”,
”description”: ”Trade-in list response data model\n ”,
”properties”: {
”Data”: {
”type”: ”array”,
”description”: ”An array of Trade-ins\n ”,
”items”: {
”$ref”: ”#/definitions/TradeInDto”
}
}
}
},
”TradeInDto”: {
”type”: ”object”,
”description”: ”Trade-in data model\n ”,
”required”: [
”Id”,
”IsCorporate”,
”TotalPrice”,
”DevicesCount”,
”CreatedDate”,
”CampaignOfferAdjustment”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Trade-in Id\n ”,
”format”: ”int32”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example, a cash register receipt number, contract number etc.\nCan be empty.\n ”
},
”IsCorporate”: {
”type”: ”boolean”,
”description”: ”Is corporate Trade-in or not\n ”
},
”CustomerName”: {
”type”: ”string”,
”description”: ”Customer name\n ”
},
”TotalPrice”: {
”type”: ”number”,
”description”: ”Total Trade-in price\n ”,
”format”: ”decimal”
},
”DevicesCount”: {
”type”: ”integer”,
”description”: ”Number of Trade-in devices\n ”,
”format”: ”int32”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id, where Trade-in was registered\n ”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.\n ”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id, who registered Trade-in\n ”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.\n ”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Trade-in registration timestamp\n ”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Trade-in status\n ”
},
”PromoCode”: {
”type”: ”string”,
”description”: ”Promo code\n ”
},
”CampaignOfferAdjustment”: {
”type”: ”number”,
”description”: ”Campaign offer adjustment\n ”,
”format”: ”decimal”
},
”TotalVATPrice”: {
”type”: ”number”,
”description”: ”Total Price with VAT for all TradeInDevices\n ”,
”format”: ”decimal”
},
”TradeInDevices”: {
”type”: ”array”,
”description”: ”Trade-in devices collection”,
”items”: {
”$ref”: ”#/definitions/TradeInDeviceDto2”
}
}
}
},
”TradeInDeviceDto2”: {
”type”: ”object”,
”description”: ”Trade-in device\n ”,
”required”: [
”Id”,
”Price”,
”ExchangeRate”,
”ItemGroupId”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Trade-in device Id\n ”,
”format”: ”int32”
},
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device unique identifier (e.g IMEI, serial number)\n ”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name\n ”
},
”Grade”: {
”type”: ”string”,
”description”: ”Trade-in device grade\n ”
},
”Price”: {
”type”: ”number”,
”description”: ”Trade-in device price\n ”,
”format”: ”decimal”
},
”PriceWithVAT”: {
”type”: ”number”,
”description”: ”Price with VAT\n ”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”CurrencySymbol”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”ManufacturerId”: {
”type”: ”integer”,
”description”: ”Manufacturer Id\n ”,
”format”: ”int32”
},
”ManufacturerName”: {
”type”: ”string”,
”description”: ”Manufacturer Name\n ”
},
”Status”: {
”type”: ”string”,
”description”: ”Trade-in device status\n ”
},
”ItemVariantId”: {
”type”: ”integer”,
”description”: ”Trade-in device item variant Id\n ”,
”format”: ”int32”
},
”ItemGroupId”: {
”type”: ”integer”,
”description”: ”Trade-in device item group Id\n ”,
”format”: ”int32”
}
}
},
”TradeInDevicesListResponseModel”: {
”type”: ”object”,
”description”: ”Trade-in devices list response model”,
”properties”: {
”Data”: {
”type”: ”array”,
”description”: ”An array of Trade-in devices”,
”items”: {
”$ref”: ”#/definitions/TradeInDeviceModel”
}
}
}
},
”TradeInDeviceModel”: {
”type”: ”object”,
”description”: ”Trade-in data model”,
”required”: [
”TradeInDeviceId”,
”ExchangeRate”,
”Status”,
”StatusTimestamp”,
”TradeInId”,
”TradeInDate”
],
”properties”: {
”DeviceBonusInclVat”: {
”type”: ”number”,
”description”: ”Device bonus including VAT”,
”format”: ”decimal”
},
”TradeInDeviceId”: {
”type”: ”integer”,
”description”: ”Trade-in device Id”,
”format”: ”int32”
},
”CheckMendCertificateId”: {
”type”: ”string”,
”description”: ”Checkmend certificate id”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”ReportingStatus”: {
”type”: ”string”,
”description”: ”Trade-in device reporting status”
},
”VendorDeviceInfo”: {
”description”: ”Device details in accordance with Vendor grading.”,
”allOf”: [
{
”$ref”: ”#/definitions/DeviceInfo”
}
]
},
”PartnerDeviceInfo”: {
”description”: ”Device details in accordance with Partner grading.”,
”allOf”: [
{
”$ref”: ”#/definitions/DeviceInfo”
}
]
},
”Status”: {
”description”: ”Trade-in device status”,
”allOf”: [
{
”$ref”: ”#/definitions/TradeInDeviceStatus”
}
]
},
”StatusTimestamp”: {
”type”: ”string”,
”description”: ”Trade-in device status timestamp”,
”format”: ”date-time”,
”x-deprecated”: true
},
”TradeInId”: {
”type”: ”integer”,
”description”: ”Trade-in Id”,
”format”: ”int32”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example,\na cash register receipt number, contract number etc.\nCan be empty.”
},
”TradeInDate”: {
”type”: ”string”,
”description”: ”Trade-in registration date”,
”format”: ”date-time”
},
”AgentName”: {
”type”: ”string”,
”description”: ”User name, who registered the Trade-in”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id, where the Trade-in was registered”,
”format”: ”int32”
},
”Location”: {
”type”: ”string”,
”description”: ”Location name, where the Trade-in was registered”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.”
},
”DataFields”: {
”type”: ”array”,
”description”: ”Trade-in data fields”,
”x-deprecated”: true,
”items”: {
”$ref”: ”#/definitions/TradeInDataFieldModel”
}
},
”PackageId”: {
”type”: ”integer”,
”description”: ”Package Id (optional). Provided if the device has been packaged in a Package”,
”format”: ”int32”
},
”PackageIdentifier”: {
”type”: ”string”,
”description”: ”Package unique identifier (optional). provided only if the device has been packaged in a Package”
},
”ShipmentId”: {
”type”: ”integer”,
”description”: ”Shipment Id (optional). Provided if the device”,
”format”: ”int32”
},
”ShipmentIdentifier”: {
”type”: ”string”,
”description”: ”Shipment unique identifier (optional). Optional.”
},
”GradingFormJson”: {
”type”: ”string”,
”description”: ”Grading form results by Vendor and Partner”
},
”VendorGradingDifferenceImages”: {
”type”: ”array”,
”description”: ”Vendor grading images”,
”items”: {
”type”: ”string”
}
},
”PartnerGradingDifferenceImages”: {
”type”: ”array”,
”description”: ”Partner grading images”,
”items”: {
”type”: ”string”
}
},
”AffiliateGradingDifferenceImages”: {
”type”: ”array”,
”description”: ”Affiliate grading images”,
”items”: {
”type”: ”string”
}
}
}
},
”DeviceInfo”: {
”type”: ”object”,
”required”: [
”CP”,
”CP_WithVAT”,
”CBP”,
”VEP”,
”VBP”
],
”properties”: {
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device unique identifier (e.g IMEI, serial number)”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name”
},
”CP”: {
”type”: ”number”,
”description”: ”Customer Price: Device price, including score adjustments + extras.\nCP = CBP * score adjustments + extras”,
”format”: ”decimal”
},
”CP_WithVAT”: {
”type”: ”number”,
”description”: ”Customer Price: Device price, including score adjustments + extras.\nCP = (CBP * score adjustments + extras) * VAT”,
”format”: ”decimal”
},
”CBP”: {
”type”: ”number”,
”description”: ”Customer Base Price: Device full price in Vendor’s price list.\nVBP * optional vendor margin.”,
”format”: ”decimal”
},
”VEP”: {
”type”: ”number”,
”description”: ”Vendor Expected Price: what does Vendor EXPECT to be paid according to Vendor’s answers.\nVBP * score + extras.”,
”format”: ”decimal”
},
”VBP”: {
”type”: ”number”,
”description”: ”Vendor Base Price: Device price in Vendor price list”,
”format”: ”decimal”
},
”Grade”: {
”type”: ”string”,
”description”: ”Device grade”
},
”ManufacturerId”: {
”type”: ”integer”,
”description”: ”Manufacturer Id”,
”format”: ”int32”
},
”ManufacturerName”: {
”type”: ”string”,
”description”: ”Manufacturer Name”
},
”ItemVariantId”: {
”type”: ”integer”,
”description”: ”Trade-in device item variant Id”,
”format”: ”int32”
},
”ItemGroupId”: {
”type”: ”integer”,
”description”: ”Trade-in device item group Id”,
”format”: ”int32”
}
}
},
”TradeInDeviceStatus”: {
”type”: ”integer”,
”description”: ”1 = Registered\n2 = Withheld\n6 = Canceled\n7 = ProcessedByAffiliate\n8 = Missing\n9 = Fraud\n55 = Processed”,
”x-enumNames”: [
”Registered”,
”Withheld”,
”Canceled”,
”ProcessedByAffiliate”,
”Missing”,
”Fraud”,
”Processed”
],
”enum”: [
1,
2,
6,
7,
8,
9,
55
]
},
”TradeInDataFieldModel”: {
”type”: ”object”,
”description”: ”Trade-in data field model”,
”required”: [
”TradeInId”,
”FieldId”
],
”properties”: {
”TradeInId”: {
”type”: ”integer”,
”description”: ”Trade-in Id”,
”format”: ”int32”
},
”FieldId”: {
”type”: ”integer”,
”description”: ”Field Id”,
”format”: ”int32”
},
”FieldName”: {
”type”: ”string”,
”description”: ”Field name”
},
”FieldValue”: {
”type”: ”string”,
”description”: ”Field value”
}
}
},
”GetTradeInDataFieldsResponseDto”: {
”type”: ”object”,
”required”: [
”DataFieldId”
],
”properties”: {
”TradeInId”: {
”type”: ”integer”,
”format”: ”int32”
},
”TempTradeInId”: {
”type”: ”integer”,
”format”: ”int32”
},
”DataFieldId”: {
”type”: ”integer”,
”format”: ”int32”
},
”DataFieldValue”: {
”type”: ”string”
}
}
},
”ValidateTradeInDataFieldResponseDto”: {
”type”: ”object”,
”required”: [
”ResultType”
],
”properties”: {
”Result”: {
”type”: ”string”
},
”ResultType”: {
”$ref”: ”#/definitions/ValidateTradeInDataFieldResponseType”
},
”Message”: {
”type”: ”string”
}
}
},
”ValidateTradeInDataFieldResponseType”: {
”type”: ”integer”,
”description”: ”0 = Valid\n1 = Invalid”,
”x-enumNames”: [
”Valid”,
”Invalid”
],
”enum”: [
0,
1
]
},
”RegisterTempTradeInResponseDto”: {
”type”: ”object”,
”description”: ”Register Temp Trade-in response data model”,
”required”: [
”Id”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Temp Trade-in Id”,
”format”: ”int32”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Temp Trade-in registration timestamp”,
”format”: ”date-time”
},
”TradeInDevices”: {
”type”: ”array”,
”description”: ”Temp Trade-in devices collection”,
”items”: {
”$ref”: ”#/definitions/TempTradeInDeviceResponseDto”
}
},
”Status”: {
”type”: ”string”,
”description”: ”Temp Trade-in status”
}
}
},
”TempTradeInDeviceResponseDto”: {
”type”: ”object”,
”description”: ”Temp Trade-in device details request model”,
”required”: [
”PriceQuoteId”,
”Price”,
”ExchangeRate”
],
”properties”: {
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Temp Trade-in device unique identifier (e.g IMEI, serial number)”
},
”PriceQuoteId”: {
”type”: ”string”,
”description”: ”Price quote Id”,
”format”: ”guid”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name”
},
”Grade”: {
”type”: ”string”,
”description”: ”Temp Trade-in device grade”
},
”Price”: {
”type”: ”number”,
”description”: ”Temp Trade-in device price”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”CurrencySymbol”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”CheckMendCertId”: {
”type”: ”string”,
”description”: ”CheckMend certificate Id”
}
}
},
”RegisterTempTradeInRequest”: {
”type”: ”object”,
”description”: ”Register Temp Trade-in request\n ”,
”required”: [
”IsCorporate”
],
”properties”: {
”TradeInDevices”: {
”type”: ”array”,
”description”: ”An array of Trade-in devices registered with the Trade-in\n ”,
”items”: {
”$ref”: ”#/definitions/TradeInDeviceRequestDto”
}
},
”CustomDataFields”: {
”type”: ”array”,
”description”: ”Custom data fields collection. Any arbitrary additional data fields passed alongside with the form.\n ”,
”items”: {
”$ref”: ”#/definitions/DataFieldRequestDto”
}
},
”IsCorporate”: {
”type”: ”boolean”,
”description”: ”Is corporate trade in or not\n ”
},
”OrganizationName”: {
”type”: ”string”,
”description”: ”organization name\n ”
},
”ClientFirstName”: {
”type”: ”string”,
”description”: ”client first name\n ”
},
”ClientLastName”: {
”type”: ”string”,
”description”: ”client last name\n ”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id. If no value is provided, default User associated with the API key will be used.\n ”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.\n ”
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id. If no value is provided, default Location associated with the API key will be used.\n ”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.\n ”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example, a cash register receipt number, contract number etc.\nCan be empty.\n ”
}
}
},
”TempTradeInDetailsResponseDto”: {
”type”: ”object”,
”description”: ”Temp Trade-in details response”,
”required”: [
”Id”,
”IsCorporate”,
”CreatedDate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”description”: ”Temp Trade-in Id\n ”,
”format”: ”int32”
},
”TradeInRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Trade-in transaction or customer from Vendor side, for example, a cash register receipt number, contract number etc.\nCan be empty.\n ”
},
”IsCorporate”: {
”type”: ”boolean”,
”description”: ”Is corporate trade-in or not\n ”
},
”CustomerName”: {
”type”: ”string”,
”description”: ”Customer name\n ”
},
”PromoCode”: {
”type”: ”string”,
”description”: ”Promo code\n ”
},
”CustomDataFields”: {
”type”: ”array”,
”description”: ”Custom data fields collection”,
”items”: {
”$ref”: ”#/definitions/DataFieldDto”
}
},
”TradeInDevices”: {
”type”: ”array”,
”description”: ”Trade-in devices collection”,
”items”: {
”$ref”: ”#/definitions/TempTradeInDeviceDto”
}
},
”LocationId”: {
”type”: ”integer”,
”description”: ”Location Id, where Trade-in was registered\n ”,
”format”: ”int32”
},
”LocationRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor point of sale.\nCan be empty.\n ”
},
”AgentId”: {
”type”: ”string”,
”description”: ”Agent Id, who registered Trade-in\n ”
},
”AgentRef”: {
”type”: ”string”,
”description”: ”Contains a custom data that can be used to identify Vendor agent.\nCould be empty.\n ”
},
”AgentName”: {
”type”: ”string”,
”description”: ”User name, who registered the Trade-in\n ”
},
”CreatedDate”: {
”type”: ”string”,
”description”: ”Trade-in registration timestamp\n ”,
”format”: ”date-time”
},
”Status”: {
”type”: ”string”,
”description”: ”Temp Trade-in status\n – Active – registered and valid Temp Trade-in\n – Confirmed – Inactive confirmed temp trade-in which has connected Trade-in\n – Expired – Inactive non-confirmed temp trade-in which does not have connected Trade-in\n ”
},
”TotalVATPrice”: {
”type”: ”number”,
”description”: ”Total Price with VAT for all TradeInDevices\nIncluding bonus\n ”,
”format”: ”decimal”
},
”AppliedCampaign”: {
”description”: ”Applied Campaign Information\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/DealCampaignDto”
}
]
}
}
},
”TempTradeInDeviceDto”: {
”type”: ”object”,
”description”: ”Temp Trade-in device\n ”,
”required”: [
”Price”,
”PriceWithVAT”,
”ExchangeRate”,
”ItemVariantId”,
”ItemGroupId”
],
”properties”: {
”DeviceIdentifier”: {
”type”: ”string”,
”description”: ”Trade-in device unique identifier (e.g IMEI, serial number)\n ”
},
”ProductName”: {
”type”: ”string”,
”description”: ”Product name\n ”
},
”Grade”: {
”type”: ”string”,
”description”: ”Trade-in device grade\n ”
},
”Price”: {
”type”: ”number”,
”description”: ”Trade-in device price\n ”,
”format”: ”decimal”
},
”ManufacturerId”: {
”type”: ”integer”,
”description”: ”Manufacturer Id\n ”,
”format”: ”int32”
},
”ManufacturerName”: {
”type”: ”string”,
”description”: ”Manufacturer Name\n ”
},
”PriceWithVAT”: {
”type”: ”number”,
”description”: ”Price with VAT\nIncluding Bonus\n ”,
”format”: ”decimal”
},
”DeviceBonusInclVat”: {
”type”: ”number”,
”description”: ”Device Bonus included in the PriceWithVAT\n ”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”,
”description”: ”Currency Iso Code for Price”
},
”CurrencySymbol”: {
”type”: ”string”,
”description”: ”Currency symbol\n ”
},
”ExchangeRate”: {
”type”: ”number”,
”description”: ”Exchange Rate which was actual on create time”,
”format”: ”decimal”
},
”GradingFormInfo”: {
”description”: ”Initial Grading Form\n ”,
”allOf”: [
{
”$ref”: ”#/definitions/GradingFormJsonFillInfo”
}
]
},
”ItemVariantId”: {
”type”: ”integer”,
”description”: ”Trade-in device item variant Id\n ”,
”format”: ”int32”
},
”ItemGroupId”: {
”type”: ”integer”,
”description”: ”Trade-in device item group Id\n ”,
”format”: ”int32”
}
}
},
”ConfirmTempTradeInRequest”: {
”type”: ”object”,
”required”: [
”TempTradeInId”
],
”properties”: {
”TempTradeInId”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”TempTradeInPdfInfoDto”: {
”type”: ”object”,
”description”: ”Temp Trade-in PDF info response”,
”properties”: {
”FileKey”: {
”type”: ”string”,
”description”: ”File key for Temp Trade-in PDF”
},
”PublicUrl”: {
”type”: ”string”,
”description”: ”Public url to download Temp Trade-in PDF”
}
}
},
”GradingTradeInResponseDto”: {
”type”: ”object”,
”description”: ”Grading trade-ins response data model”,
”required”: [
”InitialTotalPrice”
],
”properties”: {
”Devices”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/GradingDeviceDto”
}
},
”InitialTotalPrice”: {
”type”: ”number”,
”format”: ”decimal”
},
”FinalTotalPrice”: {
”type”: ”number”,
”format”: ”decimal”
}
}
},
”GradingDeviceDto”: {
”type”: ”object”,
”required”: [
”TradeInDeviceId”,
”InitialPrice”
],
”properties”: {
”TradeInDeviceId”: {
”type”: ”integer”,
”description”: ”Trade-in device id\n ”,
”format”: ”int32”
},
”InitialGrade”: {
”type”: ”string”
},
”FinalGrade”: {
”type”: ”string”
},
”InitialPrice”: {
”type”: ”number”,
”description”: ”Initial price. Should include VAT”,
”format”: ”decimal”
},
”FinalPrice”: {
”type”: ”number”,
”description”: ”Final Price. Should include VAT”,
”format”: ”decimal”
}
}
},
”TradeInShipmentDto”: {
”type”: ”object”,
”required”: [
”ShipmentId”
],
”properties”: {
”ShipmentId”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”Result”: {
”type”: ”object”,
”required”: [
”AgentFileId”,
”ClientFileId”
],
”properties”: {
”AgentFileId”: {
”type”: ”string”,
”format”: ”guid”
},
”ClientFileId”: {
”type”: ”string”,
”format”: ”guid”
}
}
},
”VendorB2BToolDataFieldDto”: {
”type”: ”object”,
”required”: [
”DataFieldId”,
”IsCorporateVisible”,
”IsRequired”,
”SortOrder”,
”HasProtection”,
”IsPdfVisible”,
”IsActive”
],
”properties”: {
”DataFieldId”: {
”type”: ”integer”,
”format”: ”int32”
},
”DataFieldName”: {
”type”: ”string”
},
”IsCorporateVisible”: {
”type”: ”boolean”
},
”IsRequired”: {
”type”: ”boolean”
},
”SortOrder”: {
”type”: ”integer”,
”format”: ”int32”
},
”HasProtection”: {
”type”: ”boolean”
},
”Label”: {
”type”: ”string”
},
”IsPdfVisible”: {
”type”: ”boolean”
},
”IsActive”: {
”type”: ”boolean”
},
”DataFieldTemplateType”: {
”type”: ”string”
},
”DataFieldType”: {
”type”: ”string”
},
”ListOptions”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/DataFieldListOptionDto2”
}
}
}
},
”DataFieldListOptionDto2”: {
”type”: ”object”,
”required”: [
”Id”,
”Position”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”
},
”Position”: {
”type”: ”integer”,
”format”: ”int32”
}
}
},
”VendorB2BToolItemGroupItemDto”: {
”type”: ”object”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”
}
}
},
”PriceListItemDto”: {
”type”: ”object”,
”required”: [
”Id”,
”ItemGroupId”,
”ExchangeRate”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”ProductName”: {
”type”: ”string”
},
”ItemGroupId”: {
”type”: ”integer”,
”format”: ”int32”
},
”Price”: {
”type”: ”number”,
”format”: ”decimal”
},
”CurrencyIsoCode”: {
”type”: ”string”
},
”CurrencySymbol”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”format”: ”decimal”
}
}
},
”GetQuoteApiDto”: {
”type”: ”object”,
”required”: [
”Id”,
”ExpirationDate”,
”Status”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”
},
”OrganizationName”: {
”type”: ”string”
},
”OrganizationRegistrationNumber”: {
”type”: ”string”
},
”OrganizationVatNumber”: {
”type”: ”string”
},
”CustomerEmail”: {
”type”: ”string”
},
”CustomerIban”: {
”type”: ”string”
},
”ReferenceNumber”: {
”type”: ”string”
},
”ContactPerson”: {
”type”: ”string”
},
”PhoneNumber”: {
”type”: ”string”
},
”NumberOfPackages”: {
”type”: ”integer”,
”format”: ”int32”
},
”PackageDimensions”: {
”type”: ”string”
},
”PackageWeight”: {
”type”: ”string”
},
”CourierTrackingNumber”: {
”type”: ”string”
},
”ExpirationDate”: {
”type”: ”string”,
”format”: ”date-time”
},
”Status”: {
”type”: ”integer”,
”format”: ”int32”
},
”BillingAddress”: {
”$ref”: ”#/definitions/GetQuoteAddressDto”
},
”ShippingAddress”: {
”$ref”: ”#/definitions/GetQuoteAddressDto”
},
”DataFields”: {
”type”: ”array”,
”items”: {
”$ref”: ”#/definitions/GetQuoteApiDataFieldDto”
}
}
}
},
”GetQuoteAddressDto”: {
”type”: ”object”,
”required”: [
”IsActive”
],
”properties”: {
”Address1”: {
”type”: ”string”
},
”Street”: {
”type”: ”string”
},
”PostalCode”: {
”type”: ”string”
},
”City”: {
”type”: ”string”
},
”Country”: {
”$ref”: ”#/definitions/GetQuoteAddressCountryDto”
},
”ContactName”: {
”type”: ”string”
},
”Phone”: {
”type”: ”string”
},
”Email”: {
”type”: ”string”
},
”CountryIsoCode”: {
”type”: ”string”
},
”IsActive”: {
”type”: ”boolean”
}
}
},
”GetQuoteAddressCountryDto”: {
”type”: ”object”,
”properties”: {
”Id”: {
”type”: ”string”
},
”Name”: {
”type”: ”string”
}
}
},
”GetQuoteApiDataFieldDto”: {
”type”: ”object”,
”required”: [
”DataFieldId”
],
”properties”: {
”Type”: {
”type”: ”string”
},
”DataFieldId”: {
”type”: ”integer”,
”format”: ”int32”
},
”Value”: {}
}
},
”GetQuoteLineApiDto”: {
”type”: ”object”,
”required”: [
”ItemVariantId”,
”Price”,
”Quantity”,
”ExchangeRate”
],
”properties”: {
”ItemVariantId”: {
”type”: ”integer”,
”format”: ”int32”
},
”Price”: {
”type”: ”number”,
”format”: ”decimal”
},
”Quantity”: {
”type”: ”integer”,
”format”: ”int32”
},
”ProductName”: {
”type”: ”string”
},
”CurrencyIsoCode”: {
”type”: ”string”
},
”ExchangeRate”: {
”type”: ”number”,
”format”: ”decimal”
}
}
},
”GetQuoteStatusesApiDto”: {
”type”: ”object”,
”required”: [
”Id”
],
”properties”: {
”Id”: {
”type”: ”integer”,
”format”: ”int32”
},
”Name”: {
”type”: ”string”
}
}
}
},
”securityDefinitions”: {
”X-ApiKey”: {
”type”: ”apiKey”,
”description”: ”Authorization header using api access key”,
”name”: ”X-ApiKey”,
”in”: ”header”
}
},
”security”: [
{
”X-ApiKey”: []
}
]
}