UpdateSoldItems Request
Home / API Calls Reference / UpdateSoldItems > UpdateSoldItems Request

UpdateSoldItems Request



Limitations:
The maximum number of products to be updated per query is 150.
The XML element "Product" may only be contained in the update call a maximum of 150 times.
If this number is exceeded, an error message (Error Code: 75) will be returned.

Note:
Only inserted operations can be modified with this XML call.

Request XML:

Code:
<?xml version="1.0" encoding="utf-8"?>
<Request>
  ---- Global tags
  <AfterbuyGlobal>
    <PartnerToken> String </PartnerToken>
    <AccountToken> String </AccountToken>
    <CallName> String </CallName>
    <DetailLevel> Integer </DetailLevel>
    <ErrorLanguage> String </ErrorLanguage>
  </AfterbuyGlobal>
  ---- Call-specific tags
  <Orders>
    <Order>
      <OrderID> Integer </OrderID>
      <ItemID> Integer </ItemID>
      <UserDefinedFlag> Integer </UserDefinedFlag>
      <AdditionalInfo> String </AdditionalInfo>
      <MailDate> Date </MailDate>
      <ReminderMailDate> Date </ReminderMailDate>
      <UserComment> String </UserComment>
      <OrderMemo> String </OrderMemo>
      <InvoiceMemo> String </InvoiceMemo>
      <InvoiceNumber> Integer </InvoiceNumber>
      <OrderExported> Boolean </OrderExported>
      <InvoiceDate> Date </InvoiceDate>
      <HideOrder> Boolean </HideOrder>
      <Reminder1Date>Date </Reminder1Date>
      <Reminder2Date> Date </Reminder2Date>
      <FeedbackDate> Date </FeedbackDate>
      <XmlDate> Date </XmlDate>
      <BuyerInfo>
        <ShippingAddress>
          <UseShippingAddress> Integer </UseShippingAddress>
          <FirstName> String </FirstName>
          <LastName>String </LastName>
          <Company> String </Company>
          <Street> String </Street>
          <Street2> String </Street2>
          <StateOfProvince> String </StateOfProvince>
          <Phone> String </Phone>
          <PostalCode> String </PostalCode>
          <City> String </City>
          <Country> String </Country>
          <CountryISO> String </CountryISO>
        </ShippingAddress>
      </BuyerInfo>
      <PaymentInfo>
        <PaymentMethod> String </PaymentMethod>
        <PaymentDate> Date </PaymentDate>
        <PaymentTransactionID> String </PaymentTransactionID>
        <AlreadyPaid> Float </AlreadyPaid>
        <PaymentAadditionalCost> Float </PaymentAadditionalCost>
        <SendPaymentMail> Boolean </SendPaymentMail>
      </PaymentInfo>
      <ShippingInfo>
        <ShippingMethod> String </ShippingMethod>
        <ShippingReturnMethod> String </ShippingReturnMethod>
        <ShippingGroup> String </ShippingGroup>
        <ShippingCost> Float </ShippingCost>
        <DeliveryDate> Date </DeliveryDate>
        <eBayShippingCost> Float </eBayShippingCost>
        <SendShippingMail> Boolean </SendShippingMail>
      </ShippingInfo>
      <VorgangsInfo>
         <VorgangsInfo1> String </VorgangsInfo1>
         <VorgangsInfo2> String </VorgangsInfo2>
         <VorgangsInfo3> String </VorgangsInfo3>
      </VorgangsInfo>
      <Tags>
        <Tag><![CDATA[ String ]]></Tag>
      </Tags>

  --- Product attributes

      <Attributes>
         <Attribute>
              <Name> String </Name>
              <Value> String </Value>
         </Attribute>

          ... Further attributes

      </Attributes>

    </Order>
  </Orders>
</Request>


Request Definition

