OBLabelXAPIAdditionalData

Outbound Label XAPI Processing

Minor Business Rule

Object Name: B4601440

Parent DLL: CWARE

Location: Client/Server

Language: C

Data Structure

D4601440F - Outbound Label XAPI Additional Data

Parameter NameData ItemData TypeReq/OptI/O/Both
szColumnName1COLNMEcharOPTINPUT

A descriptive remark for the label.

szColumnName2COLNMEcharOPTINPUT

A descriptive remark for the label.

szAlphaValue1ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szColumnName3COLNMEcharOPTINPUT

A descriptive remark for the label.

szColumnName4COLNMEcharOPTINPUT

A descriptive remark for the label.

szColumnName5COLNMEcharOPTINPUT

A descriptive remark for the label.

szColumnName6COLNMEcharOPTINPUT

A descriptive remark for the label.

szAlphaValue2ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szAlphaValue3ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szAlphaValue4ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szAlphaValue5ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szAlphaValue6ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szColumnName7COLNMEcharOPTINPUT

A descriptive remark for the label.

szColumnName8COLNMEcharOPTINPUT

A descriptive remark for the label.

szColumnName9COLNMEcharOPTINPUT

A descriptive remark for the label.

szColumnName10COLNMEcharOPTINPUT

A descriptive remark for the label.

szAlphaValue7ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szAlphaValue8ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szAlphaValue9ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

szAlphaValue10ALPHAVcharOPTINPUT

A code that represents the user defined label data that is stored in the Additional Label Data table (F40R31).

idXAPICallIDGENLNGIDREQINPUT

General purpose ID variable.

szErrorMessageIDDTAIcharOPTBOTH

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

Related Functions

None

Related Tables

None
OBLabelXAPICartonDetail

OBLabelXAPICartonDetail

Outbound Label XAPI Processing

Minor Business Rule

Object Name: B4601440

Parent DLL: CWARE

Location: Client/Server

Language: C

Data Structure

D4601440D - Outbound Label XAPI Carton Detail

Parameter NameData ItemData TypeReq/OptI/O/Both
mnCartonLevelCRLVLMATH_NUMERICOPTINPUT

A code that identifies parent and child cartons. Valid values are: 1 Parent 2 Child

cMasterLabelMSTRLBLcharOPTINPUT

A value that identifies the highest carton in the structure that will be labeled, such as a pallet.

mnCartonIDCRIDMATH_NUMERICOPTINPUT

A system-assigned number that identifies each carton. The system uses this number for the picking, packing, and shipment processes.

szCartonCodeEQTYcharOPTINPUT

A code (46/EQ) that identifies a storage container or a shipping carton. A storage container can be an open container where items are 
stored on the container (for example, a pallet), or a closed container where items are stored in the container (for example, a box). You use the 
Container and Carton Codes program (P46091) to define storage containers.

mnGrossWeightGRWTMATH_NUMERICOPTINPUT

Essentially a memo field at present, this value is intended to reflect the fact that many inventory items are always packaged in the same 
way for shipment to the customer.  This packaging in turn effectively adds to the shipment weight for the item.  Since much of the mainstream 
freight calculations depend upon a weight basis for their accuracy, the ability to store a gross weight which reflects the estimated additional 
weight of standard packaging was deemed to be a worthwhile enhancement. (Future Use)

mnShortItemNumberITMMATH_NUMERICOPTINPUT

An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item 
numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and 
so forth. The item numbers are as follows:   o Item Number (short) - An eight-digit, computer-assigned item number     o 2nd Item Number - The 
25-digit, free-form, user defined alphanumeric item number     o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item 
number

szLotNumberLOTcharOPTINPUT

A lot is a quantity of items that you want to group together because they have similar characteristics.

mnOrderNumberDOCOMATH_NUMERICOPTINPUT

A number that identifies an original document. This document can be a voucher, a sales order, an invoice, unapplied cash, a journal entry, 
and so on.

szOrderTypeDCTOcharOPTINPUT

