Sales Orders (1.1.7)

Introduction

This API can be used to retrieve sales order information and to create sales order actions.

Change history

[1.1.7]

Added Additional Invoice Party of type array and invoiceAllocationType Enum.

[1.1.6]

Removed ap2 from server list

[1.1.5]

Removed Shared Component References as nullable should be true and cannot be overriden if used with shared.

[1.1.4]

Added nullable to true for most of Properties to be in sync with bundled Sales, Additional End Point.

[1.1.3]

Added app-registry-id

[1.1.2]

Added security, Fixed enum issues and Response for SalesType

[1.1.1]

trade-in ,sales type response changed to array.

[1.1.0]

Changes in URL Path and Servers URL Names.

[1.0.0]

First version. Based on Sales Domain Bundled API Specs.

Sales order actions

Create, modify and delete Sales order data.

Create sales order

Create sales order.\r\nProvide the full object or just the mandatary (order information) and make add-ons with separate methods.

Authorizations:
OAuth2
Request Body schema: application/json
required
object

Gets or Sets OrderInformation

object or null

Gets or Sets InvoiceParties

object or null

Gets or Sets ContactParties

Array of objects or null or null (SalesOrderInventoryVehicle)

Gets or Sets SalesOrderVehicle

Array of objects or null or null (SalesOrderTradeInVehicle)

Gets or Sets SalesOrderVehicle

object or null

Gets or Sets metadata

Responses

Request samples

Content type
application/json
{
  • "orderInformation": {
    },
  • "invoiceParties": {
    },
  • "contactParties": {
    },
  • "vehicles": [
    ],
  • "tradeInVehicles": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "salesOrderId": "12345"
}

Update sales order basic information

Update sales order basic information.

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "orderInformation": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Confirm sales order

Confirms sales order. After that the modification is no longer possible.

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Cancel sales order

Cancels sales order. After that the modification is no longer possible.

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Add trade-in vehicle

Adds trade-in vehicle to the sales order.

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object or null
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "tradeInVehicle": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Removes trade-in vehicle

Removes the trade-in vehicle from sales order

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
vehicleId
string or null
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "vehicleId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Adds vehicle for sale

Adds the vehicle for sale to sales order

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object or null
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "vehicle": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Removes vehicle for sale

Removes the vehicle for sales from sales order

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
vehicleId
string or null
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "vehicleId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Update invoice parties

Update main invoice party on sales order

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object or null
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "invoiceParties": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Updates sales contact party

Adds contact party to sales order

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object or null
object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "contactParties": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Updates Accounts Receivable.

Update sales order accounts receivable to main/supplementary invoice

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Request Body schema: application/json
object or null

Account ID Data

object or null

This additional metadata section is always passed when action is performed to resource.

Responses

Request samples

Content type
application/json
{
  • "accountsReceivable": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "responseCode": 0,
  • "Message": "string",
  • "additional": [
    ],
  • "correlationId": "string"
}

Sales order queries

Retrieve Sales order data.

Get sales order

Returns a sales order with given id.

Authorizations:
OAuth2
path Parameters
salesOrderId
required
string

Sales Order Id

Responses

Response samples

Content type
application/json
{
  • "salesOrderId": "string",
  • "status": "INPROGRESS",
  • "orderInformation": {
    },
  • "invoiceParties": {
    },
  • "contactParties": {
    },
  • "vehicles": [
    ],
  • "tradeInVehicles": [
    ],
  • "links": [
    ]
}

Get sales types

Returns all sales order types with vehicle type

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "salesType": "string",
  • "salesTypeDescription": "string",
  • "vehicleTypes": [
    ]
}