urembo-hub-api
Preparing search index...
orders/orders.controller
OrdersController
Class OrdersController
Index
Constructors
constructor
Methods
cancel
Order
complete
Order
confirm
Order
create
Authenticated
Order
create
Order
dispute
Order
get
All
Orders
get
Order
By
Id
get
Order
Items
By
Retailer
Id
get
Orders
By
Status
get
Orders
By
User
get
Service
Appointments
By
Vendor
Id
get
User
Orders
update
Order
update
Service
Appointment
Status
Constructors
constructor
new
OrdersController
(
ordersService
:
OrdersService
)
:
OrdersController
Parameters
ordersService
:
OrdersService
Returns
OrdersController
Methods
cancel
Order
cancelOrder
(
id
:
string
,
req
:
any
,
body
:
CancelOrderDto
,
)
:
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
req
:
any
body
:
CancelOrderDto
Returns
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
complete
Order
completeOrder
(
id
:
string
,
req
:
any
,
)
:
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
req
:
any
Returns
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
confirm
Order
confirmOrder
(
id
:
string
,
req
:
any
,
)
:
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
req
:
any
Returns
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
create
Authenticated
Order
createAuthenticatedOrder
(
req
:
any
,
createOrderDto
:
CreateOrderDto
,
)
:
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
shipments
:
(
{
statusUpdates
:
{
id
:
string
;
location
:
string
;
metadata
:
JsonValue
;
notes
:
string
;
previousStatus
:
shipment_status
;
shipmentId
:
string
;
status
:
shipment_status
;
updatedAt
:
Date
;
updatedBy
:
string
;
}
[]
;
}
&
{
actualDeliveryDate
:
Date
;
createdAt
:
Date
;
createdBy
:
string
;
deliveryAddress
:
JsonValue
;
deliveryNotes
:
string
;
deliveryPartner
:
string
;
estimatedDeliveryDate
:
Date
;
id
:
string
;
orderId
:
string
;
shipmentNumber
:
string
;
trackingNumber
:
string
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
req
:
any
createOrderDto
:
CreateOrderDto
Returns
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
shipments
:
(
{
statusUpdates
:
{
id
:
string
;
location
:
string
;
metadata
:
JsonValue
;
notes
:
string
;
previousStatus
:
shipment_status
;
shipmentId
:
string
;
status
:
shipment_status
;
updatedAt
:
Date
;
updatedBy
:
string
;
}
[]
;
}
&
{
actualDeliveryDate
:
Date
;
createdAt
:
Date
;
createdBy
:
string
;
deliveryAddress
:
JsonValue
;
deliveryNotes
:
string
;
deliveryPartner
:
string
;
estimatedDeliveryDate
:
Date
;
id
:
string
;
orderId
:
string
;
shipmentNumber
:
string
;
trackingNumber
:
string
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
create
Order
createOrder
(
createOrderDto
:
CreateOrderDto
,
)
:
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
shipments
:
(
{
statusUpdates
:
{
id
:
string
;
location
:
string
;
metadata
:
JsonValue
;
notes
:
string
;
previousStatus
:
shipment_status
;
shipmentId
:
string
;
status
:
shipment_status
;
updatedAt
:
Date
;
updatedBy
:
string
;
}
[]
;
}
&
{
actualDeliveryDate
:
Date
;
createdAt
:
Date
;
createdBy
:
string
;
deliveryAddress
:
JsonValue
;
deliveryNotes
:
string
;
deliveryPartner
:
string
;
estimatedDeliveryDate
:
Date
;
id
:
string
;
orderId
:
string
;
shipmentNumber
:
string
;
trackingNumber
:
string
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
createOrderDto
:
CreateOrderDto
Returns
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
shipments
:
(
{
statusUpdates
:
{
id
:
string
;
location
:
string
;
metadata
:
JsonValue
;
notes
:
string
;
previousStatus
:
shipment_status
;
shipmentId
:
string
;
status
:
shipment_status
;
updatedAt
:
Date
;
updatedBy
:
string
;
}
[]
;
}
&
{
actualDeliveryDate
:
Date
;
createdAt
:
Date
;
createdBy
:
string
;
deliveryAddress
:
JsonValue
;
deliveryNotes
:
string
;
deliveryPartner
:
string
;
estimatedDeliveryDate
:
Date
;
id
:
string
;
orderId
:
string
;
shipmentNumber
:
string
;
trackingNumber
:
string
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
dispute
Order
disputeOrder
(
id
:
string
,
req
:
any
,
body
:
DisputeOrderDto
,
)
:
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
req
:
any
body
:
DisputeOrderDto
Returns
Promise
<
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
get
All
Orders
getAllOrders
(
status
?:
string
,
)
:
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
Optional
status
:
string
Returns
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
get
Order
By
Id
getOrderById
(
id
:
string
,
)
:
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
shipments
:
(
{
statusUpdates
:
{
id
:
string
;
location
:
string
;
metadata
:
JsonValue
;
notes
:
string
;
previousStatus
:
shipment_status
;
shipmentId
:
string
;
status
:
shipment_status
;
updatedAt
:
Date
;
updatedBy
:
string
;
}
[]
;
}
&
{
actualDeliveryDate
:
Date
;
createdAt
:
Date
;
createdBy
:
string
;
deliveryAddress
:
JsonValue
;
deliveryNotes
:
string
;
deliveryPartner
:
string
;
estimatedDeliveryDate
:
Date
;
id
:
string
;
orderId
:
string
;
shipmentNumber
:
string
;
trackingNumber
:
string
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
retailerId
:
string
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
shipments
:
(
{
statusUpdates
:
{
id
:
string
;
location
:
string
;
metadata
:
JsonValue
;
notes
:
string
;
previousStatus
:
shipment_status
;
shipmentId
:
string
;
status
:
shipment_status
;
updatedAt
:
Date
;
updatedBy
:
string
;
}
[]
;
}
&
{
actualDeliveryDate
:
Date
;
createdAt
:
Date
;
createdBy
:
string
;
deliveryAddress
:
JsonValue
;
deliveryNotes
:
string
;
deliveryPartner
:
string
;
estimatedDeliveryDate
:
Date
;
id
:
string
;
orderId
:
string
;
shipmentNumber
:
string
;
trackingNumber
:
string
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
get
Order
Items
By
Retailer
Id
getOrderItemsByRetailerId
(
retailerId
:
string
,
)
:
Promise
<
(
{
order
:
{
clientId
:
string
;
createdAt
:
Date
}
;
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
,
>
Parameters
retailerId
:
string
Returns
Promise
<
(
{
order
:
{
clientId
:
string
;
createdAt
:
Date
}
;
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
,
>
get
Orders
By
Status
getOrdersByStatus
(
status
:
order_status
,
)
:
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
status
:
order_status
Returns
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
get
Orders
By
User
getOrdersByUser
(
userId
:
string
,
req
:
any
,
)
:
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
userId
:
string
req
:
any
Returns
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
get
Service
Appointments
By
Vendor
Id
getServiceAppointmentsByVendorId
(
vendorId
:
string
,
status
?:
string
,
dateRange
?:
string
,
)
:
Promise
<
(
{
order
:
{
clientId
:
string
;
createdAt
:
Date
;
customerEmail
:
string
;
id
:
string
;
status
:
order_status
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
userId
:
string
;
}
;
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
vendorId
:
string
Optional
status
:
string
Optional
dateRange
:
string
Returns
Promise
<
(
{
order
:
{
clientId
:
string
;
createdAt
:
Date
;
customerEmail
:
string
;
id
:
string
;
status
:
order_status
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
userId
:
string
;
}
;
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
,
>
get
User
Orders
getUserOrders
(
req
:
any
,
)
:
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
Parameters
req
:
any
Returns
Promise
<
(
{
orderItems
:
(
{
product
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
imageUrl
:
string
;
name
:
string
;
price
:
Decimal
;
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
)
[]
,
>
update
Order
updateOrder
(
id
:
string
,
req
:
any
,
updateOrderDto
:
UpdateOrderDto
,
)
:
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
req
:
any
updateOrderDto
:
UpdateOrderDto
Returns
Promise
<
{
orderItems
:
(
{
product
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
}
&
{
createdAt
:
Date
;
currency
:
string
;
id
:
string
;
orderId
:
string
;
productId
:
string
;
quantity
:
number
;
refId
:
string
;
subtotal
:
Decimal
;
title
:
string
;
totalPrice
:
Decimal
;
type
:
string
;
unitPrice
:
Decimal
;
updatedAt
:
Date
;
}
)
[]
;
serviceAppointments
:
(
{
service
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
)
[]
;
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
,
>
update
Service
Appointment
Status
updateServiceAppointmentStatus
(
id
:
string
,
req
:
any
,
body
:
{
notes
?:
string
;
status
:
string
}
,
)
:
Promise
<
{
order
:
{
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
;
service
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Parameters
id
:
string
req
:
any
body
:
{
notes
?:
string
;
status
:
string
}
Returns
Promise
<
{
order
:
{
user
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
}
&
{
autoReleaseAt
:
Date
;
clientId
:
string
;
commissionAmount
:
Decimal
;
commissionRate
:
Decimal
;
completedAt
:
Date
;
completionConfirmedAt
:
Date
;
confirmedAt
:
Date
;
createdAt
:
Date
;
currency
:
string
;
customerEmail
:
string
;
customerPhone
:
string
;
disputedAt
:
Date
;
escrowAmount
:
Decimal
;
escrowStatus
:
string
;
id
:
string
;
manufacturerId
:
string
;
notes
:
string
;
paystackReference
:
string
;
retailerId
:
string
;
serviceId
:
string
;
serviceType
:
string
;
shippingAddress
:
JsonValue
;
status
:
order_status
;
statusEnhanced
:
order_status_enhanced
;
totalAmount
:
Decimal
;
updatedAt
:
Date
;
userId
:
string
;
vendorId
:
string
;
}
;
service
:
{
id
:
string
;
name
:
string
;
price
:
Decimal
}
;
vendor
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
}
;
}
&
{
appointmentDate
:
Date
;
createdAt
:
Date
;
currency
:
string
;
durationMinutes
:
number
;
id
:
string
;
notes
:
string
;
orderId
:
string
;
serviceId
:
string
;
servicePrice
:
Decimal
;
staffId
:
string
;
status
:
string
;
updatedAt
:
Date
;
vendorId
:
string
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
cancel
Order
complete
Order
confirm
Order
create
Authenticated
Order
create
Order
dispute
Order
get
All
Orders
get
Order
By
Id
get
Order
Items
By
Retailer
Id
get
Orders
By
Status
get
Orders
By
User
get
Service
Appointments
By
Vendor
Id
get
User
Orders
update
Order
update
Service
Appointment
Status
urembo-hub-api
Loading...