A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has 
reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post 
program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and 
should not be changed: P Accounts Payable documents   R Accounts Receivable documents   T Payroll documents   I Inventory documents  
O Purchase Order Processing documents   J General Accounting/Joint Interest Billing documents   S Sales Order Processing documents

szOrderCompanyKCOOcharOPTINPUT

A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a 
sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the 
order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order 
type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to 
assign a next number. In this case, you probably would not use the order company to locate the document.

mnLineNumberLNIDMATH_NUMERICOPTINPUT

A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns 
this number,but in some cases you can override it.

szOrderSuffixSFXOcharOPTINPUT

In the A/R and A/P systems, a code that corresponds to the pay item. In the Sales Order and Procurement systems, this code identifies 
multiple transactions for an original order. For purchase orders, the code is always 000. For sales orders with multiple partial receipts against an 
order, the first receiver used to record receipt has a suffix of 000, the next has a suffix of 001, the next 002, and so on.

szCustomerPOCSTPOcharOPTINPUT

A number that identifies the customer's purchase order.

szCustomerItemNumberCITMcharOPTINPUT

The cross-reference item number that the system assigns to an item number. A cross-reference number allows you to use a supplier's item 
number if it is different from your own item number when you are processing an order or printing.

szItemRevisionLevelCIRVcharOPTINPUT

A reference number used to identify the revision level of the customer's item.   In item cross-reference, translating a customer or supplier 
external item number to the internal short item number, the customer's number only is not always sufficient. In some instances, the customer part 
number must be used in conjunction with the item revision level. This combination will allow the system to uniquely identify the customer's 
item.

mnItemWeightWEITMATH_NUMERICOPTINPUT

The weight of goods currently in a location. The system calculates this amount from the weight from the item/unit of measure profile and the 
weight of the container if the level 1 unit of measure for this location detail has a storage container.

szWeightUOMUWUMcharOPTINPUT

A user defined code (00/UM) that identifies the unit of measure that the system uses to indicate weight for this item. You can specify ounces, 
grams, kilograms, and so on, as weight standards. The system uses this unit of measure for the item or overrides it for an individual item or 
container.

szPackagingCodePKCDcharOPTINPUT

A code corresponding to one of the accepted values in the EDI X12 definition for data element 103. It is a combination of a Packaging Form 
(3 chars) and a Packaging Material (2 digits).

szPackSerialNumberPAKcharOPTINPUT

The pack level Serialized Shipping Container Code. Must conform to the UCC structure for SSCC numbers.

szTareSerialNumberPLTcharOPTINPUT

The tare level Serialized Shipping Container Code. Must conform to the UCC structure for SSCC numbers.

szMaterialHandlingCodeASBLNFDcharOPTINPUT

A value that is received from the customer's EDI set/message. This value identifies an actual receiving location on an automotive 
assembly line for delivery of the product. 

szDockIDDKIDcharOPTINPUT

The dock location from which an outbound shipment is assigned to depart or at which an inbound shipment is assigned to arrive.

szPartyID_1PARTYIDcharOPTINPUT

A code that identifies the party in an EDI message. This code is typically the fourth element of the N1 segment of an X12 transaction set.

szPartyID_2PARTYIDcharOPTINPUT

A code that identifies the party in an EDI message. This code is typically the fourth element of the N1 segment of an X12 transaction set.

szDemandReference1DMDREF1charOPTINPUT

A number that identifies a demand entity.

szDemandReference2DMDREF2charOPTINPUT

A number that identifies a demand entity.

mnDeliverToDVANMATH_NUMERICOPTINPUT

The address number of the person who receives the goods ordered. The delivered to address might differ from the ship to address when 
ordered goods are processed through a distribution center (which is the delivered to address) before reaching their final destination (the ship 
to address).

szDeliverToMailingNameMLNMcharOPTINPUT

The company or person to whom billing or correspondence is addressed.

szDeliverToAddressLine1ADD1charOPTINPUT

