diff --git a/README.md b/README.md index ef8e7b6..cb7524a 100644 --- a/README.md +++ b/README.md @@ -197,7 +197,8 @@ $order = $user->orders()->create([ ``` Once a paid order is sent, create a shipment. Anikeen ID adds its delivery note to the user's -order documents (with the tracking link) and sends `order.shipped` to your webhook endpoints. +order documents (with the tracking link), mails it to the user (`'notify_customer' => false` if +your shop sends its own mail) and sends `order.shipped` to your webhook endpoints. Without `items`, everything physical that is left is shipped; partial deliveries name the items: ```php diff --git a/src/Id/Resources/Shipments.php b/src/Id/Resources/Shipments.php index 492725d..8c6e03b 100644 --- a/src/Id/Resources/Shipments.php +++ b/src/Id/Resources/Shipments.php @@ -27,11 +27,14 @@ class Shipments extends BaseCollection * tracking_url?: string, * note?: string, * shipped_at?: string, + * notify_customer?: bool, * items?: array * } $attributes * - carrier: e.g. "DHL" * - tracking_url: http(s) link to track the parcel, shown to the user * - shipped_at: when it was sent (default: now, not in the future) + * - notify_customer: Anikeen ID mails the user with the delivery note (default true); + * false if your shop sends its own mail * - items: physical items of the order and how many of them (default: all left) * * Errors (ResourceException with the HTTP status): 409 when the order isn't paid or nothing