Document and Label Designer Guide (2024)

calc_container_cost_from_item

(qs, args=u'')

Calculate Container Cost From item

The sum of all the allocation packed quantity x inventory item unit cost for a container.

Dynamic

None

calc_container_cost_from_order

(qs, args=u'')

Calculate Container Cost From Order - The sum of all the allocation packed quantity x order detail

cost for a container.

Dynamic

None

company_name_address(qs, args=u'')

Company Address Fields - generates an address in the following format:

company_facility_name company_facility_address company_facility_address2 company_facility_city, company_facility_state company_facility_zip company_facility_country

Dynamic

None

container_mod_time(qs=None, args=u'%d/%m/%Y - %H:%M')

Container Modified Time - The container modified time and date when the document or label is printed based on the container modified time zone

location.

Dynamic Date Format String. http://strftime.org/ Default: "%d/%m/%Y - %H:%M"

destination_company_name_address (qs, args=u'')

Order Destination Company Address Fields - generates an address in the following format:

destination_company_name destination_company_address destination_company_address2 destination_company_city, destination_company_state destination_company_zip destination_company_country

Dynamic

None

destination_facility_name_address (qs, args=u'')

Order Header Destination Facility Address Fields - generates an address in the following format:

facility_name facility_address facility_address2 facility_city, facility_state facility_zip facility_country

Dynamic

None

determine_sku_single_or_multi

(qs, args=u'')

Determine Sku Single Or Multiple - looks at the iblpn to see if it is single sku in which case it

says single sku iblpn or if it is multi sku then it will say multisku iblpn.

Dynamic

None

facility_shipfrom_name_address

(qs, args=u'')

Facility ShipTo Fields - generates an address in the following format: facility_name facility_address facility_address2 facility_city, facility_state facility_zip facility_country Dynamic

None

facility_time (qs=None, args=u'd/%m/%Y - %H:%M')

Facility Time - the current time and date when the document or label is printedbased on the facility time zone location. Dynamic

Date Format String. http://strftime.org/ Default: "%d/%m/%Y - %H:%M"

get_container_num_for_item_single_sku_on_order (qs, args=u'')

Get Container Number For Item Single Sku On Order - This is only for labels or documents that are container based. This would not make sense for an order label for instance. Checks to make sure the status is Packed or Higher but not

cancelled.

Checks to make sure the Allocation is in Completed status. This function gets what container number out of the total

number of containers on an order with regards to an item.

Dynamic

None

get_country_code (code=u'US')

Get Country Code

Pass in any form of United States or Canada and get back the 2 letter country code.

Dynamic

code Default: 'US'

Only Use With

Expressions

get_country_name (code=u'US')

Get Country Name Pass in 2 letter code, 3 letter code, or dialing code of any country and get back the country Name. Dynamic

code Default: 'US'

Only Use With

Expressions

get_display_string (qs=None, args=u'')

Get Display String Gets the information on the object being processed. For instance if this was an oblpn label then this would get the information on the ob container. Dynamic None

get_ib_shipment_ids_from_vendor_code(vendor_code=u'')

Get In Bound Shipment IDs From Vendor Code Gets all of the in bound shipment ids for a vendor code. Dynamic

: vendor_code Default: ''

Only Use With

Expressions

get_julian_day(date_str, args=u'%Y-%m-%d')

Get Julian Day The Julian Day Server date when the document or label is printed. Dynamic Date Format String. http://strftime.org/ Default: "%d/%m/%Y - %H:%M

get_maxi_class_of_service(indicator)

Get Maxi Class Of Service - This is used for maxi class service lookup for UPS Maxi Code Generation. Dynamic

indicator Default: None

Only Use With

Expressions

get_maxicode(qs, args=u'')

Get Maxi Code - *********** This is still in Development ************** ------------------------------------------------------- UPS Maxi Code Generation. Dynamic None

get_num_containers_for_item_single_sku_on_order(qs, args=u'')

Get Container Number For Item Single Sku On Order - This is only for labels or documents that are container based. This would not make sense for an order label for instance. Checks to make sure the status is Packed or Higher but not

cancelled. Checks to make sure the Allocation is in Completed status. This function gets the total number of containers on an order with regards to an item.

Dynamic None

get_pre_pack_location(qs, args=u'')

Get Pre Pack Location Gets the location off of the allocation. Dynamic None

get_pre_pack_part_range(qs, args=u'')

Get Pre Pack Part Range - Based on the values in the PRE_PACK_VARIABLE_PARTS

company parameter, these are excluded from the parts seperated by a - that shows all of the child parts that make up this prepack.

Dynamic None

get_pre_pack_part_range_fields(qs, args=u'')

Get Pre Pack Part Range Fields - Based on the values in the PRE_PACK_VARIABLE_PARTS company parameter values refer to the fields which are excluded from the rest of the fields in the prepack. The remaining fields that make up a prepack is returned. Dynamic None

get_pre_pack_ratio_range(qs, args=u'')

Get Pre Pack Ratio Range - Based on the values in the PRE_PACK_VARIABLE_PARTS company parameter these are excluded from the parts seperated by a - that shows all of the child units relating to the parts that make up this prepack. Dynamic None

get_store_nbr(qs, args=u'')

Order Get Store Number Checks Destination Facility Code Then Checks Shipto Facility Code Then Checks external route Then Check Customer Number Dynamic None

get_total_cases_ob_containers(qs, args=u'')

Get Total Cases Out Bound Containers Get the total number of cases from the Out Bound Container. Dynamic None

get_total_num_containers(qs, args=u'')

Get Total Number Containers Looks at the allocation from inventory container pallet and for

all containers that are less than shipped status it counts them and returns the number of containers.

Dynamic None

get_total_num_containers_on_load(qs, args=u'')