The first line of a mailing address for an employee, customer, or supplier in the Address Book system. The U.S. Internal Revenue Service 
(IRS) restricts the size of the address that prints on an employee's year-end tax return. To comply with IRS regulations, the system has the 
following restrictions:   o  On W-2 returns, the system prints only the last three nonblank address lines plus the city, state, and postal code.   o  On 
1099 returns, the system prints only the last nonblank address line plus the city, state, and postal code.   o  On other U.S. federal magnetic 
media, the system prints only the last nonblank address line plus the city, state, and postal code.

szDeliverToAddressLine2ADD2charOPTINPUT

The second line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, 
and postal code.

szDeliverToAddressLine3ADD3charOPTINPUT

The third line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that prints 
on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szDeliverToAddressLine4ADD4charOPTINPUT

The fourth line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szDeliverToAddressLine5ADD5charOPTINPUT

The fifth line of the mailing address in the Address Book system.

szDeliverToAddressLine6ADD6charOPTINPUT

The sixth line of the mailing address in the Address Book system.

szDeliverToAddressLine7ADD7charOPTINPUT

The seventh mailing address line in an address.

szCustomerCartonIDCEQTcharOPTINPUT

A code that the customer uses to represent a carton in the system.

mnCartonItemNumberCTNIMATH_NUMERICOPTINPUT

A number that identifies a carton as an item. When you specify an item number, the system creates a relationship between the item number 
and the carton code for tracking and pricing purposes.

mnItemQuantityTQTYMATH_NUMERICOPTINPUT

The total quantity of an item to be reworked or scrapped as a result of an ECO disposition.

szItemUOMUOM1charOPTINPUT

A user defined code (00/UM) that identifies the unit of measure that the system uses to express the quantity of an item, for example, EA 
(each) or KG (kilogram).

szErrorMessageIDDTAIcharOPTBOTH

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

szErrorDescriptionERRDSCAcharOPTINPUT

An error explanation that is associated with the error message ID.

szUNorNANumberUNNAcharOPTINPUT

The UN or NA number assigned to hazardous goods.

szHazardClassHZDCcharOPTINPUT

The hazard class of the item.

mnFlashPointTemperatureFPNTMATH_NUMERICOPTINPUT

The flashpoint temperature of the hazardous item.

cTemperatureTypeSTPUcharOPTINPUT

A code used to identify the type of temperature. Valid values are:    F Fahrenheit    C Celsius 

szHazardLabelHZDLcharOPTINPUT

The hazard label used for the item.

idXAPICallIDGENLNGIDREQINPUT

General purpose ID variable.

mnNumberofLabelsNBRLBLMATH_NUMERICOPTINPUT

The number of labels that are needed for the item and quantity. The system calculates the number of labels by using the rules in the Item 
Standard Packs application (P460131). If rules are not set up, the system uses the default value of 1 for standard pack; and the number of 
labels equals the item quantity.

szLabelNNBeginBGNLBLcharOPTINPUT

The beginning label serial number within a range of label serial numbers.

szLabelNNEndENDLBLcharOPTINPUT

The ending label serial number within a range of label serial numbers.

szLabelFormatLBLFMTcharOPTINPUT

A value that identifies the type of label format to use when printing outbound shipping labels for a customer.

szContainerSerialCTSNcharOPTINPUT

A unique number that identifies a specific outbound shipping container.  The container serial number is normally created from a 
standardized format.

szSerialNumberTypeSNTYcharOPTINPUT

A value that identifies the type of serial number being used to identify an outbound shipping carton.  The values are based on UDC 
46R/ST. 

cRFIDAttachedRFIDFcharOPTINPUT

An option that defines whether an RFID tag is attached to this carton.

Related Functions

None

Related Tables

None
OBLabelXAPIDmdSODetail

OBLabelXAPIDmdSODetail

Outbound Label XAPI Processing

Minor Business Rule

Object Name: B4601440

Parent DLL: CWARE

Location: Client/Server

Language: C

Data Structure

D4601440E - Outbound Label XAPI Dmd/SO Detail

Parameter NameData ItemData TypeReq/OptI/O/Both
mnShortItemNumberITMMATH_NUMERICOPTINPUT

An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item 
numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and 
so forth. The item numbers are as follows:   o Item Number (short) - An eight-digit, computer-assigned item number     o 2nd Item Number - The 
25-digit, free-form, user defined alphanumeric item number     o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item 
number