ItemData typeRequiredMeaning
Global parameters
AfterbuyGlobalContainer
Y
Container with credentials
...PartnerTokenString
Y/N
Afterbuy partner token
...AccountTokenString
Y/N
Afterbuy account token
...CallNameString
Y
Action
...DetailLevelString
Y
Restriction of data
...ErrorLanguageString
Y
Country identification for error messages and warnings
Call-specific tags
OrdersContainer
Y
Container with operations
OrderContainer
Y
Container with operation data (max. 150)
...OrderIDInteger
Y/N
VorgangsID. Required for identification.
...ItemIDInteger
Y/N
Internal ID of a single item from the operation. Required for identification.
...UserDefinedFlagInteger
Y/N
User defined flag ID
...AdditionalInfoString
N
Additional information concerning the operation (e.g. tracking number)
...MailDateDate
N
Date of first contact email.
...ReminderMailDateDate
N
Date of the reminder email.
...UserCommentString
N
User comment.
...OrderMemoString
N
Operation memo.
...InvoiceMemoString
N
Invoice note.
...InvoiceNumberInteger
N
Invoice number.
...OrderExportedBoolean
N
Exported (yes/no).
...InvoiceDateDate
N
Invoice date.
...HideOrderBoolean
N
Hide.
...Reminder1DateDate
N
Reminder1 date.
...Reminder2DateDate
N
Reminder2 date.
...FeedbackDateDate
N
Feedback date.
...XmlDateDate
N
XML date.
...ProductIDInteger
N
ID of the 'Stammartikel' (Afterbuy product)
Hinweis:
Changing the 'Stammartikel' assignment only works for operations with single items. You can't make multiple changes to the 'Stammartikel' for operations with multiple items!
Changing the ProductID is not recommended by Afterbuy .
...BuyerInfoContainer
N
Container with buyer information.
...BuyerInfo.ShippingAddressContainer
N
Container with delivery address.
...ShippingAddress.UseShippingAddressInteger
N
1 = Use delivery address,
0 = Do not use delivery address
...ShippingAddress.FirstNameString
N
First name.
...ShippingAddress.LastNameString
N
Last name.
...ShippingAddress.CompanyString
N
Company name.
...ShippingAddress.StreetString
N
Street.
...ShippingAddress.Street2String
N
Street 2.
...ShippingAddress.StateOfProvinceString
N
State.
...ShippingAddress.PhoneString
N
Phone number.
...ShippingAddress.PostalCodeString
N
Postal Code.
...ShippingAddress.CityString
N
City.
...ShippingAddress.CountryString
N
Country.
...ShippingAddress.CountryISOString
N
Country as ISO 3166-1 alpha-2.
...PaymentInfoContainer
N
Container with payment information.
...PaymentInfo.PaymentMethodString
N
Payment method.
...PaymentInfo.PaymentDateDate
N
Payment date.
...PaymentInfo.PaymentTransactionIDString
N
Payment transaction ID.
...PaymentInfo.AlreadyPaidFloat
N
Already paid.
...PaymentInfo.PaymentAadditionalCostFloat
N
Payment method surcharge.
...PaymentInfo.SendPaymentMailBoolean
N
Sending of the payment emails
...ShippingInfoContainer
N
Container with shipping information.
...ShippingInfo.ShippingMethodString
N
Shipping method.
...ShippingInfo.ShippingReturnMethodString
N
Return shipping method.
...ShippingInfo.ShippingGroupString
N
Shipping group.
...ShippingInfo.ShippingCostFloat
N
Shipping costs.
...ShippingInfo.DeliveryDateDate
N
Shipping date.
...ShippingInfo.eBayShippingCostFloat
N
eBay shipping costs.
...ShippingInfo.SendShippingMailBoolean
N
Sending of the dispatch mail
...VorgangsInfoContainer
N
Container with operation information.

Hint:
Create/overwrite operation information:
If the operation information is sent to Afterbuy via "UpdateSoldItems", existing information in the operation will be overwritten.

Remove transaction information:
Existing operation information can be removed by sending the XML element along, but not passing any value/content.
...VorgangsInfo.VorgangsInfo1String
N
Details for operation information 1
...VorgangsInfo.VorgangsInfo2String
N
Details for operation information 2
...VorgangsInfo.VorgangsInfo3String
N
Details for operation information 3
..TagsContainer
N
Container for tags
...Tags.Tag String
Y
Assign existing tags to a sale.
...Attributes.AttributeContainer
N
Container for product attributes (max. 10 attributes).
...Attribute.NameString
Y
Name of the attribute
...Attribute.ValueString
Y
Value of the attribute

UpdateSoldItems Detaillevel:

ValueDescription
0No DetailLevel support
© Copyright 2003 - 2023 ViA-Online GmbH – All rights reserved | www.afterbuy.de