Inherits from NSObject
Conforms to PicoBindable
Declared in Trading_ShipmentType.h
Trading_ShipmentType.m

Overview

Type defining the Shipment container, which is used by
the seller in CompleteSale to provide shipping information. The
Shipment container is also returned in the
GetSellingManagerSaleRecord response.

@ingroup EBayAPIInterface

Tasks

  •   estimatedDeliveryDate

    (public property)

         property
  •   insuredValue

    (public property)

         property
  •   packageDepth

    Depth dimension of the package needed to ship the item after it is sold.


    For calculated shipping only.

         property
  •   packageLength

    Length dimension of the package needed to ship the item after it is sold.


    For calculated shipping only.

         property
  •   packageWidth

    Width dimension of the package needed to ship the item after it is sold.


    For calculated shipping only.

         property
  •   payPalShipmentID

    (public property)

         property
  •   shipmentID

    (public property)

         property
  •   postageTotal

    (public property)

         property
  •   printedTime

    (public property)

         property
  •   shipFromAddress

    The address from which the item is being shipped.

         property
  •   shippingAddress

    The address to which the item is to be shipped.

         property
  •   shippingCarrierUsed

    The shipping carrier used to ship the package. This value can be any
    combination of alphanumeric characters and it is not checked and verified by
    eBay. This field is required if ShipmentTrackingNumber is included in the
    call request.



    ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other.
    You must either specify both, or specify neither.

         property
  •   shippingFeature

    (public property)

         property
  •   shippingPackage

    The size of the package used to ship the item(s). See ShippingPackageCodeType
    for its possible values. Input.

         property
  •   shippingServiceUsed

    The size of the package used to ship the item(s). See ShippingPackageCodeType
    for its possible values. Input.

         property
  •   shipmentTrackingNumber

    The tracking number associated with one package of a shipment. The seller is
    responsible for the accuracy of the shipment tracking number. eBay verifies
    the tracking number is unique (across all of a seller’s orders) and consistent
    with the numbering scheme used by the specified shipping carrier. eBay cannot
    verify the accuracy of the tracking number. This field is required if
    ShippingCarrierUsed is included in the call request.



    Sellers can specify multiple tracking numbers for the same ShippingCarrierUsed
    by separating the tracking numbers with commas.



    ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other.
    You must either specify both, or specify neither.

         property
  •   weightMajor

    See the documentation regarding “Working with Item Weights”.
    The ‘unit’ attribute can have a value of lbs.

         property
  •   weightMinor

    See the documentation regarding “Working with Item Weights”.
    The ‘unit’ attribute is optional and assumed to be the
    minor compared to the value of ‘unit’ in WeightMajor.

         property
  •   itemTransactionID

    (public property)

         property
  •   deliveryDate

    Revise only

         property
  •   deliveryStatus

    Revise only

         property
  •   refundGrantedTime

    Revise only

         property
  •   refundRequestedTime

    Revise only

         property
  •   status

    Status, for revise only

         property
  •   shippedTime

    The date and time that the seller handed off the package(s) to the shipping
    carrier. If this field is not included in the request, the timestamp of the call
    execution is used as the shipped time. Note that sellers have the ability to set
    this value up to 3 calendar days in the future.

         property
  •   notes

    This string field allows a seller to provide notes to the buyer regarding shipment of a
    Half.com item. Only alphanumeric characters can be used in this field. This is an optional
    field that is only applicable to Half.com items.

         property
  •   shipmentTrackingDetails

    Container consisting of the tracking number and shipping carrier associated with
    the shipment of one item (package).



    Because an order can have multiple line items and/or packages, there can be
    multiple ShipmentTrackingDetails containers under the
    Shipment container.

         property
  •   shipmentLineItem 
                   Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of <strong>ShippingCarrierUsed</strong> is <code>GlobalShipping_MultiCarrier</code>.
    property
  •   any

    (public property)

         property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_ShipmentType.h

deliveryDate

Revise only

@property (nonatomic, retain) NSDate *deliveryDate

Discussion

Revise only

type : NSDate, wrapper for primitive date

Declared In

Trading_ShipmentType.h

deliveryStatus

Revise only

@property (nonatomic, retain) NSString *deliveryStatus

Discussion

Revise only

type: string constant in Trading_ShipmentDeliveryStatusCodeType.h

Declared In

Trading_ShipmentType.h

estimatedDeliveryDate

(public property)

@property (nonatomic, retain) NSDate *estimatedDeliveryDate

Discussion

(public property)

type : NSDate, wrapper for primitive date

Declared In

Trading_ShipmentType.h

insuredValue

(public property)

