Reference > Shop flow URLs > Catalog subsystem URLs > Offers
OfferAdd URL
This URL adds a new offer, and its description and price.
URL structure
- http:// host_name/path/
- The fully qualified name of the WebSphere Commerce Server and the configuration path.
name-value pair with the &
character. For a detailed description of the parameters and their values, see the list entitled Parameter values." />
Parameter values
- offerId
- Required: The reference number of the offer. You must specify either offerId, or catentryId combined with identifier.
- catentryId
- Required: The reference number of the catalog entry offered for sale. You must specify either catentryId combined with identifier, or offerId.
- identifier
- Required: The external identifier of the offer including the catalog entry. You must specify either identifier combined with catentryId, or offerId.
- field1
- A customizable field.
- field2
- A customizable field.
- flags
- Indicates whether a shipping address is required.
- maxQuantity
- The maximum quantity that can be purchased in a single order under this offer.
- minQuantity
- The minimum quantity that can be purchased in a single order under this offer.
- precedence
- When more than one offer is effective at a particular time, the one with the highest precedence is used.
- published
- Indicates whether the offer is not published (0), published (1), or marked for deletion (2).
- qtyunitId
- The unit of measure for the minimum and maximum quantities.
- desc
- The description of the offer.
- descLangId
- The description of the language's reference number.
- compareprice
- Reserved for IBM internal use.
- price
- The price of the offer.
- currency
- The currency of the offer.
- startDate
- The start date of the offer. The format is YYYY:MM:DD:HH:MM:SS.
- endDate
- The end date of the offer. The format is YYYY:MM:DD:HH:MM:SS.
- URL
- The URL to be called when the command completes successfully.
Example
The following example creates an offer, with 10002 as the identifer, for catalog entry 10001. An offer description will also be created in the language -1 and an offerprice in 1.1 in currency CAD will be created and copied into the list price:
http://host_name/webapp/wcs/stores/servlet/OfferAdd?catentryId=10001 &identifier=10002&descLangId=-1¤cy=CAD&price=1.1 &field1=hello&field2=a&flags=1&maxQuantity=10 &minQuantity=0&precedence=1&published=0&qtyunitId=C62 &&desc=offer description&comparePrice=11&URL=LogonForm
Behavior
- OfferId is required when an offer already exists, but the user want to
create a new language-dependent description or new offer price for that offer.
- When OfferAdd is called, the list price will also be created of the same currency and price of the offer price.
Exception conditions
None.
Related concepts
Related reference