mirror of
https://github.com/anikeen-com/id.git
synced 2026-11-02 13:49:30 +00:00
Document the shipment mail and notify_customer
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
6a568a5354
commit
934b1c5c3f
2 files changed
+5
-1
No files matched your search
@@ -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
|
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:
|
Without `items`, everything physical that is left is shipped; partial deliveries name the items:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
|
|||||||
@@ -27,11 +27,14 @@ class Shipments extends BaseCollection
|
|||||||
* tracking_url?: string,
|
* tracking_url?: string,
|
||||||
* note?: string,
|
* note?: string,
|
||||||
* shipped_at?: string,
|
* shipped_at?: string,
|
||||||
|
* notify_customer?: bool,
|
||||||
* items?: array<array{order_item_id: string, units?: float|int|string}>
|
* items?: array<array{order_item_id: string, units?: float|int|string}>
|
||||||
* } $attributes
|
* } $attributes
|
||||||
* - carrier: e.g. "DHL"
|
* - carrier: e.g. "DHL"
|
||||||
* - tracking_url: http(s) link to track the parcel, shown to the user
|
* - 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)
|
* - 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)
|
* - 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
|
* Errors (ResourceException with the HTTP status): 409 when the order isn't paid or nothing
|
||||||
|
|||||||
Reference in new issue
Block a user