@property (nonatomic, retain) Trading_AmountType *insuredValue

Discussion

(public property)

type : class Trading_AmountType

Declared In

Trading_ShipmentType.h

itemTransactionID

(public property)

@property (nonatomic, retain) NSMutableArray *itemTransactionID

Discussion

(public property)

entry type : class Trading_ItemTransactionIDType

Declared In

Trading_ShipmentType.h

notes

This string field allows a seller to provide notes to the buyer regarding shipment of a
Half.com item. Only alphanumeric characters can be used in this field. This is an optional
field that is only applicable to Half.com items.

@property (nonatomic, retain) NSString *notes

Discussion

This string field allows a seller to provide notes to the buyer regarding shipment of a
Half.com item. Only alphanumeric characters can be used in this field. This is an optional
field that is only applicable to Half.com items.

type : NSString, wrapper for primitive string

Declared In

Trading_ShipmentType.h

packageDepth

Depth dimension of the package needed to ship the item after it is sold.


For calculated shipping only.

@property (nonatomic, retain) Trading_MeasureType *packageDepth

Discussion

Depth dimension of the package needed to ship the item after it is sold.


For calculated shipping only.

type : class Trading_MeasureType

Declared In

Trading_ShipmentType.h

packageLength

Length dimension of the package needed to ship the item after it is sold.


For calculated shipping only.

@property (nonatomic, retain) Trading_MeasureType *packageLength

Discussion

Length dimension of the package needed to ship the item after it is sold.


For calculated shipping only.

type : class Trading_MeasureType

Declared In

Trading_ShipmentType.h

packageWidth

Width dimension of the package needed to ship the item after it is sold.


For calculated shipping only.

@property (nonatomic, retain) Trading_MeasureType *packageWidth

Discussion

Width dimension of the package needed to ship the item after it is sold.


For calculated shipping only.

type : class Trading_MeasureType

Declared In

Trading_ShipmentType.h

payPalShipmentID

(public property)

@property (nonatomic, retain) NSString *payPalShipmentID

Discussion

(public property)

type : NSString, wrapper for primitive string

Declared In

Trading_ShipmentType.h

postageTotal

(public property)

@property (nonatomic, retain) Trading_AmountType *postageTotal

Discussion

(public property)

type : class Trading_AmountType

Declared In

Trading_ShipmentType.h

printedTime

(public property)

@property (nonatomic, retain) NSDate *printedTime

Discussion

(public property)

type : NSDate, wrapper for primitive date

Declared In

Trading_ShipmentType.h

refundGrantedTime

Revise only

@property (nonatomic, retain) NSDate *refundGrantedTime

Discussion

Revise only

type : NSDate, wrapper for primitive date

Declared In

Trading_ShipmentType.h

refundRequestedTime

Revise only

@property (nonatomic, retain) NSDate *refundRequestedTime

Discussion

Revise only

type : NSDate, wrapper for primitive date

Declared In

Trading_ShipmentType.h

shipFromAddress

The address from which the item is being shipped.

@property (nonatomic, retain) Trading_AddressType *shipFromAddress

Discussion

The address from which the item is being shipped.

type : class Trading_AddressType

Declared In

Trading_ShipmentType.h

shipmentID

(public property)

@property (nonatomic, retain) NSNumber *shipmentID

Discussion

(public property)

type : NSNumber, wrapper for primitive long

Declared In

Trading_ShipmentType.h

shipmentLineItem

               Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of <strong>ShippingCarrierUsed</strong> is <code>GlobalShipping_MultiCarrier</code>.
@property (nonatomic, retain) Trading_ShipmentLineItemType *shipmentLineItem

Discussion

               Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of <strong>ShippingCarrierUsed</strong> is <code>GlobalShipping_MultiCarrier</code>.

type : class Trading_ShipmentLineItemType

Declared In

Trading_ShipmentType.h

shipmentTrackingDetails

Container consisting of the tracking number and shipping carrier associated with
the shipment of one item (package).



Because an order can have multiple line items and/or packages, there can be
multiple ShipmentTrackingDetails containers under the
Shipment container.

@property (nonatomic, retain) NSMutableArray *shipmentTrackingDetails

Discussion

Container consisting of the tracking number and shipping carrier associated with
the shipment of one item (package).



Because an order can have multiple line items and/or packages, there can be
multiple ShipmentTrackingDetails containers under the
Shipment container.

entry type : class Trading_ShipmentTrackingDetailsType

Declared In

Trading_ShipmentType.h

shipmentTrackingNumber

