Contains the description of an entry in a wish list or gift list (registry).
Wish lists typically only specify the item id and sometimes the desired quantity.Unique identifier for this gift list item or wish list item.An item id that any system can use to cross-reference the
item from another list. This is an alternate id.Desired quantity for the gift list item or wish list item.Purchased quantity for a gift list item.ISO country codeISO language codeCollection of gift list item or wish list item descriptions.Description of gift item or wish list item.The number of GiftListItemDesc objects.The total records of the result set if maximum result set count
specified in request criteria is ignored.Contains the contact information for a customerUnique identifier for this contactContact first name.
ORPOS Usage - For regular customers that are fed into ORPOS from an external customer system, if this field is not populated, ORPOS will prompt for a value. For Customers created by ORPOS, this field needs to be populated.Contact last name.
ORPOS Usage - For regular customers that are fed into ORPOS, if this field is not populated, ORPOS will prompt for a value. For Customers created by ORPOS, this field needs to be populated.Contact middle nameContact preferred nameContains the full name for a regular customer.A Title placed before a name. Example Ms, MrThe name suffix, can be academic, honorary, professional or generational.
Example: PhD, MBA, PMP, Sr, Jr, JDAFax number for this contactContains the name of a business/ organization.List of phones for this contact address.List of emails for this contact addressContains a list of emails for this contact addressContact Email.Contains a list of phones for this contact addressPhone informationDescription is not available.Description is not available.Description is not available.Description is not available.A query message requesting gift lists based on some search criteria.
This is a complex element which defines the search criteria. Gift list
is searched based on the search criteria specified here.
Requesting system can search Gift list by Gift list unique identifier
or by Gift list Owner's unique identifier or by specifying Gift list
info. Passing existing Gift list's unique identifier as query parameter
means that user wish to retrieve a particular Gift list. Similar is the case
when specifying existing customer's unique identifier. This means that based on
query parameters, search call can act as retrieve call.
Based upon the search choice, values should be specified for the
corresponding fields.Can be one of the following: by owner id, by gift list id, or by gift
list info. These are mutually exclusive.
E.g if trying to search using Gift list's unique
identifier then only value in "giftlist_id" field
will be considered and other values will not
be looked at. Similarly, for search gift lists
for a customer.Indicates whether the gift items are retrieved as part of the search.
If not specified, expected behavior is to default to false.Unique identifier for the gift list. This field is
used when trying to retrieve a specific gift list
based on its unique identifier.Customer's unique identifier who owns the gift list.
This unique identifier is provided by Customer
system of record. This element will be used
when trying to retrieve gift lists for a particular customer.Gift list owner's first name.Gift list owner's last name.Event name of the gift list.Gift list's event type.Gift list's event date.Indicates whether the registry is published.Indicates whether the registry is public.This element contains necessary information for
deletion of a Gift list.Contains the unique identifier of an existing gift list.Successful message string.Contains the description of a gift list or wish list.
A Wish list is a sub set of Gift List with the following details:
customer_id, published_flag, public_flag and GiftListItemColDesc.
For a wish list, the public_flag and published_flag
will always be set to false.Unique identifier of the gift list.The unique identifier for the owning customer of this list,
as provided by the customer system of record.The name of the list that describes its purpose, such as
"My Wedding", or "Joe's Wishlist".Contains the event type. Gift lists (or registries) for a
special event should specify this.A gift list that is created for a special event, can
specify the date of that event here.Indicates whether the gift/wish list is published, i.e. whether
the list is visible to and can be search for by other specific
customers. See "public_flag". Absence of this element should indicate "true".Setting this value to true indicates that anyone can view the
list. This is a broader visibility than "published_flag".
Absence of this element should indicate "false".ID for the location where the gift list was created.Comments on the gift list.Instructions for the gift list.Contains the URL of the image associated with the gift list.Date the gift list was created.Date the gift list was most recently updated.Gift list expiration date.Id of user who created the gift list.Id of user who updated the gift list.The shipping addresses to where items purchased off of the
list should be shipped to.Collection of gift list items or wish list items.Contains the card information. The card can be loyalty, credit, debit, giftcard etc.Unique identifier for the card as defined by the system-of-record, which is usually the customer master system.
Other systems can use this id as an external id. This is not the same as the card's printed number.The card number printed on the card. This element should not be used for cards with sensitive
account numbers, like credit and debit cards.The card number that is printed on the card with most of its characters replaced with masking char.
This field should be used for cards with sensitive account numbers, like credit and debit cards.Type of card. For eg.,credit, debit, giftcard, loyalty, etc.Status of the card. Defaults to ACTIVEBilling address for the cardThe date that the card was activated.The month that the card will expire.The year that the card will expire.The unique identifier for CustomerContains the unique identifier for the customerContains the phone information.Unique identified for the phonePhone numberPhone type. For ORPOS if the field is not populated will default to value "HOME".Contains the phone extensionIndicates whether this phone is the primary contact phoneIndicates the type of communications that this phone is being used for.
Sample values: order information only, promotion info only, marketing, no phone contactContains the email informationUnique identifier for the emailContains the email type. For ORPOS if the field is not populated, will default to "HOME".Indicates whether this email is the primary contact email address. Defaults to false.Contains the email address.Contains the format for the email for example TEXT or HTML.Indicates the type of communications being sent to this email address.
Sample values: order information only, promotion info only, marketing, no contactIf the retailer integrates with an external system that does email validation at the time of adding this record,
this flag is set to true. Absence of this element should indicate "false".GiftListCreModVo is used while creating the Gift list
as well as while updating the Gift list or Wish list.
A Wish list is a sub set of Gift List with the following details:
customer_id, published_flag, public_flag , GiftlistItemsModVo and
GiftlistItemsDelVo. For a wish list, the public_flag and published_flag
will always be set to false.
1. While creating the gift list if user wish to specify Gift list
items then item info should be provided as part of
GiftlistItemsCreVo element.
2. If a user wishes to add an item to his/her Wish list then item information should
be provided as part of GiftlistItemsModVo element
3. If a user wishes to modify already added Gift list or Wish list item information
then item modification detail should be provided as part of
GiftlistItemsModVo element.
4. If a user wishes to delete an existing item from Gift list or Wish list then
item to be deleted info should be provided as part of
GiftlistItemsDelVo element.
5. While creating the gift list if user info is provided then
it should be provided as part of GiftlistOwnerCreVo.
6. If user wish to modify existing Gift list owner info in an
existing Gift list then that information should be passed as
part of GiftlistOwnerModVo.
7. While creating Gift list, Shipping info should be provided
as part of ShippingAddrCreVo element.
8. If user wish to modify shipping address information associated
with an existing Gift list, then that information should be
provided as part of ShippingAddrModVo.
9. If user wish to delete shipping information associated with an
existing Gift list then that information should be provided as
part of ShippingAddrDelVo element.Unique identifier for gift list.Identifier of the primary customer who is associated
with the Gift list or Wish list.Event name of the gift list.Contains the gift list event typeContains the gift list event date.Indicates whether the gift list or wish list is published.
For a wish list this flag will be set to false always.
For a gift list this flag can be set to either true or false
depending upon the customer choice.
If this flag is set to true then this gift list can be
searched by other usersIndicates whether the gift list or wish list is public.
For a wish list this flag will be set to false always.
For a gift list this flag can be set to either true or false
depending upon the customer choice.
For a gift list this flag will be set to true by default.Identifier location where the gift list is created or modified.Comments on the gift list.Instructions for the gift list.Contains the URL of the image associated with the gift list .Gift list expiration date.Order identifier if the gift list is modified in by an order.Details of Gift list owner. This element will be
populated when Gift list is being created.Owner details which needs to be modified for an existing
gift list. This element will be populated when existing
owner details needs modification.Details of gift list items. This element will be populated
when Gift list is being created.Details of gift list or wish list items. This field will contain data
1. when we are trying to modify an existing item from gift list or wish list
2. when we are trying to add an item to wish list.Details of gift list or wish list items. This field will contain data
when we are trying to remove an existing item from gift list or wish list.Shipping address details for this gift list.
This field will contain data when we are trying
to add a new shipping address to gift list.Shipping address details for this gift list.
This field will contain data when we are trying
to modify an existing shipping address of gift list.Shipping address details for this gift list.
This field will contain data when we are trying
to remove an existing shipping address of gift list.Gift list items creation (add to list) information.Unique identifier for gift list. Only used if GiftlistItemsCreVo
if used apart from GiftListCreModVo wrapping element.Gift list items deletion (remove from list) information.Unique identifier for gift list. Only used if GiftlistItemsDelVo
if used apart from GiftListCreModVo wrapping element.Gift list items modification information.Associate gift list with a customer.The customer who owns the gift list.Associate gift list with a customer.The customer who owns the gift list.Value object for Shipping address creation.The shipping address for the gift item.Value object for Shipping address deletion.Unique identifier for gift list.The shipping address for the gift item.Value object for Shipping address modification.The shipping address for the gift item.Address used for mail, shipping or deliveryUnique identifier for this address entry.The address type can be any of the enumerated values 'Home','Office','Billing','Shipping'Contains Address Line 1.Contains Address Line 2.Contains Address Line 3.Contains Address Line 4.Contains Address Line 5.Contains the city where the address is located.County where this address is locatedContains the postal abbreviation for the state, province or territory in which the address is located.Indicates the state, province or territory name.Contains the postal abbreviation of the country in which the address is locatedIndicates the Country name For e.g Brazil,United StatesContains the postal code for the addressID associated to the tax jurisdiction of the
country-state relationship.Indicates the type of communications being sent to this address.
Sample values are order information only, promotion info only, marketing material, no contactIf the retailer integrates with an external system that does address validation at the time of adding this record,
this flag is set to true. Absence of this element should indicate "false".Contains an address book for the customerContains a collection of addresses for the customer.
Collection limited to 99 to prevent XML overflowCustomer addresses for home, shipping, billingCustomer's alias for this address, example My Office Shipping AddressIndicates whether this address is the primary address to contact the customer.Indicates whether this address should be considered first as the customer's
billing address.Indicates whether this address should be considered first as the customer's
shipping address.Address for this contactContains contact for this addressContains all the cards for this contactCustomer Card.Employee that created this customerContains the id of the employee that created the customer.TBDUnique identifier for customer.Contains the customer type: regular customer or business.Customer first nameCustomer Last nameCustomer middle nameIf this customer is a business, this field contains the name of the business.Indicates if the customer wants to be contacted by mail.
Defaults to false if not specified.Indicates if the customer wants to be contacted by phone.
Defaults to false if not specified.Indicates if the customer wants to be contacted by email.
Defaults to false if not specified.Indicates if the customer wants to be contacted by fax.
Defaults to false if not specified.Contains the customer gender.Contains the customer ethnicity.Contains the customer gender.Contains the customer birth date.Contains anniversary date for the customerAnnual income for this customerContains the net worth for this customerContains the highest education level for this customerindustry customer belongs to. Sample values 'Consumer', 'Entertaining', 'Medical' etc.An enum indicating the location type from where the customer got created.
Valid values are 'STORE' (store walk-in), 'WEB' (web channel), 'RENTED' (rented list) and 'Unknown' (unknown).
If this element is missing, then 'UNKNOWN' (unknown) is assumed.Contains the customer receipt preference. Customer can opt for printed, or email or both printed and email receipts.Contains the federal identifier assigned by a national government.Contains the number provided for sales tax exemption issued separately by the state where doing business.Contains the tax exempt reason code.Contains the job title.The employee that created this customerContains all the phones the customer can be reached atContains all the emails the customer can be reached atContains all the addresses for this customer, such as 'Home', 'Office'A collection of customer segments (such as senior_citizen, teacher, veteran,
contractor, etc) that this customer has been assigned to that would impact the
pricing offered to the customer.A collection of promotion ids of promotions that this customer may choose to
activate, such as by presenting a coupon, or may automatically be applied to their
purchases for discounting the total.Contains a collection of cards. Here we can save the details of various cards a customer possess. For eg., credit/debit, loyalty/giftcard, etc.Contains the organization information that the customer belongs to.Contains the customer preferred language.The timestamp at which this record was created.The timestamp at which this record was last updated.Contains all the emails for this customerContact EmailContains the organization information that the customer belongs to.Unique identifier for the organization.Contains the name of the organization that customer belongs to.Contains the type of the organization that customer belongs to. This is free form field and can contain
values like 'Charity', 'Booster Club', 'Labor Council' etcContains all the phones for this customerContact PhoneContains a promotion id that this customer may use.Contains the id of a promotion available to this customer, such as a coupon code.Contains the name of a promotion, such as "But 1 sock get another sock free."Contains a customer segment id assigned to this customer.Contains the id of the customer segment, such as teacher, veteran, etc.Contains the name of the customer segment, such as teacher, veteran, etc.Collection of gift list descriptions.The gift list description.The number of GiftListDesc objects.The total records of the result set if maximum result set count
specified in request criteria is ignored.A collection of services for gift list and wish list operations. Wish lists are like
gift lists but generally don't have specific events associated with them nor do they
keep track of quantities requested and purchased like gift lists do. Gift lists are
also referred to as gift registry.Creates a new gift or wish list. This operation also associates the gift list to the customer.Value object containing new or modified gift list.Thrown when the provider detects a problem with service input.Thrown when the provider is unable to perform the requested operation.Throw this exception when the gift list already exists.