UserOrderDetails¶
UserOrderDetails extends UserOrder with detailed information about a specific order. This model includes all fields from UserOrder plus additional details such as payment information, shipping details, addresses, products, parcels, and custom fields. It consists of the following fields:
Basic Fields (inherited from UserOrder)¶
- confirm:
boolean - date:
string - isDigital:
boolean - isOverpayment:
boolean - isPaid:
boolean - isUnderpayment:
boolean - id:
number - registered:
string - sum:
string - sumFloat:
number - totalProducts:
number - status:
TUserOrderStatus
Additional Fields¶
- paid:
string- Paid amount as string - paidFloat:
number- Paid amount as float - productsCost:
string- Total products cost as string - productsCostFloat:
number- Total products cost as float - discounts:
string- Total discounts as string - discountsFloat:
number- Total discounts as float - shippingVatValue:
number- VAT value for shipping - currencyId:
number- Currency ID - currency:
string- Currency code - payment:
TUserOrderPayment- Payment information - shipping:
TUserOrderShipping- Shipping information - billingAddress:
TUserOrderAddress- Billing address - deliveryAddress:
TUserOrderAddress- Delivery address - products:
TUserOrderProduct[]- Array of ordered products - parcels:
TUserOrderParcel[]- Array of parcels - additionalFields:
TUserOrderAdditionalField[]- Array of custom fields
TUserOrderPayment¶
Represents payment information and consists of the following fields:
- paymentId:
number - type:
string - name:
string - translation:
TUserOrderPaymentTranslation - isStarted:
boolean(optional) - isFinished:
boolean(optional) - isProcessing:
boolean(optional)
TUserOrderPaymentTranslation¶
- name:
string - description:
string - langId:
number
TUserOrderShipping¶
Represents shipping information and consists of the following fields:
- shippingId:
number - vatValue:
number - vatName:
string - cost:
string - costFloat:
number - translation:
TUserOrderShippingTranslation(optional)
TUserOrderShippingTranslation¶
- name:
string - description:
string - langId:
number
TUserOrderAddress¶
Represents address information and consists of the following fields:
- name:
string - surname:
string - street:
string - house:
string - local:
string - coname:
string - nip:
string - pesel:
string - phone:
string - otherAddress:
string - city:
string - zip:
string - state:
string - country:
string - type:
number
TUserOrderProduct¶
Represents a product in the order and consists of the following fields:
- productId:
number - stockId:
number - code:
string - pkwiu:
string - name:
string - promoDesc:
string - producerName:
string - producerSite:
string - ean:
string - discountPerc:
number - quantity:
number - price:
string - priceFloat:
number - sum:
string - sumFloat:
number - taxValue:
number - taxName:
string - deliveryTime:
number - deliveryTimeHours:
number - weight:
number - unit:
{ name: string; floatingPoint: number; } - textOptions:
TUserOrderProductTextOption[] - fileOptions:
TUserOrderProductFileOption[] - image:
string
TUserOrderProductTextOption¶
- name:
string - value:
string
TUserOrderProductFileOption¶
- name:
string - title:
string
TUserOrderParcel¶
Represents parcel tracking information and consists of the following fields:
- url:
string - code:
string - date:
string
TUserOrderAdditionalField¶
Represents custom order fields and consists of the following fields:
- fieldId:
number - name:
string - type:
number - locate:
number - req:
boolean - fieldValue:
string | null - value:
string | null