szLotNumberLOTcharOPTINPUT

A lot is a quantity of items that you want to group together because they have similar characteristics.

szItemUOMUOMcharOPTINPUT

A user defined code (00/UM) that indicates the quantity in which to express an inventory item, for example, CS (case) or BX (box).

jdDateRequestedShipRQSJJDEDATEOPTINPUT

Requested ship date.

mnRequestedShipTimeRSHTMATH_NUMERICOPTINPUT

Requested Ship Time.

szCustomerPOCSTPOcharOPTINPUT

A number that identifies the customer's purchase order.

szCustomerItemNumberCITMcharOPTINPUT

The cross-reference item number that the system assigns to an item number. A cross-reference number allows you to use a supplier's item 
number if it is different from your own item number when you are processing an order or printing.

szCustomerItemRevisionLevelCIRVcharOPTINPUT

A reference number used to identify the revision level of the customer's item.   In item cross-reference, translating a customer or supplier 
external item number to the internal short item number, the customer's number only is not always sufficient. In some instances, the customer part 
number must be used in conjunction with the item revision level. This combination will allow the system to uniquely identify the customer's 
item.

mnCartonItemNumberCTNIMATH_NUMERICOPTINPUT

A number that identifies a carton as an item. When you specify an item number, the system creates a relationship between the item number 
and the carton code for tracking and pricing purposes.

mnItemWeightWEITMATH_NUMERICOPTINPUT

The weight of goods currently in a location. The system calculates this amount from the weight from the item/unit of measure profile and the 
weight of the container if the level 1 unit of measure for this location detail has a storage container.

mnCartonWeightGWEIMATH_NUMERICOPTINPUT

The gross weight of one unit of the item in this unit of measure, or the weight of an empty storage container or shipping carton. These values 
default to the location detail (F4602) and the system uses the values in maximum weight calculations for specified locations during putaway.

szWeightUOMUWUMcharOPTINPUT

A user defined code (00/UM) that identifies the unit of measure that the system uses to indicate weight for this item. You can specify ounces, 
grams, kilograms, and so on, as weight standards. The system uses this unit of measure for the item or overrides it for an individual item or 
container.

szPackagingCodePKCDcharOPTINPUT

A code corresponding to one of the accepted values in the EDI X12 definition for data element 103. It is a combination of a Packaging Form 
(3 chars) and a Packaging Material (2 digits).

mnGrossWeightGRWTMATH_NUMERICOPTINPUT

Essentially a memo field at present, this value is intended to reflect the fact that many inventory items are always packaged in the same 
way for shipment to the customer.  This packaging in turn effectively adds to the shipment weight for the item.  Since much of the mainstream 
freight calculations depend upon a weight basis for their accuracy, the ability to store a gross weight which reflects the estimated additional 
weight of standard packaging was deemed to be a worthwhile enhancement. (Future Use)

mnQuantityPerCartonTQTYMATH_NUMERICOPTINPUT

The total quantity of an item to be reworked or scrapped as a result of an ECO disposition.

mnNumberofLabelsNBRLBLMATH_NUMERICOPTINPUT

The number of labels that are needed for the item and quantity. The system calculates the number of labels by using the rules in the Item 
Standard Packs application (P460131). If rules are not set up, the system uses the default value of 1 for standard pack; and the number of 
labels equals the item quantity.

szLabelNumberBeginBGNLBLcharOPTINPUT

The beginning label serial number within a range of label serial numbers.

szLabelNumberEndENDLBLcharOPTINPUT

The ending label serial number within a range of label serial numbers.

szDockIDDKIDcharOPTINPUT

The dock location from which an outbound shipment is assigned to depart or at which an inbound shipment is assigned to arrive.

szDemandReference1DMDREF1charOPTINPUT

A number that identifies a demand entity.

szDemandReference2DMDREF2charOPTINPUT

A number that identifies a demand entity.

szPartyID1PARTYIDcharOPTINPUT

A code that identifies the party in an EDI message. This code is typically the fourth element of the N1 segment of an X12 transaction set.

