Preparing search index...
The search index is not available
Unchained Engine Types
Unchained Engine Types
orders
OrderMutations
Interface OrderMutations
Hierarchy
OrderMutations
Index
Properties
create
delete
init
Providers
invalidate
Providers
set
Delivery
Provider
set
Payment
Provider
update
Billing
Address
update
Calculation
update
Contact
update
Context
update
Status
Properties
create
create
:
(
(
doc
:
{
billingAddress
?:
Address
;
contact
?:
Contact
;
countryCode
:
string
;
currency
:
string
;
orderNumber
?:
string
;
originEnrollmentId
?:
string
}
, userId
?:
string
)
=>
Promise
<
Order
>
)
Type declaration
(
doc
:
{
billingAddress
?:
Address
;
contact
?:
Contact
;
countryCode
:
string
;
currency
:
string
;
orderNumber
?:
string
;
originEnrollmentId
?:
string
}
, userId
?:
string
)
:
Promise
<
Order
>
Parameters
doc:
{
billingAddress
?:
Address
;
contact
?:
Contact
;
countryCode
:
string
;
currency
:
string
;
orderNumber
?:
string
;
originEnrollmentId
?:
string
}
Optional
billing
Address
?:
Address
Optional
contact
?:
Contact
country
Code
:
string
currency
:
string
Optional
order
Number
?:
string
Optional
origin
Enrollment
Id
?:
string
Optional
userId:
string
Returns
Promise
<
Order
>
delete
delete
:
(
(
orderId
:
string
, userId
?:
string
)
=>
Promise
<
number
>
)
Type declaration
(
orderId
:
string
, userId
?:
string
)
:
Promise
<
number
>
Parameters
orderId:
string
Optional
userId:
string
Returns
Promise
<
number
>
init
Providers
init
Providers
:
(
(
order
:
Order
, requestContext
:
Context
)
=>
Promise
<
Order
>
)
Type declaration
(
order
:
Order
, requestContext
:
Context
)
:
Promise
<
Order
>
Parameters
order:
Order
requestContext:
Context
Returns
Promise
<
Order
>
invalidate
Providers
invalidate
Providers
:
(
(
unchainedAPI
:
UnchainedCore
, maxAgeDays
:
number
)
=>
Promise
<
void
>
)
Type declaration
(
unchainedAPI
:
UnchainedCore
, maxAgeDays
:
number
)
:
Promise
<
void
>
Parameters
unchainedAPI:
UnchainedCore
maxAgeDays:
number
Returns
Promise
<
void
>
set
Delivery
Provider
set
Delivery
Provider
:
(
(
orderId
:
string
, deliveryProviderId
:
string
, requestContext
:
Context
)
=>
Promise
<
Order
>
)
Type declaration
(
orderId
:
string
, deliveryProviderId
:
string
, requestContext
:
Context
)
:
Promise
<
Order
>
Parameters
orderId:
string
deliveryProviderId:
string
requestContext:
Context
Returns
Promise
<
Order
>
set
Payment
Provider
set
Payment
Provider
:
(
(
orderId
:
string
, paymentProviderId
:
string
, requestContext
:
Context
)
=>
Promise
<
Order
>
)
Type declaration
(
orderId
:
string
, paymentProviderId
:
string
, requestContext
:
Context
)
:
Promise
<
Order
>
Parameters
orderId:
string
paymentProviderId:
string
requestContext:
Context
Returns
Promise
<
Order
>
update
Billing
Address
update
Billing
Address
:
(
(
orderId
:
string
, billingAddress
:
Address
, requestContext
:
Context
)
=>
Promise
<
Order
>
)
Type declaration
(
orderId
:
string
, billingAddress
:
Address
, requestContext
:
Context
)
:
Promise
<
Order
>
Parameters
orderId:
string
billingAddress:
Address
requestContext:
Context
Returns
Promise
<
Order
>
update
Calculation
update
Calculation
:
(
(
orderId
:
string
, requestContext
:
Context
)
=>
Promise
<
Order
>
)
Type declaration
(
orderId
:
string
, requestContext
:
Context
)
:
Promise
<
Order
>
Parameters
orderId:
string
requestContext:
Context
Returns
Promise
<
Order
>
update
Contact
update
Contact
:
(
(
orderId
:
string
, contact
:
Contact
, requestContext
:
Context
)
=>
Promise
<
Order
>
)
Type declaration
(
orderId
:
string
, contact
:
Contact
, requestContext
:
Context
)
:
Promise
<
Order
>
Parameters
orderId:
string
contact:
Contact
requestContext:
Context
Returns
Promise
<
Order
>
update
Context
update
Context
:
(
(
orderId
:
string
, context
:
any
, requestContext
:
Context
)
=>
Promise
<
boolean
>
)
Type declaration
(
orderId
:
string
, context
:
any
, requestContext
:
Context
)
:
Promise
<
boolean
>
Parameters
orderId:
string
context:
any
requestContext:
Context
Returns
Promise
<
boolean
>
update
Status
update
Status
:
(
(
orderId
:
string
, params
:
{
info
?:
string
;
status
:
OrderStatus
}
, requestContext
:
Context
)
=>
Promise
<
Order
>
)
Type declaration
(
orderId
:
string
, params
:
{
info
?:
string
;
status
:
OrderStatus
}
, requestContext
:
Context
)
:
Promise
<
Order
>
Parameters
orderId:
string
params:
{
info
?:
string
;
status
:
OrderStatus
}
Optional
info
?:
string
status
:
OrderStatus
requestContext:
Context
Returns
Promise
<
Order
>
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
Modules
Unchained
Engine
Types
accounts
api
assortments
assortments.media
bookmarks
common
core
countries
currencies
delivery
delivery.pricing
discount
enrollments
events
files
filters
index
index
languages
logs
messaging
modules
orders
orders.deliveries
orders.discounts
orders.payments
orders.positions
orders.pricing
payments
payments.pricing
platform
pricing
products
products.media
products.pricing
products.reviews
products.variations
quotations
roles
services
user
warehousing
worker
Order
Mutations
create
delete
init
Providers
invalidate
Providers
set
Delivery
Provider
set
Payment
Provider
update
Billing
Address
update
Calculation
update
Contact
update
Context
update
Status