| GET | /v1/backorder/customer/{CustomerId} | Get Customer Back Order by Customer Id |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderHistory:
status: int = 0
commission_number: Optional[str] = None
vin: Optional[str] = None
customer_criteria: Optional[str] = None
agent_criteria: Optional[str] = None
creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
maintenance_date: datetime.datetime = datetime.datetime(1, 1, 1)
gas_id: Optional[str] = None
sellable: bool = False
additional_information: Optional[str] = None
reason: Optional[str] = None
config_code: Optional[str] = None
fleet_base_order: Optional[str] = None
assistance_detail: Optional[str] = None
assistance_provider: Optional[str] = None
linked_by_user_type: Optional[str] = None
motability_v_t_n: Optional[str] = None
motability_back_order_drop_down: Optional[str] = None
motability_valid_from: Optional[datetime.datetime] = None
motability_valid_to: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order:
guid: Optional[str] = None
reference: Optional[str] = None
status: int = 0
customer_id: Optional[str] = None
mulesoft_reference: Optional[str] = None
gas_id: Optional[str] = None
order_date: Optional[str] = None
offer_snap_shot: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerOpeningTime:
day: Optional[str] = None
open_from: Optional[str] = None
open_to: Optional[str] = None
special: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerOpeningTimes:
new: List[RetailerOpeningTime] = field(default_factory=list)
used: List[RetailerOpeningTime] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Retailer:
id: int = 0
gssn_id: Optional[str] = None
description: Optional[str] = None
street: Optional[str] = None
city: Optional[str] = None
postcode: Optional[str] = None
google_map_postcode: Optional[str] = None
phone: Optional[str] = None
fax: Optional[str] = None
email: Optional[str] = None
website: Optional[str] = None
retailer_group_id: Optional[str] = None
retailer_group_name: Optional[str] = None
is_online: bool = False
is_new_car_retailer: bool = False
is_used_car_retailer: bool = False
is_central_retailer: bool = False
chat_enabled: bool = False
trade_in_enabled: bool = False
smart: bool = False
display_phone_number_new: Optional[str] = None
display_phone_number_used: Optional[str] = None
latitude: Decimal = decimal.Decimal(0)
longitude: Decimal = decimal.Decimal(0)
smart_description: Optional[str] = None
smart_website: Optional[str] = None
smart_phone: Optional[str] = None
legacy_id: Optional[str] = None
agent: bool = False
market_area_id: int = 0
digital_lounge_parent_gssn_id: Optional[str] = None
send_leads_to_digital_lounge_parent: bool = False
opening_times: Optional[RetailerOpeningTimes] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MotabilityPricingCsv:
id: int = 0
criteria_b_m7_n_s_t: Optional[str] = None
vtn: Optional[str] = None
back_order_drop_down: Optional[str] = None
criteria_full_model_year_code: Optional[str] = None
criteria_valid_option_codes: Optional[str] = None
criteria_invalid_option_codes: Optional[str] = None
pip_net: Decimal = decimal.Decimal(0)
pip_vat: Decimal = decimal.Decimal(0)
pip_gross: Decimal = decimal.Decimal(0)
wpms_net: Decimal = decimal.Decimal(0)
wpms_vat: Decimal = decimal.Decimal(0)
wpms_gross: Decimal = decimal.Decimal(0)
discount_net: Decimal = decimal.Decimal(0)
discount_vat: Decimal = decimal.Decimal(0)
discount_gross: Decimal = decimal.Decimal(0)
list_price_net: Decimal = decimal.Decimal(0)
list_price_vat: Decimal = decimal.Decimal(0)
list_price_gross: Decimal = decimal.Decimal(0)
delivery_charge_net: Decimal = decimal.Decimal(0)
delivery_charge_vat: Decimal = decimal.Decimal(0)
delivery_charge_gross: Decimal = decimal.Decimal(0)
fuel_charge_net: Decimal = decimal.Decimal(0)
fuel_charge_vat: Decimal = decimal.Decimal(0)
fuel_charge_gross: Decimal = decimal.Decimal(0)
number_plate_fee_net: Decimal = decimal.Decimal(0)
number_plate_fee_vat: Decimal = decimal.Decimal(0)
number_plate_fee_gross: Decimal = decimal.Decimal(0)
first_registration_fee_net: Decimal = decimal.Decimal(0)
first_registration_fee_vat: Decimal = decimal.Decimal(0)
first_registration_fee_gross: Decimal = decimal.Decimal(0)
road_fund_licence_net: Decimal = decimal.Decimal(0)
road_fund_licence_vat: Decimal = decimal.Decimal(0)
road_fund_licence_gross: Decimal = decimal.Decimal(0)
valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
class MotabilityPricingStatus(str, Enum):
PENDING = 'Pending'
CURRENT = 'Current'
RECENTLY_EXPIRED = 'RecentlyExpired'
EXPIRED = 'Expired'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MotabilityPricing(MotabilityPricingCsv):
motability_pricing_status: Optional[MotabilityPricingStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarConfigurator:
id: int = 0
back_order_id: Optional[int] = None
configurator_code: Optional[str] = None
gas_id: Optional[str] = None
status: int = 0
date_of_last_update: datetime.datetime = datetime.datetime(1, 1, 1)
last_exception_message: Optional[str] = None
last_exception: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KeyInformation:
b_m7_n_s_t: Optional[str] = None
configuration_date: Optional[str] = None
model_year: Optional[str] = None
half_year: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderingOptions:
interior: Optional[List[str]] = None
exterior: Optional[List[str]] = None
other: Optional[List[str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarConfiguratorResponse:
name: Optional[str] = None
key_information: Optional[KeyInformation] = None
ordering_options: Optional[OrderingOptions] = None
response_status: Optional[ResponseStatus] = None
configurator_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderBase:
guid: Optional[str] = None
status: int = 0
customer_id: Optional[str] = None
id: int = 0
reference: Optional[str] = None
agent: Optional[str] = None
gssn: Optional[str] = None
creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
maintenance_date: datetime.datetime = datetime.datetime(1, 1, 1)
customer_criteria: Optional[str] = None
agent_criteria: Optional[str] = None
history: Optional[List[BackOrderHistory]] = None
is_allocated_to_order: bool = False
vin: Optional[str] = None
commission_number: Optional[str] = None
order: Optional[Order] = None
source: Optional[str] = None
specialist: bool = False
outright_purchase: bool = False
sellable: bool = False
mulesoft_reference: Optional[str] = None
additional_information: Optional[str] = None
config_code: Optional[str] = None
fleet_base_order: Optional[str] = None
gas_id: Optional[str] = None
outright_purchase_customer_identifier: Optional[str] = None
retailer: Optional[Retailer] = None
customer_mode: int = 0
can_edit: bool = False
digital_lounge_gssn_id: Optional[str] = None
digital_lounge: Optional[str] = None
motability: bool = False
motability_pricing: Optional[MotabilityPricing] = None
linked_by_user_type: Optional[str] = None
assistance_provider_id: Optional[int] = None
assistance_provider: Optional[str] = None
assistance_detail: Optional[str] = None
last_assistance_message_date: Optional[datetime.datetime] = None
last_assistance_user: Optional[str] = None
is_c_o_p_converter: bool = False
is_eligible_c_o_p_converter: bool = False
car_configurator: Optional[CarConfigurator] = None
car_configurator_response: Optional[CarConfiguratorResponse] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Vehicle:
vin: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleCriteriaMatch:
fuel: bool = False
transmission: bool = False
colour: bool = False
upholstery: bool = False
line: bool = False
engine: bool = False
body_style: bool = False
packages: bool = False
class OfferPriceProductType(str, Enum):
LIS_T__P_R_I_C_E = 'LIST_PRICE'
NUMBE_R__P_L_A_T_E__F_E_E = 'NUMBER_PLATE_FEE'
DELIVER_Y__C_H_A_R_G_E = 'DELIVERY_CHARGE'
FUE_L__C_H_A_R_G_E = 'FUEL_CHARGE'
MANUFACTURE_R__O_F_F_E_R = 'MANUFACTURER_OFFER'
PERSONALISE_D__M_O_N_E_Y_O_F_F_E_R = 'PERSONALISED_MONEYOFFER'
PERSONALISE_D__N_O_N_M_O_N_E_Y_O_F_F_E_R = 'PERSONALISED_NONMONEYOFFER'
PERSONALISE_D__N_O_N_M_O_N_E_Y_O_F_F_E_R__N_E_G = 'PERSONALISED_NONMONEYOFFER_NEG'
SERVICE = 'SERVICE'
SERVIC_E__N_E_G = 'SERVICE_NEG'
GOVERNMEN_T__G_R_A_N_T = 'GOVERNMENT_GRANT'
OUTRIGH_T__P_U_R_C_H_A_S_E__D_I_S_C_O_U_N_T = 'OUTRIGHT_PURCHASE_DISCOUNT'
VI_P__O_F_F_E_R = 'VIP_OFFER'
WALLBO_X__O_F_F_E_R = 'WALLBOX_OFFER'
WALLBO_X__O_F_F_E_R__N_E_G = 'WALLBOX_OFFER_NEG'
ROA_D__F_U_N_D__L_I_C_E_N_C_E = 'ROAD_FUND_LICENCE'
FIRS_T__R_E_G_I_S_T_R_A_T_I_O_N__F_E_E = 'FIRST_REGISTRATION_FEE'
NO_T__F_O_U_N_D = 'NOT_FOUND'
ACCESSOR_Y__O_F_F_E_R = 'ACCESSORY_OFFER'
ACCESSOR_Y__O_F_F_E_R__N_E_G = 'ACCESSORY_OFFER_NEG'
MOTABILIT_Y__D_I_S_C_O_U_N_T = 'MOTABILITY_DISCOUNT'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Price:
id: Optional[str] = None
description: Optional[str] = None
net: Decimal = decimal.Decimal(0)
vat: Decimal = decimal.Decimal(0)
gross: Decimal = decimal.Decimal(0)
product: Optional[OfferPriceProductType] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleBaseDetail(Vehicle, ICommissionNumber):
description: Optional[str] = None
commission_number: Optional[str] = None
port_arrival_date: Optional[str] = None
offer_expiry_date: Optional[str] = None
fuel: Optional[str] = None
transmission: Optional[str] = None
transmission_type: Optional[str] = None
colour: Optional[str] = None
colour_description: Optional[str] = None
image_url: Optional[str] = None
specialist: bool = False
vehicle_criteria_match: Optional[VehicleCriteriaMatch] = None
colour_group: Optional[str] = None
model: Optional[str] = None
body_style: Optional[str] = None
brand: Optional[str] = None
engine: Optional[str] = None
engine_description: Optional[str] = None
line: Optional[str] = None
upholstery: Optional[str] = None
upholstery_description: Optional[str] = None
packages: List[str] = field(default_factory=list)
p11_d: Decimal = decimal.Decimal(0)
prices: List[Price] = field(default_factory=list)
vehicle_class: Optional[str] = None
product_range: Optional[str] = None
vehicle_type: Optional[str] = None
emission: Optional[Decimal] = None
baumuster: Optional[str] = None
is_sellable: bool = False
bm7_n_s_t: Optional[str] = None
electric_range: Optional[Decimal] = None
electric_consumption: Optional[Decimal] = None
is_display_stock: bool = False
display_retailer__id: Optional[int] = None
display_retailer: Optional[str] = None
display_retailer_gssn_id: Optional[str] = None
retailer: Optional[Retailer] = None
age: Optional[int] = None
model_year_code: Optional[str] = None
half_model_year_code: Optional[str] = None
full_model_year_code: Optional[str] = None
production_date: Optional[str] = None
chassis_number: Optional[str] = None
eligible_for_integrated_service_care: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleDecimalDetail(VehicleBaseDetail):
retail_price__ex_v_a_t: Decimal = decimal.Decimal(0)
otr: Decimal = decimal.Decimal(0)
actual_price: Decimal = decimal.Decimal(0)
total_offer_value: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderDecimal(BackOrderBase):
vehicle: Optional[VehicleDecimalDetail] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FeatureStatus:
agency_enabled: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetBackOrderCustomerResponse:
back_orders: List[BackOrderDecimal] = field(default_factory=list)
feature_status: Optional[FeatureStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetBackOrderCustomerRequest(IGet):
customer_id: Optional[str] = None
Python GetBackOrderCustomerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/backorder/customer/{CustomerId} HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
BackOrders:
[
{
Vehicle:
{
RetailPrice_ExVAT: 0,
OTR: 0,
ActualPrice: 0,
TotalOfferValue: 0,
Description: String,
CommissionNumber: String,
PortArrivalDate: String,
OfferExpiryDate: String,
Fuel: String,
Transmission: String,
TransmissionType: String,
Colour: String,
ColourDescription: String,
ImageUrl: String,
Specialist: False,
VehicleCriteriaMatch:
{
Fuel: False,
Transmission: False,
Colour: False,
Upholstery: False,
Line: False,
Engine: False,
BodyStyle: False,
Packages: False
},
ColourGroup: String,
Model: String,
BodyStyle: String,
Brand: String,
Engine: String,
EngineDescription: String,
Line: String,
Upholstery: String,
UpholsteryDescription: String,
Packages:
[
String
],
P11D: 0,
Prices:
[
{
Id: String,
Description: String,
Net: 0,
VAT: 0,
Gross: 0,
Product: LIST_PRICE
}
],
VehicleClass: String,
ProductRange: String,
VehicleType: String,
Emission: 0,
Baumuster: String,
IsSellable: False,
Bm7NST: String,
ElectricRange: 0,
ElectricConsumption: 0,
IsDisplayStock: False,
DisplayRetailer_Id: 0,
DisplayRetailer: String,
DisplayRetailerGssnId: String,
Retailer:
{
Id: 0,
GssnId: String,
Description: String,
Street: String,
City: String,
Postcode: String,
GoogleMapPostcode: String,
Phone: String,
Fax: String,
Email: String,
Website: String,
RetailerGroupId: String,
RetailerGroupName: String,
IsOnline: False,
IsNewCarRetailer: False,
IsUsedCarRetailer: False,
IsCentralRetailer: False,
ChatEnabled: False,
TradeInEnabled: False,
smart: False,
DisplayPhoneNumberNew: String,
DisplayPhoneNumberUsed: String,
Latitude: 0,
Longitude: 0,
smartDescription: String,
smartWebsite: String,
smartPhone: String,
LegacyId: String,
Agent: False,
MarketAreaId: 0,
DigitalLoungeParentGssnId: String,
SendLeadsToDigitalLoungeParent: False,
OpeningTimes:
{
New:
[
{
Day: String,
OpenFrom: String,
OpenTo: String,
Special: String
}
],
Used:
[
{
Day: String,
OpenFrom: String,
OpenTo: String,
Special: String
}
]
}
},
Age: 0,
ModelYearCode: String,
HalfModelYearCode: String,
FullModelYearCode: String,
ProductionDate: String,
ChassisNumber: String,
EligibleForIntegratedServiceCare: False,
Vin: String
},
Guid: String,
Status: 0,
CustomerId: String,
Id: 0,
Reference: String,
Agent: String,
Gssn: String,
CreationDate: 0001-01-01,
MaintenanceDate: 0001-01-01,
CustomerCriteria: String,
AgentCriteria: String,
History:
[
{
Status: 0,
CommissionNumber: String,
VIN: String,
CustomerCriteria: String,
AgentCriteria: String,
CreationDate: 0001-01-01,
MaintenanceDate: 0001-01-01,
GasId: String,
Sellable: False,
AdditionalInformation: String,
Reason: String,
ConfigCode: String,
FleetBaseOrder: String,
AssistanceDetail: String,
AssistanceProvider: String,
LinkedByUserType: String,
MotabilityVTN: String,
MotabilityBackOrderDropDown: String,
MotabilityValidFrom: 0001-01-01,
MotabilityValidTo: 0001-01-01
}
],
IsAllocatedToOrder: False,
Vin: String,
CommissionNumber: String,
Order:
{
Guid: 00000000000000000000000000000000,
Reference: String,
Status: 0,
CustomerId: String,
MulesoftReference: String,
GasId: String,
OrderDate: String,
OfferSnapShot: String
},
Source: String,
Specialist: False,
OutrightPurchase: False,
Sellable: False,
MulesoftReference: String,
AdditionalInformation: String,
ConfigCode: String,
FleetBaseOrder: String,
GasId: String,
OutrightPurchaseCustomerIdentifier: String,
Retailer:
{
Id: 0,
GssnId: String,
Description: String,
Street: String,
City: String,
Postcode: String,
GoogleMapPostcode: String,
Phone: String,
Fax: String,
Email: String,
Website: String,
RetailerGroupId: String,
RetailerGroupName: String,
IsOnline: False,
IsNewCarRetailer: False,
IsUsedCarRetailer: False,
IsCentralRetailer: False,
ChatEnabled: False,
TradeInEnabled: False,
smart: False,
DisplayPhoneNumberNew: String,
DisplayPhoneNumberUsed: String,
Latitude: 0,
Longitude: 0,
smartDescription: String,
smartWebsite: String,
smartPhone: String,
LegacyId: String,
Agent: False,
MarketAreaId: 0,
DigitalLoungeParentGssnId: String,
SendLeadsToDigitalLoungeParent: False,
OpeningTimes:
{
New:
[
{
Day: String,
OpenFrom: String,
OpenTo: String,
Special: String
}
],
Used:
[
{
Day: String,
OpenFrom: String,
OpenTo: String,
Special: String
}
]
}
},
CustomerMode: 0,
CanEdit: False,
DigitalLoungeGssnId: String,
DigitalLounge: String,
Motability: False,
MotabilityPricing:
{
MotabilityPricingStatus: Pending,
Id: 0,
CriteriaBM7NST: String,
VTN: String,
BackOrderDropDown: String,
CriteriaFullModelYearCode: String,
CriteriaValidOptionCodes: String,
CriteriaInvalidOptionCodes: String,
PIPNet: 0,
PIPVat: 0,
PIPGross: 0,
WPMSNet: 0,
WPMSVat: 0,
WPMSGross: 0,
DiscountNet: 0,
DiscountVat: 0,
DiscountGross: 0,
ListPriceNet: 0,
ListPriceVat: 0,
ListPriceGross: 0,
DeliveryChargeNet: 0,
DeliveryChargeVat: 0,
DeliveryChargeGross: 0,
FuelChargeNet: 0,
FuelChargeVat: 0,
FuelChargeGross: 0,
NumberPlateFeeNet: 0,
NumberPlateFeeVat: 0,
NumberPlateFeeGross: 0,
FirstRegistrationFeeNet: 0,
FirstRegistrationFeeVat: 0,
FirstRegistrationFeeGross: 0,
RoadFundLicenceNet: 0,
RoadFundLicenceVat: 0,
RoadFundLicenceGross: 0,
ValidFrom: 0001-01-01,
ValidTo: 0001-01-01
},
LinkedByUserType: String,
AssistanceProviderId: 0,
AssistanceProvider: String,
AssistanceDetail: String,
LastAssistanceMessageDate: 0001-01-01,
LastAssistanceUser: String,
IsCOPConverter: False,
IsEligibleCOPConverter: False,
CarConfigurator:
{
Id: 0,
BackOrderId: 0,
ConfiguratorCode: String,
GasId: String,
Status: 0,
DateOfLastUpdate: 0001-01-01,
LastExceptionMessage: String,
LastException: String
},
CarConfiguratorResponse:
{
Name: String,
KeyInformation:
{
BM7NST: String,
ConfigurationDate: String,
ModelYear: String,
HalfYear: String
},
OrderingOptions:
{
Interior:
[
String
],
Exterior:
[
String
],
Other:
[
String
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
ConfiguratorCode: String
}
}
],
FeatureStatus:
{
AgencyEnabled: False
}
}