Skip to main content

Interface

Versions​

Curerrent unified version: unified version

VersionDateChanges
unified version01-06-2025Initial Release

Fields​

FieldTypeDescription
ext_plt_order_idstringThe ID of the order on the platform
order_create_datestringThe date the order was created
order_update_datestringThe date the order was updated
order_ship_datestringThe date the order was shipped
order_statusstringThe status of the order
order_productsccsOrderProducts[]The products of the order
order_platform_namestringThe name of the platform
order_consumerccsOrderConsumerThe consumer of the order
ext_ship_methodstringThe shipping method of the order
ext_order_commentstringThe comment of the order
order_country_codestringThe country code of the order
ccsOrderConsumer
consumer_postal_codestringThe postal code of the consumer
consumer_citystringThe city of the consumer
consumer_firstnamestringThe first name of the consumer
consumer_emailstringThe email of the consumer
consumer_phonestringThe phone number of the consumer
consumer_streetstringThe street of the consumer
consumer_house_numberstringThe house number of the consumer
consumer_statestringThe state of the consumer
consumer_house_number_exstringThe house number extension of the consumer
consumer_company_namestringThe company name of the consumer
consumer_lastnamestringThe last name of the consumer
consumer_country_codestringThe country code of the consumer
ccsOrderProducts
ext_cdk_product_idnumberThe ID of the product on the platform
product_eanstringThe EAN of the product
product_skustringThe SKU of the product
product_qtynumberThe quantity of the product
product_referencestringThe reference of the product
product_namestringThe name of the product
product_imagestringThe image of the product
product_pricenumberThe price of the product
product_weightnumberThe weight of the product
product_widthnumberThe width of the product
product_heightnumberThe height of the product
product_lengthnumberThe length of the product
order_delivery_datestringThe delivery date of the product
order_cancellation_reqnumberThe cancellation request of the product
product_statusstringThe status of the product
label_idstringThe label ID of the product
fulfillment_statusnumberThe fulfillment status of the product

Functions​

FunctionDescription
createOrderCreates an order
getOrderGets an order
updateOrderUpdates an order
mapOrderDataMaps the order data
mapProductDataMaps the product data
getProductsGets the products
updateProductUpdates a product

TS interface​

export interface ccsOrder {
ext_plt_order_id: string;
order_create_date: Date;
order_update_date: Date;
order_ship_date: Date;
order_status: string;
order_products: ccsOrderProducts[];
order_platform_name: string;
order_consumer: ccsOrderConsumer;
ext_ship_method: string;
ext_order_comment: string | null;
order_country_code: string;
}

export interface ccsOrderConsumer {
consumer_postal_code: string;
consumer_city: string;
consumer_firstname: string;
consumer_email: string;
consumer_phone: string;
consumer_street: string;
consumer_house_number: string;
consumer_state: string;
consumer_house_number_ex: string;
consumer_company_name: string;
consumer_lastname: string;
consumer_country_code: string;
}

export interface ccsOrderProducts {
ext_cdk_product_id: number;
product_ean: string;
product_sku: string;
product_qty: number;
product_reference: string;
product_name: string;
product_image: string;
product_price: number;
product_weight: number;
product_width: number;
product_height: number;
product_length: number;
order_delivery_date: Date;
order_cancellation_req: number;
product_status: string;
label_id: string;
fulfillment_status: number;
}