Class Shipping
Inherited Members
Namespace: Worldline.Connect.Sdk.V1.Domain
Assembly: Worldline.Connect.Sdk.dll
Syntax
public class Shipping
Properties
Address
Object containing address information
Declaration
public AddressPersonal Address { get; set; }
Property Value
Type | Description |
---|---|
AddressPersonal |
AddressIndicator
Indicates shipping method chosen for the transaction. Possible values:
- same-as-billing = the shipping address is the same as the billing address
- another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
- different-than-billing = shipping address is different from the billing address
- ship-to-store = goods are shipped to a store (shipping address = store address)
- digital-goods = electronic delivery of digital goods
- travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
- other = other means of delivery
Declaration
public string AddressIndicator { get; set; }
Property Value
Type | Description |
---|---|
string |
Carrier
Indicates the carrier that will deliver the products.
Declaration
public string Carrier { get; set; }
Property Value
Type | Description |
---|---|
string |
Comments
Comments included during shipping
Declaration
public string Comments { get; set; }
Property Value
Type | Description |
---|---|
string |
EmailAddress
Email address linked to the shipping
Declaration
public string EmailAddress { get; set; }
Property Value
Type | Description |
---|---|
string |
FirstUsageDate
Date (YYYYMMDD) when the shipping details for this transaction were first used.
Declaration
public string FirstUsageDate { get; set; }
Property Value
Type | Description |
---|---|
string |
Instructions
The delivery instructions or preferences for the shipment. The instructions that informed the delivery carrier about handling requirements, delivery methods, and any special considerations to ensure successful delivery.
Possible values:- signature-required = A signature is required upon delivery.
- identification-required = Recipient needs to provide identification.
- contactless-delivery = Delivery should be contactless.
- leave-at-door = Leave the package at the recipient's door.
- leave-at-curb = Leave the package at the curbside.
- leave-with-neighbor = Leave the package with a neighbor.
- express = Expedite the delivery process.
- tracked = The delivery is tracked with real-time updates.
- untracked = The delivery is untracked, with no real-time updates.
Declaration
public string Instructions { get; set; }
Property Value
Type | Description |
---|---|
string |
IsFirstUsage
Indicator if this shipping address is used for the first time to ship an order
true = the shipping details are used for the first time with this transaction
false = the shipping details have been used for other transactions in the past
Declaration
public bool? IsFirstUsage { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ShippedFromZip
The zip/postal code of the location from which the goods were shipped.
Declaration
public string ShippedFromZip { get; set; }
Property Value
Type | Description |
---|---|
string |
TrackingNumber
Shipment tracking number
Declaration
public string TrackingNumber { get; set; }
Property Value
Type | Description |
---|---|
string |
Type
Indicates the merchandise delivery timeframe. Possible values:
- electronic = For electronic delivery (services or digital goods)
- same-day = For same day deliveries
- overnight = For overnight deliveries
- 2-day-or-more = For two day or more delivery time for payments that are processed by the GlobalCollect platform
- 2-day-or-more = For two day or more delivery time for payments that are processed by the Ogone platform
- priority = For prioritized deliveries for payments that are processed by the WL Online Payment Acceptance platform
- ground = For deliveries via ground for payments that are processed by the WL Online Payment Acceptance platform
- to-store = For deliveries to a store for payments that are processed by the WL Online Payment Acceptance platform
Declaration
public string Type { get; set; }
Property Value
Type | Description |
---|---|
string |