Reference > Shop flow URLs > Order Management subsystem URLs > Orders URLs


ShipInfoAdd URL

Add shipping instructions or a shipping-carrier account number to an order and creates records in the SHIPINFO database table.


URL structure

http:// host_name/path/

The fully qualified name of the WebSphere Commerce Server and the configuration path.

Diagram of the URL structure: The URL starts with the fully qualified name of the WebSphere Commerce Server and the configuration path, followed by the URL name, ShipInfoAdd , and the ? character. End the URL with a list of parameters in the form of name-value pairs. Separate each <a href=name-value pair with the & character. For a detailed description of the parameters and their values, see the list entitled Parameter values." />


Parameter values

storeId

Required: The store ID of the order.

orderId

Required: The identifier of the order to which the shipping information should be added. Specify zero or more orders, using order reference numbers or one of the special abbreviations ".", "*", ".t", "*t". See the Order abbreviations for a description of these abbreviations. If this parameter is omitted, it defaults to ".".

URL

Required: The URL to be called when the command completes successfully.

shipModeId_ i

Required: The order ship mode associated with the shipping instructions or shipping carrier account number for the enumeration group specified as i.

shipInstructions_ i

Optional: The shipping instructions associated with an order, address ID, and ship mode ID for the enumeration group specified as i.

addressId_ i

Optional: Contains a distinct addressId value if shipping instructions are provided and depending on what shipping information is being stored, for the enumeration group specified as i. If shipping instructions are being stored, the addressId is the identifier of the address associated with the shipping instructions.

shipChargeTypeId_ i

Optional: Identification of who pays for the shipping order for the enumeration group specified as i. These values should be specified in the contracts system, for example as -7001 for shipping charge policy ID.

  • StandardShippingChargeBySeller

  • ShipChargeByCarrier

  • NoShippingCharge

If the shipChargeTypeId value is set to ShippingChargeByCarrier, then a shipCarrAccntNum value must also be specified.

shipCarrAccntNum_ i

Optional: The shipping carrier account number (freeform text) for the enumeration group specified as i. This ID is given to a customer by a shipping carrier, such as FedEx, and is external to WebSphere Commerce.


Example 1

The following example adds shipping instructions to order 112233. 

http://host_name/webapp/wcs/stores/servlet/ShipInfoAdd?orderID=112233&storeId=10001
&addressId_0=10&shipModeId_0=100&shipInstructions_0=put_package+under+door+mat&URL=/


Example 2

The following example adds the same type of shipping instructions for different addresses in an order. 

http://host_name/webapp/wcs/stores/servlet/ShipInfoAdd?orderID=112233&storeId=10001
&addressId_0=10&shipModeId_0=100&shipInstructions_0=perishable+leave+in+shaded+area+if+possible
&addressId_1=11&shipModeId_1=100&shipInstructions_1=perishable+leave+in+shaded+area+if+possible
&URL=/


Example 3

The following example adds a shipping carrier account number 90807066 for a B2B order when shipping is charged by the carrier. 

http://host_name/webapp/wcs/stores/servlet/ShipInfoAdd?orderID=223344&storeId=10002
&addressId=2&shipModeId_0=200&shipChargeTypeId_0=-7001&shipCarrAccntNum_0=908070666&URL=/


Example 4

The following example adds both shipping carrier account number and shipping instructions to a B2B order when shipping is charged by the carrier. When including both sets of data (carrier account number and instructions), increment the indexing for the second set of data by one. 

http://host_name/webapp/wcs/stores/servlet/ShipInfoAdd?orderID=223344&storeId=10002
&addressId=2&shipModeId_0=200&shipChargeTypeId_0=-7001&shipCarrAccntNum_0=908070666
&shipInstructions_1=check+in+with+security+at+gate&URL=/


Behavior

Creates new records in the SHIPINFO database table.

When calling the ShipInfoAdd controller command in a JSP file, be sure to include the form action attribute in the calling JSP file. For example: 

<form NAME=ShipMethodPage METHOD=GET action="ShipInfoAdd">

When the ShipInfoAdd command is called, if there is a reference in the form to a URL (as shown in the following example), then exclude unnecessary parameters when the URL is called. Be sure to include the following parameters as excluded parameters in the input value attribute: 

&shipChargeTypeId*=&shipCarrAccntNum*=&shipInstructions*=.
<input type=hidden name="URL"
value="OrderPrepare?&shipChargeTypeId*=
&shipCarrAccntNum*=&shipInstructions*=&orderItemId*=&quantity*=&URL=AllocationCheck">


Exception conditions

None.


Related concepts

Order Management subsystem

Related reference

Order Management subsystem URLs


+

Search Tips   |   Advanced Search