Get Total Number Containers On Load - Checks to make sure the status is Out Bound Ready, In Packing, Packed, Loaded, or Shipped. This function gets the total number of containers on the load. Dynamic None

get_total_num_out_bound_ready_containers_on_order(qs, args=u'')

Get Total Number Out Bound Ready Containers On Order Checks to make sure the status is Out Bound Ready or Higher but not cancelled and not in Picked, or Picking. This function gets the total number of containers on the order. Dynamic None

get_total_num_packed_containers_on_order(qs, args=u'')

Get Total Number Packed Containers On Order Checks to make sure the status is Packed or Higher but not cancelled. This function gets the total number of containers on the order. Dynamic None

get_total_num_packed_items_on_order(qs, args=u'')

Get Total Number Packed Items On Order Checks to make sure the status is Packed or Higher but not cancelled. This function gets the total number of items on the order. Dynamic None

get_total_packs_ob_containers(qs, args=u'')

Get Total Packs Out Bound Containers Get the total number of packs from the Out Bound Container. Dynamic None

get_total_qty_for_lpn_with_prepacks(qs, args=u'')

Get Total Quantity For Lpn With Prepacks This function gets the total number of child units for a container Dynamic None

get_total_qty_ob_containers(qs, args=u'')

Get Total Quantity Out Bound Containers Get the total number of units from the Out Bound Container. Dynamic None

get_total_weight_packed_containers_on_order(qs, args=u'')

Get Total Weight Packed Containers On Order Checks to make sure the status is Packed or Higher but not

cancelled. This function gets the total Weight of the containers on the order.

Dynamic None

get_ups_routing_code(zip_code, country_code=u'US')

Get UPS Routing Code This is used for routing code and version for UPS Maxi Code Generation. Dynamic

zip_code, country_code Default: zip_code = None, country_code = 'US'

Only Use With

Expressions

get_us_state_code(code=u'')

Get State Code Pass in state name and get back the 2 letter state code. Dynamic

code Default:

Only Use With

Expressions

get_us_state_name(code=u'')

Get State Name Pass in 2 letter state code and get back the state name.

Dynamic

Arguments:

code Default:

Only Use With

Expressions

get_x_of_y_for_container_on_load(qs, args=u'')

Get X Of Y For Container On Load This is only for labels or documents that are container based. This would not make sense for an order label for instance. Checks to make sure the status is Out Bound Ready, In Packing, Packed, Loaded, or Shipped. This function gets what container number out of the total

number of containers on an order.

Dynamic None

get_x_of_y_in_out_bound_ready_containers_on_order(qs, args=u'')

Get X Of Y In Out Bound Ready Containers On Order This is only for labels or documents that are container based. This would not make sense for an order label for instance. Checks to make sure the status is Out Bound Ready or Higher but not cancelled and not in Picked, or Picking. This function gets what container number out of the total number of containers on an order. Dynamic None get_x_of_y_in_packed_containers_on_order(qs, args=u'')

Get X Of Y In Packed Containers On Order

This is only for labels or documents that are container based.

This would not make sense for an order label for instance.Checks to make sure the status is Packed or Higher but not cancelled.

This function gets what container number out of the total number of containers on an order.

Dynamic None is_carrier_fedex(qs=None, args=u'') Is Carrier FedEx Displays True if the carrier used was FedEx if not then it returns False. Dynamic None

is_carrier_ups(qs, args=u'')

Is Carrier UPS Displays True if the carrier used was UPS if not then it returns False. Dynamic None

is_shipvia_fedex_express(qs, args=u'')

Is ShipVia FedEx Express Displays True if the ship via service level used was FedEx express. If not then it returns False. Dynamic None

is_shipvia_fedex_ground(qs, args=u'')

Is ShipVia FedEx Ground Displays True if the ship via service level used was FedEx ground. If not then it returns False. Dynamic None

is_shipvia_fedex_smartpost(qs, args=u'')

Is ShipVia FedEx Smart Post Displays True if the ship via service level used was FedEx Smart Post. If not then it returns False. Dynamic None

order_header_cust_name_address(qs, args=u'')

Order Header Customer Address Fields

generates an address in the following format:

customer_name

customer_address

customer_address2

customer_city, customer_state

customer_zip customer_country

Dynamic None

order_header_shipto_name_address(qs, args=u'')

Order Header ShipTo Address Fields

generates an address in the following format:

shipto_name

shipto_address

shipto_address2

shipto_city, shipto_state

shipto_zip shipto_country

Dynamic None

shipto_facility_name_address(qs, args=u'')

Order Header ShipTo Facility Address Fields

generates an address in the following format:

shipto_facility_name

shipto_facility_address

shipto_facility_address2

shipto_facility_city, shipto_facility_state

shipto_facility_zip shipto_facility_country

Dynamic None

wave_time(qs=None, args=u'%d/%m/%Y')

Wave Time -The wave time and date when the document or label is printed based on the facility time zone location. Dynamic

Arguments:

Date Format String. http://strftime.org/

Default: "%d/%m/%Y - %H:%M"

get_lowest_location_by_location_pick_seq

Get Lowest Location By Location Pick Sequence -Returns the location string of the lowest location by location pick sequence. Dynamic None

get_lowest_pick_zone_by_location_pick_seq

Get Lowest Pick Zone By Location Pick Sequence- Returns the location string of the lowest pick zone by location

pick sequence

Dynamic None

get_total_ib_shipment_container_qty

Total Inbound Shipment or Inbound Containers - Returns the total of inbound containers quantity if a container is passed in. Returns the total of inbound shipment details quantity if an ib_shipment_id is passed in. Dynamic None

rename_oblpn_nbr_once

Rename OBLPN Number Once - This function renames the oblpn. Dynamic None