brandon14/ebay-sdk-php

View on GitHub
src/Sell/Logistics/V1/docs/Model/Shipment.md

Summary

Maintainability
Test Coverage
# # Shipment

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cancellation** | [**\TNT\Ebay\Sell\Logistics\V1\Model\ShipmentCancellation**](ShipmentCancellation.md) |  | [optional]
**creation_date** | **string** | The date and time the shipment was created, formatted as an <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\" title=\"https://www.iso.org\" target=\"_blank\">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.  <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[HH]:[MM]:[SS].[SSS]Z</code> <br><b>Example:</b> <code>2018-08-20T07:09:00.000Z</code> | [optional]
**label_custom_message** | **string** | If supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label. | [optional]
**label_download_url** | **string** | The direct URL the seller can use to download an image of the shipping label. By default, the file format is PDF. See <a href=\"/api-docs/sell/logistics/resources/shipment/methods/downloadLabelFile\">downloadLabelFile</a> for requesting different response file formats. | [optional]
**label_size** | **string** | The seller's desired label size. The support for multi-sized labels is shipping-carrier specific and if the size requested in the <b>creaateFromShippingQuote</b> call matches a size the carrier supports, the value will be represented here in the shipment. <br><br>Currently, the only valid value is: <code>4\"x6\"</code> | [optional]
**orders** | [**\TNT\Ebay\Sell\Logistics\V1\Model\Order[]**](Order.md) | This list value is optionally assigned by the seller. When present, each element in the returned list contains seller-assigned information about an order (such as an order number). Because a package can contain all or part of one or more orders, this field provides a way for sellers to identify the packages that contain specific orders. | [optional]
**package_specification** | [**\TNT\Ebay\Sell\Logistics\V1\Model\PackageSpecification**](PackageSpecification.md) |  | [optional]
**rate** | [**\TNT\Ebay\Sell\Logistics\V1\Model\PurchasedRate**](PurchasedRate.md) |  | [optional]
**return_to** | [**\TNT\Ebay\Sell\Logistics\V1\Model\Contact**](Contact.md) |  | [optional]
**ship_from** | [**\TNT\Ebay\Sell\Logistics\V1\Model\Contact**](Contact.md) |  | [optional]
**shipment_id** | **string** | The unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to <b>createFromShippingQuote</b>. | [optional]
**shipment_tracking_number** | **string** | A unique carrier-assigned ID string that can be used to track the shipment. | [optional]
**ship_to** | [**\TNT\Ebay\Sell\Logistics\V1\Model\Contact**](Contact.md) |  | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)