new FulfillmentOrder(shopify)
Creates a FulfillmentOrder instance.
Parameters:
| Name | Type | Description |
|---|---|---|
shopify |
Shopify | Reference to the Shopify instance |
Methods
cancel(id, params) → {Promise}
Marks a fulfillment order as cancelled.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
Number | Fulfillment order ID |
params |
Object | Fulfillment order properties |
Returns:
Promise that resolves with the result
- Type
- Promise
close(id, messageopt) → {Promise}
Marks an in progress fulfillment order as incomplete, indicating the
fulfillment service is unable to ship any remaining items and intends to
close the fulfillment order.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
Number | Fulfillment order ID | |
message |
String |
<optional> |
The reason for marking the fulfillment order as incomplete |
Returns:
Promise that resolves with the result
- Type
- Promise
list(paramsopt) → {Promise}
Retrieves a list of fulfillment orders on a shop for a specific app.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object |
<optional> |
Query parameters |
Returns:
Promise that resolves with the result
- Type
- Promise
locationsForMove(id) → {Promise}
Retrieves a list of locations that a fulfillment order can potentially move
to.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
Number | Fulfillment order ID |
Returns:
Promise that resolves with the result
- Type
- Promise
move(id, locationId) → {Promise}
Moves a fulfillment order from one merchant managed location to another
merchant managed location.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
Number | Fulfillment order ID |
locationId |
Number | The ID of the location to which the fulfillment order will be moved |
Returns:
Promise that resolves with the result
- Type
- Promise