new FulfillmentEvent(shopify)
Creates a FulfillmentEvent instance.
Parameters:
| Name | Type | Description |
|---|---|---|
shopify |
Shopify | Reference to the Shopify instance |
Methods
create(orderId, fulfillmentId, params) → {Promise}
Creates a fulfillment event.
Parameters:
| Name | Type | Description |
|---|---|---|
orderId |
Number | Order ID |
fulfillmentId |
Number | Fulfillment ID |
params |
Object | Fulfillment event properties |
Returns:
Promise that resolves with the result
- Type
- Promise
delete(orderId, fulfillmentId, id) → {Promise}
Deletes a fulfillment event.
Parameters:
| Name | Type | Description |
|---|---|---|
orderId |
Number | Order ID |
fulfillmentId |
Number | Fulfillment ID |
id |
Number | Fulfillment event ID |
Returns:
Promise that resolves with the result
- Type
- Promise
get(orderId, fulfillmentId, id) → {Promise}
Gets a single fulfillment event by its ID.
Parameters:
| Name | Type | Description |
|---|---|---|
orderId |
Number | Order ID |
fulfillmentId |
Number | Fulfillment ID |
id |
Number | Fulfillment event ID |
Returns:
Promise that resolves with the result
- Type
- Promise
list(orderId, fulfillmentId, paramsopt) → {Promise}
Gets a list of fulfillment events for a fulfillment.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
orderId |
Number | Order ID | |
fulfillmentId |
Number | Fulfillment ID | |
params |
Object |
<optional> |
Query parameters |
Returns:
Promise that resolves with the result
- Type
- Promise
update(orderId, fulfillmentId, id, params) → {Promise}
Updates a fulfillment event.
Parameters:
| Name | Type | Description |
|---|---|---|
orderId |
Number | Order ID |
fulfillmentId |
Number | Fulfillment ID |
id |
Number | Fulfillment event ID |
params |
Object | Fulfillment event properties |
Returns:
Promise that resolves with the result
- Type
- Promise