The tracking number associated with one package of a shipment. The seller is
responsible for the accuracy of the shipment tracking number. eBay verifies
the tracking number is unique (across all of a seller’s orders) and consistent
with the numbering scheme used by the specified shipping carrier. eBay cannot
verify the accuracy of the tracking number. This field is required if
ShippingCarrierUsed is included in the call request.



Sellers can specify multiple tracking numbers for the same ShippingCarrierUsed
by separating the tracking numbers with commas.



ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other.
You must either specify both, or specify neither.

@property (nonatomic, retain) NSString *shipmentTrackingNumber

Discussion

The tracking number associated with one package of a shipment. The seller is
responsible for the accuracy of the shipment tracking number. eBay verifies
the tracking number is unique (across all of a seller’s orders) and consistent
with the numbering scheme used by the specified shipping carrier. eBay cannot
verify the accuracy of the tracking number. This field is required if
ShippingCarrierUsed is included in the call request.



Sellers can specify multiple tracking numbers for the same ShippingCarrierUsed
by separating the tracking numbers with commas.



ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other.
You must either specify both, or specify neither.

type : NSString, wrapper for primitive string

Declared In

Trading_ShipmentType.h

shippedTime

The date and time that the seller handed off the package(s) to the shipping
carrier. If this field is not included in the request, the timestamp of the call
execution is used as the shipped time. Note that sellers have the ability to set
this value up to 3 calendar days in the future.

@property (nonatomic, retain) NSDate *shippedTime

Discussion

The date and time that the seller handed off the package(s) to the shipping
carrier. If this field is not included in the request, the timestamp of the call
execution is used as the shipped time. Note that sellers have the ability to set
this value up to 3 calendar days in the future.

type : NSDate, wrapper for primitive date

Declared In

Trading_ShipmentType.h

shippingAddress

The address to which the item is to be shipped.

@property (nonatomic, retain) Trading_AddressType *shippingAddress

Discussion

The address to which the item is to be shipped.

type : class Trading_AddressType

Declared In

Trading_ShipmentType.h

shippingCarrierUsed

The shipping carrier used to ship the package. This value can be any
combination of alphanumeric characters and it is not checked and verified by
eBay. This field is required if ShipmentTrackingNumber is included in the
call request.



ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other.
You must either specify both, or specify neither.

@property (nonatomic, retain) NSString *shippingCarrierUsed

Discussion

The shipping carrier used to ship the package. This value can be any
combination of alphanumeric characters and it is not checked and verified by
eBay. This field is required if ShipmentTrackingNumber is included in the
call request.



ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other.
You must either specify both, or specify neither.

type : NSString, wrapper for primitive string

Declared In

Trading_ShipmentType.h

shippingFeature

(public property)

@property (nonatomic, retain) NSMutableArray *shippingFeature

Discussion

(public property)

entry type : string constant in Trading_ShippingFeatureCodeType.h

Declared In

Trading_ShipmentType.h

shippingPackage

The size of the package used to ship the item(s). See ShippingPackageCodeType
for its possible values. Input.

@property (nonatomic, retain) NSString *shippingPackage

Discussion

The size of the package used to ship the item(s). See ShippingPackageCodeType
for its possible values. Input.

type: string constant in Trading_ShippingPackageCodeType.h

Declared In

Trading_ShipmentType.h

shippingServiceUsed

The size of the package used to ship the item(s). See ShippingPackageCodeType
for its possible values. Input.

@property (nonatomic, retain) NSString *shippingServiceUsed

Discussion

The size of the package used to ship the item(s). See ShippingPackageCodeType
for its possible values. Input.

type : NSString, wrapper for primitive string

Declared In

Trading_ShipmentType.h

status

Status, for revise only

@property (nonatomic, retain) NSString *status

Discussion

Status, for revise only

type: string constant in Trading_ShipmentStatusCodeType.h

Declared In

Trading_ShipmentType.h

weightMajor

See the documentation regarding “Working with Item Weights”.
The ‘unit’ attribute can have a value of lbs.

@property (nonatomic, retain) Trading_MeasureType *weightMajor

Discussion

See the documentation regarding “Working with Item Weights”.
The ‘unit’ attribute can have a value of lbs.

type : class Trading_MeasureType

Declared In

Trading_ShipmentType.h

weightMinor

See the documentation regarding “Working with Item Weights”.
The ‘unit’ attribute is optional and assumed to be the
minor compared to the value of ‘unit’ in WeightMajor.

@property (nonatomic, retain) Trading_MeasureType *weightMinor

Discussion

See the documentation regarding “Working with Item Weights”.
The ‘unit’ attribute is optional and assumed to be the
minor compared to the value of ‘unit’ in WeightMajor.

type : class Trading_MeasureType

Declared In

Trading_ShipmentType.h