szPartyID2PARTYIDcharOPTINPUT

A code that identifies the party in an EDI message. This code is typically the fourth element of the N1 segment of an X12 transaction set.

mnDeliverToDVANMATH_NUMERICOPTINPUT

The address number of the person who receives the goods ordered. The delivered to address might differ from the ship to address when 
ordered goods are processed through a distribution center (which is the delivered to address) before reaching their final destination (the ship 
to address).

szDeliverToNameMailingMLNMcharOPTINPUT

The company or person to whom billing or correspondence is addressed.

szDeliverToAddressLine1ADD1charOPTINPUT

The first line of a mailing address for an employee, customer, or supplier in the Address Book system. The U.S. Internal Revenue Service 
(IRS) restricts the size of the address that prints on an employee's year-end tax return. To comply with IRS regulations, the system has the 
following restrictions:   o  On W-2 returns, the system prints only the last three nonblank address lines plus the city, state, and postal code.   o  On 
1099 returns, the system prints only the last nonblank address line plus the city, state, and postal code.   o  On other U.S. federal magnetic 
media, the system prints only the last nonblank address line plus the city, state, and postal code.

szDeliverToAddressLine2ADD2charOPTINPUT

The second line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, 
and postal code.

szDeliverToAddressLine3ADD3charOPTINPUT

The third line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that prints 
on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szDeliverToAddressLine4ADD4charOPTINPUT

The fourth line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szDeliverToAddressLine5ADD5charOPTINPUT

The fifth line of the mailing address in the Address Book system.

szDeliverToAddressLine6ADD6charOPTINPUT

The sixth line of the mailing address in the Address Book system.

szDeliverToAddressLine7ADD7charOPTINPUT

The seventh mailing address line in an address.

szCustomerCartonIDCEQTcharOPTINPUT

A code that the customer uses to represent a carton in the system.

szErrorMessageIDDTAIcharOPTBOTH

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

szErrorDescriptionERRDSCAcharOPTINPUT

An error explanation that is associated with the error message ID.

szCartonCodeEQTYcharOPTINPUT

A code (46/EQ) that identifies a storage container or a shipping carton. A storage container can be an open container where items are 
stored on the container (for example, a pallet), or a closed container where items are stored in the container (for example, a box). You use the 
Container and Carton Codes program (P46091) to define storage containers.

szUNorNANumberUNNAcharOPTINPUT

The UN or NA number assigned to hazardous goods.

szHazardClassHZDCcharOPTINPUT

The hazard class of the item.

mnFlashPointTemperatureFPNTMATH_NUMERICOPTINPUT

The flashpoint temperature of the hazardous item.

cTemperatureTypeSTPUcharOPTINPUT

A code used to identify the type of temperature. Valid values are:    F Fahrenheit    C Celsius 

szHazardLabelHZDLcharOPTINPUT

The hazard label used for the item.

szMaterialHandlingCodeASBLNFDcharOPTINPUT

A value that is received from the customer's EDI set/message. This value identifies an actual receiving location on an automotive 
assembly line for delivery of the product. 

idXAPICallIDGENLNGIDREQINPUT

General purpose ID variable.

szLabelFormatLBLFMTcharOPTINPUT

A value that identifies the type of label format to use when printing outbound shipping labels for a customer.

Related Functions

None

Related Tables

None
OBLabelXAPIFinalize

OBLabelXAPIFinalize

Outbound Label XAPI Processing

Minor Business Rule

Object Name: B4601440

Parent DLL: CWARE

Location: Client/Server

Language: C

Data Structure

D4601440B - Outbound Label XAPI Finalize

Parameter NameData ItemData TypeReq/OptI/O/Both
cSuppressErrorMessageSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessageIDDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

szXAPIErrorMessageIDDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

cErrorCodeERRcharOPTOUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the 
external parameter data structure of the Data Dictionary Server.

szXAPICallTypeXAPICTcharOPTINPUT

Future use.

idXAPICallIDGENLNGIDREQINPUT

General purpose ID variable.

szCallbackFunctionNameRSPFCNMcharOPTINPUT

