php-shopify/lib/Fulfillment.php at master · phpclassic/php-shopify · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?php
/**
 * Created by PhpStorm.
 * @author Tareq Mahmood <tareqtms@yahoo.com>
 * Created at 8/19/16 3:04 PM UTC+06:00
 *
 * @see https://help.shopify.com/api/reference/fulfillment Shopify API Reference for Fulfillment
 */

namespace PHPShopify;


/**
 * --------------------------------------------------------------------------
 * Fulfillment -> Child Resources
 * --------------------------------------------------------------------------
 * @property-read Event $Event
 *
 * @method Event Event(integer $id = null)
 *
 * --------------------------------------------------------------------------
 * Fulfillment -> Custom actions
 * --------------------------------------------------------------------------
 * @method array complete()     Complete a fulfillment
 * @method array open()         Open a pending fulfillment
 * @method array cancel()       Cancel a fulfillment
 * @method array update_tracking(array $data) Updates the tracking information for a fulfillment.
 *
 */
class Fulfillment extends ShopifyResource
{
    /**
     * @inheritDoc
     */
    protected $resourceKey = 'fulfillment';

    /**
     * @inheritDoc
     */
    protected $childResource = array(
        'FulfillmentEvent' => 'Event',
    );

    /**
     * @inheritDoc
     */
    protected $customPostActions = array(
        'complete',
        'open',
        'cancel',
        'update_tracking',
    );
}