Interface
Versionsβ
Curerrent unified version:
| Version | Date | Changes |
|---|---|---|
| 01-06-2025 | Initial Release |
Fieldsβ
| Field | Type | Description |
|---|---|---|
| ext_plt_order_id | string | The ID of the order on the platform |
| order_create_date | string | The date the order was created |
| order_update_date | string | The date the order was updated |
| order_ship_date | string | The date the order was shipped |
| order_status | string | The status of the order |
| order_products | ccsOrderProducts[] | The products of the order |
| order_platform_name | string | The name of the platform |
| order_consumer | ccsOrderConsumer | The consumer of the order |
| ext_ship_method | string | The shipping method of the order |
| ext_order_comment | string | The comment of the order |
| order_country_code | string | The country code of the order |
| ccsOrderConsumer | ||
| consumer_postal_code | string | The postal code of the consumer |
| consumer_city | string | The city of the consumer |
| consumer_firstname | string | The first name of the consumer |
| consumer_email | string | The email of the consumer |
| consumer_phone | string | The phone number of the consumer |
| consumer_street | string | The street of the consumer |
| consumer_house_number | string | The house number of the consumer |
| consumer_state | string | The state of the consumer |
| consumer_house_number_ex | string | The house number extension of the consumer |
| consumer_company_name | string | The company name of the consumer |
| consumer_lastname | string | The last name of the consumer |
| consumer_country_code | string | The country code of the consumer |
| ccsOrderProducts | ||
| ext_cdk_product_id | number | The ID of the product on the platform |
| product_ean | string | The EAN of the product |
| product_sku | string | The SKU of the product |
| product_qty | number | The quantity of the product |
| product_reference | string | The reference of the product |
| product_name | string | The name of the product |
| product_image | string | The image of the product |
| product_price | number | The price of the product |
| product_weight | number | The weight of the product |
| product_width | number | The width of the product |
| product_height | number | The height of the product |
| product_length | number | The length of the product |
| order_delivery_date | string | The delivery date of the product |
| order_cancellation_req | number | The cancellation request of the product |
| product_status | string | The status of the product |
| label_id | string | The label ID of the product |
| fulfillment_status | number | The fulfillment status of the product |
Functionsβ
| Function | Description |
|---|---|
| createOrder | Creates an order |
| getOrder | Gets an order |
| updateOrder | Updates an order |
| mapOrderData | Maps the order data |
| mapProductData | Maps the product data |
| getProducts | Gets the products |
| updateProduct | Updates 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;
}