The name of the function that processes the response from the inbound label process. This function can be a third-party or custom function.

Related Functions

None

Related Tables

None
OBLabelXAPIFree

OBLabelXAPIFree

Outbound Label XAPI Processing

Minor Business Rule

Object Name: B4601440

Parent DLL: CWARE

Location: Client/Server

Language: C

Data Structure

D4601440G - Outbound Label XAPI Free

Parameter NameData ItemData TypeReq/OptI/O/Both
cSuppressErrorMessageSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessageIDDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

cErrorCodeERRcharOPTOUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the 
external parameter data structure of the Data Dictionary Server.

idXAPICallIDGENLNGIDREQINPUT

General purpose ID variable.

Related Functions

None

Related Tables

None
OBLabelXAPIInitialize

OBLabelXAPIInitialize

Outbound Label XAPI Processing

Minor Business Rule

Object Name: B4601440

Parent DLL: CWARE

Location: Client/Server

Language: C

Data Structure

D4601440A - Outbound Label XAPI Initialize

Parameter NameData ItemData TypeReq/OptI/O/Both
cSuppressErrorMessageSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessageIDDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

cErrorCodeERRcharOPTOUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the 
external parameter data structure of the Data Dictionary Server.

szXAPICallTypeXAPICTcharREQINPUT

Future use.

idXAPICallIDGENLNGIDOPTOUTPUT

General purpose ID variable.

Related Functions

None

Related Tables

None
OBLabelXAPIShipmentHdr

OBLabelXAPIShipmentHdr

Outbound Label XAPI Processing

Minor Business Rule

Object Name: B4601440

Parent DLL: CWARE

Location: Client/Server

Language: C

Data Structure

D4601440C - Outbound Label XAPI Shipment Header

Parameter NameData ItemData TypeReq/OptI/O/Both
mnShipmentNumberSHPNMATH_NUMERICOPTINPUT

A "next number" that uniquely identifies a shipment.

jdRequestedShipDateRQSJJDEDATEOPTINPUT

Requested ship date.

mnRequestedShipTimeRSHTMATH_NUMERICOPTINPUT

Requested Ship Time.

jdPromisedShipDatePPDJJDEDATEOPTINPUT

The promised shipment date for a sales order. This date represents the day that the item can be shipped from the warehouse.

mnPromisedShipTimePMDTMATH_NUMERICOPTINPUT

The scheduled time of a shipment. Enter the time using the 24-hour time format (HHMMSS). For example, enter 6:00 a.m. as 060000, and 
enter 7:00 p.m. as 190000.

szBranchPlantMCUcharOPTINPUT

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

mnSoldToAN8MATH_NUMERICOPTINPUT

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

szLongAddressNumberALKYcharOPTINPUT

A user-defined name or number that identifies an address book record.  You can use this number to locate and enter information about the 
address book record. If you enter a value other than the address book number (AN8), such as the long address or tax ID, you must precede 
it with the special character that is defined in the Address Book constants. When the system locates the record, it returns the address book 
number to the field. For example, if address book number 4100 (Total Solutions) has a long address TOTAL and an * distinguishes it from 
other entries (as defined in the Address Book constants), you could type *TOTAL into the field, and the system would return 4100.

mnShipToSHANMATH_NUMERICOPTINPUT

The address number of the location to which you want to ship this order. The address book provides default values for customer address, 
including street, city, state, zip code, and country.

szOriginCountryCTROcharOPTINPUT

The origin country for the shipment.

szOriginCountryNameDL01charOPTINPUT

A user defined name or remark.

szSupplierMailingNameMLNMcharOPTINPUT

The company or person to whom billing or correspondence is addressed.

szSupplierAddressLine1ADD1charOPTINPUT

The first line of a mailing address for an employee, customer, or supplier in the Address Book system. The U.S. Internal Revenue Service 
(IRS) restricts the size of the address that prints on an employee's year-end tax return. To comply with IRS regulations, the system has the 
following restrictions:   o  On W-2 returns, the system prints only the last three nonblank address lines plus the city, state, and postal code.   o  On 
1099 returns, the system prints only the last nonblank address line plus the city, state, and postal code.   o  On other U.S. federal magnetic 
media, the system prints only the last nonblank address line plus the city, state, and postal code.

