OrderFulfillmentShipmentDetails
August 15, 2019 ยท View on GitHub
Description
Contains details necessary to fulfill a shipment order.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| recipient | getRecipient() | setRecipient($value) | \SquareConnect\Model\OrderFulfillmentRecipient | Information on the person meant to receive this shipment fulfillment. | [optional] |
| carrier | getCarrier() | setCarrier($value) | string | The shipping carrier being used to ship this fulfillment e.g. UPS, FedEx, USPS, etc. | [optional] |
| shipping_note | getShippingNote() | setShippingNote($value) | string | A note with additional information for the shipping carrier. | [optional] |
| shipping_type | getShippingType() | setShippingType($value) | string | A description of the type of shipping product purchased from the carrier. e.g. First Class, Priority, Express | [optional] |
| tracking_number | getTrackingNumber() | setTrackingNumber($value) | string | The reference number provided by the carrier to track the shipment's progress. | [optional] |
| tracking_url | getTrackingUrl() | setTrackingUrl($value) | string | A link to the tracking webpage on the carrier's website. | [optional] |
| placed_at | getPlacedAt() | setPlacedAt($value) | string | The timestamp indicating when the shipment was requested. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| in_progress_at | getInProgressAt() | setInProgressAt($value) | string | The timestamp indicating when this fulfillment was moved to the `RESERVED` state. Indicates that preparation of this shipment has begun. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| packaged_at | getPackagedAt() | setPackagedAt($value) | string | The timestamp indicating when this fulfillment was moved to the `PREPARED` state. Indicates that the fulfillment is packaged. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| expected_shipped_at | getExpectedShippedAt() | setExpectedShippedAt($value) | string | The timestamp indicating when the shipment is expected to be delivered to the shipping carrier. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| shipped_at | getShippedAt() | setShippedAt($value) | string | The timestamp indicating when this fulfillment was moved to the `COMPLETED`state. Indicates that the fulfillment has been given to the shipping carrier. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| canceled_at | getCanceledAt() | setCanceledAt($value) | string | The timestamp indicating the shipment was canceled. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| cancel_reason | getCancelReason() | setCancelReason($value) | string | A description of why the shipment was canceled. | [optional] |
| failed_at | getFailedAt() | setFailedAt($value) | string | The timestamp indicating when the shipment failed to be completed. Must be in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | [optional] |
| failure_reason | getFailureReason() | setFailureReason($value) | string | A description of why the shipment failed to be completed. | [optional] |
Note: All properties are protected and only accessed via getters and setters.