szSupplierAddressLine2ADD2charOPTINPUT

The second line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, 
and postal code.

szSupplierAddressLine3ADD3charOPTINPUT

The third line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that prints 
on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szSupplierAddressLine4ADD4charOPTINPUT

The fourth line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szSupplierAddressLine5ADD5charOPTINPUT

The fifth line of the mailing address in the Address Book system.

szSupplierAddressLine6ADD6charOPTINPUT

The sixth line of the mailing address in the Address Book system.

szSupplierAddressLine7ADD7charOPTINPUT

The seventh mailing address line in an address.

szSupplierPhonePH1charOPTINPUT

A number without the prefix or special characters, such as hyphens or periods, that makes up the telephone number for an entity. You can 
use any applicable telephone number format for a country. This field is used in conjunction with the Prefix field (AR1), where you enter the first 
segment of the telephone number, which is called the area code in the United States. When you search for an address using a phone 
number, you must enter the number exactly as it is set up in the Address Book system, including any special characters.

szShipToMailingNameMLNMcharOPTINPUT

The company or person to whom billing or correspondence is addressed.

szShipToAddressLine1ADD1charOPTINPUT

The first line of a mailing address for an employee, customer, or supplier in the Address Book system. The U.S. Internal Revenue Service 
(IRS) restricts the size of the address that prints on an employee's year-end tax return. To comply with IRS regulations, the system has the 
following restrictions:   o  On W-2 returns, the system prints only the last three nonblank address lines plus the city, state, and postal code.   o  On 
1099 returns, the system prints only the last nonblank address line plus the city, state, and postal code.   o  On other U.S. federal magnetic 
media, the system prints only the last nonblank address line plus the city, state, and postal code.

szShipToAddressLine2ADD2charOPTINPUT

The second line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, 
and postal code.

szShipToAddressLine3ADD3charOPTINPUT

The third line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that prints 
on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szShipToAddressLine4ADD4charOPTINPUT

The fourth line of the mailing address for an employee, customer, or supplier in the Address Book system. Attention Payroll users: The 
Internal Revenue Service (IRS) restricts the size of the address that prints on employee's year-end forms. To comply with IRS regulations, the 
address that prints on W-2 forms includes only the last three nonblank address lines plus the city, state, and postal code. The address that 
prints on 1099 forms includes only the last nonblank address line plus the city, state, and postal code. If you process year-end information using 
the federal magnetic media format, the address that prints on those forms contains only the last nonblank address line plus the city, state, and 
postal code.

szShipToAddressLine5ADD5charOPTINPUT

The fifth line of the mailing address in the Address Book system.

szShipToAddressLine6ADD6charOPTINPUT

The sixth line of the mailing address in the Address Book system.

szShipToAddressLine7ADD7charOPTINPUT

The seventh mailing address line in an address.

szErrorMessageIDDTAIcharOPTBOTH

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

szErrorDescriptionDSCAcharOPTINPUT

A description for the data items. Enter text in upper and lower case. The system uses this name to search for similar data items. To enter an 
alpha description, follow these conventions: Dates Begin all date fields with the word, Date. Amounts Begin all amount fields with the word, 
Amount. Units Begin all unit, quantity, and volume fields with the word, Units. Name Begin all 30-byte description fields with the word, 
Name. Prompt Begin any Y/N prompting field with the word, Prompt. Address Number  Begin all address numbers (employee, customer, owner) with the 
word, Address Number.

szSupplierEmailREM1charOPTINPUT

A 40-character field that you can use to enter text.

szShippingLabelProgramSLPGcharOPTINPUT

The name of the program that will be used to print shipping labels for a customer.

szShippingLabelVersionSLDWcharOPTINPUT

The DREAM Writer version that will be used for printing shipping labels for a customer.

idXAPICallIDGENLNGIDREQINPUT

General purpose ID variable.

Related Functions

None

Related Tables

None